Initial Commit

Author: mahaganesan11

CONTRIBUTING.md

@@ -1,18 +1,18 @@
-# Contributing to NetApp's REST Examples
-
-Adding new example scripts, improving documentation, fixing bugs, or writing tutorials are all examples of
-helpful contributions.
-
-Bug fixes and script additions can be initiated through GitHub pull requests. You can read about how to create a
-pull request [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
-When making code contributions to the repository, we ask that you follow the [PEP 8](https://www.python.org/dev/peps/pep-0008)
-coding standard.
-
-This repository requires that you certify yourself under the terms of the [Developer Certificate of Origin](https://developercertificate.org/).
-Be sure to sign off your commits using the `-s` flag or adding `Signed-off-By: Name<Email>` in the commit message.
-
-### Example
-```bash
-git commit -s -m 'Informative commit message'
-```
-For more information on how you could contribute, refer the [ONTAP REST API Contribution](https://github.com/NetApp/ontap-rest-python/wiki/contributing_to_ontaprestapi) documentation. 
+# Contributing to NetApp's REST Examples
+
+Adding new example scripts, improving documentation, fixing bugs, or writing tutorials are all examples of
+helpful contributions.
+
+Bug fixes and script additions can be initiated through GitHub pull requests. You can read about how to create a
+pull request [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)
+When making code contributions to the repository, we ask that you follow the [PEP 8](https://www.python.org/dev/peps/pep-0008)
+coding standard.
+
+This repository requires that you certify yourself under the terms of the [Developer Certificate of Origin](https://developercertificate.org/).
+Be sure to sign off your commits using the `-s` flag or adding `Signed-off-By: Name<Email>` in the commit message.
+
+### Example
+```bash
+git commit -s -m 'Informative commit message'
+```
+For more information on how you could contribute, refer the [ONTAP REST API Contribution](https://github.com/NetApp/ontap-rest-python/wiki/contributing_to_ontaprestapi) documentation. 

LICENSE

@@ -1,29 +1,29 @@
-BSD 3-Clause License
-
-Copyright (c) 2020, NetApp
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+BSD 3-Clause License
+
+Copyright (c) 2020, NetApp
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

ONTAPI-Usage-Reporting-Tool/.DS_Store

@@ -1,114 +1,108 @@
-ONTAPI Usage Reporting Tool
----------------------
-
- * Introduction
- * Requirements
- * Usage
- * Support
-
-INTRODUCTION
-------------
-In order to help our professional services, Customers and Partners to help them identify the ONTAPI(ZAPI) usage in their cluster environment, ONTAPI Usage Reporting tool has been developed covering 3 different usecases. These scripts are python-based.
-
-The scripts provided in this wheel file are,
-
-Script        |  Description
-------------- | -------------
-**apache_scraper.py**  | Apache log scraper to find ONTAPIs (ZAPIs) called against ONTAP nodes
-**session_stats.py**   | Command line script to pull session statistics data from ONTAP
-**zapi_to_rest.py**    | Script to find REST details of ZAPI and attributes passed
-
-
-REQUIREMENTS
--------------
-
-Python3.7 or higher is required to run the scripts. If there are compatibility issues with the the included packages, All versions offered can be found below:
-
-* numpy - https://pypi.org/project/numpy/#files
- 
-* pandas - https://pypi.org/project/pandas/#files
-
-* python-dateutil - https://pypi.org/project/python-dateutil/#files
-
-* pytz - https://pypi.org/project/pytz/#files
-
-* requests - https://pypi.org/project/requests/#files
-
-* six - https://pypi.org/project/six/#files
-
-INSTALLATION 
-------------
-Download the wheel file and input the command to install the wheel file: **pip install netapp_ztools-1.0.0-py3-none-any**
-- The above command installs all the required dependencies.
-- Visit the python_folder\Lib\site-packages\netapp_ztools\ to see the installed scripts,
-
-  ![image](https://user-images.githubusercontent.com/61284863/153841819-c974006b-e52a-4287-950a-00b6b7278d4c.png)
-
-
-USAGE
------
-
-####  Script_1: python apache_scraper.py -h ####
-
-- **Description:** Apache log scraper to find ONTAPIs (ZAPIs) called against ONTAP nodes
-
-- **usage:** - apache_scraper.py [-h] [-unique] [-start START] [-end END] [-date DATE] [-node NODE] [-write-csv] [-verbose] log
-
-- positional arguments:
-  - log      Absolute path of apache_access.log file copied from an ONTAP node
-
-- optional arguments:
-  - -h,      help show this help message and exit
-  - -unique      Filter unique ZAPIs only
-  - -start START      Start time to inspect logs, formatted as H:M:S
-  - -end END      End time to inspect logs, formatted as H:M:S
-  - -date DATE      Date of filtered results if a multiday run
-  - -node NODE      Node to search
-  - -write-csv, -w      Writes to a csv file
-  - -verbose, -v 
-![image](https://user-images.githubusercontent.com/61284863/153816578-0842a8b0-97d9-4a1c-90f3-358ecc5f589c.png)
-
-
-#### Script_2: python session_stats.py -h ####
-
-- **Description:** Command line script to pull session statistics data from ONTAP
-
-- **usage:** session_stats.py [-h] [-username USERNAME] [-password PASSWORD] [-scope SCOPE] [-sort-by SORT_BY] [--verbose] [-write-csv] hosts
-
-- positional arguments:
-  hosts      Comma separated list of IP addresses or FQDN of ONTAP node(s)
-
-- optional arguments:
-  - -h, --help      show this help message and exit
-  - -username      USERNAME
-  - -password      PASSWORD
-  - -scope      SCOPE{cluster|node}
-  - -sort-by      SORT_BY {application|location|request|user|vserver}
-  - --verbose, -v
-  - -write-csv, -w
-
-The CLI equivalent of the session_stats.py commands is: **security session request-statistics show-by-{application|location|request|user|vserver}**
-![image](https://user-images.githubusercontent.com/61284863/153852694-9ba389a9-6d1a-4849-8d2e-4dd6c90a4060.png)
-
-
-#### Script_3: python zapi_to_rest.py -h ####
-
-- **Description:** Tools to find REST details of ZAPI and attributes passed
-
-- **usage:** zapi_to_rest.py [-h] [-attrs ATTRS] zapi
-
-- positional arguments:
-   - zapi      ZAPI
-
-- optional arguments:
-  - -h, --help      show this help message and exit
-  - -attrs ATTRS, -a ATTRS      comma separated list of attributes to map REST field equivalents
-  - --version VERSION      Specify target ONTAP version { 9_10_1 | 9_9_1 | 9_8 }
-
-    ![image](https://user-images.githubusercontent.com/61284863/153816352-4b1fc5c0-ffe0-4356-9823-9ed3c6b51099.png)
-
-
-SUPPORT
------------
-
-For questions and for addressing bugs, please reach out to ng-ontap-restapi-queries@netapp.com
+ONTAPI Usage Reporting Tool
+---------------------
+
+ * Introduction
+ * Requirements
+ * Usage
+ * Support
+
+INTRODUCTION
+------------
+In order to help our professional services, Customers and Partners to help them identify the ONTAPI usage in their cluster environment, ONTAPI Usage Reporting tool has been developed covering 3 different usecases. 
+These scripts are python-based.
+
+The scripts provided in this wheel file:
+
+Script        |  Description
+------------- | -------------
+**apache_scraper.py**  | Apache log scraper to find ONTAPIs (ZAPIs) called against ONTAP nodes
+**session_stats.py**   | Command line script to pull session statistics data from ONTAP
+**zapi_to_rest.py**    | Script to find REST details of ZAPI and attributes passed
+
+
+REQUIREMENTS
+-------------
+
+Python3.7 or higher is required to run the scripts. If there are compatibility issues with the the included packages, All versions offered can be found below:
+
+* numpy - https://pypi.org/project/numpy/#files
+ 
+* pandas - https://pypi.org/project/pandas/#files
+
+* python-dateutil - https://pypi.org/project/python-dateutil/#files
+
+* pytz - https://pypi.org/project/pytz/#files
+
+* requests - https://pypi.org/project/requests/#files
+
+* six - https://pypi.org/project/six/#files
+
+Command to install the wheel file: **pip install netapp_ztools-1.0.0-py3-none-any**
+
+USAGE
+-----
+
+####  Script_1: python apache_scraper.py -h ####
+
+- **Description:** Apache log scraper to find ONTAPIs (ZAPIs) called against ONTAP nodes
+
+- **usage:** - apache_scraper.py [-h] [-unique] [-start START] [-end END] [-date DATE] [-node NODE] [-write-csv] [-verbose] log
+
+- positional arguments:
+  - log      Absolute path of apache_access.log file copied from an ONTAP node
+
+- optional arguments:
+  - -h,      help show this help message and exit
+  - -unique      Filter unique ZAPIs only
+  - -start START      Start time to inspect logs, formatted as H:M:S
+  - -end END      End time to inspect logs, formatted as H:M:S
+  - -date DATE      Date of filtered results if a multiday run
+  - -node NODE      Node to search
+  - -write-csv, -w      Writes to a csv file
+  - -verbose, -v 
+![image](https://user-images.githubusercontent.com/61284863/153816578-0842a8b0-97d9-4a1c-90f3-358ecc5f589c.png)
+
+
+#### Script_2: python session_stats.py -h ####
+
+- **Description:** Command line script to pull session statistics data from ONTAP
+
+- **usage:** session_stats.py [-h] [-username USERNAME] [-password PASSWORD] [-scope SCOPE] [-sort-by SORT_BY] [--verbose] [-write-csv] hosts
+
+- positional arguments:
+  hosts      Comma separated list of IP addresses or FQDN of ONTAP node(s)
+
+- optional arguments:
+  - -h, --help      show this help message and exit
+  - -username      USERNAME
+  - -password      PASSWORD
+  - -scope      SCOPE{cluster|node}
+  - -sort-by      SORT_BY {application|location|request|user|vserver}
+  - --verbose, -v
+  - -write-csv, -w
+
+The CLI equivalent of the session_stats.py commands is: **security session request-statistics show-by-{application|location|request|user|vserver}**
+
+![image](https://user-images.githubusercontent.com/61284863/153811433-5b087671-eaf2-48dc-9a53-1f8007223f8f.png)
+
+#### Script_3: python zapi_to_rest.py -h ####
+--------------------------------
+- **Description:** Tools to find REST details of ZAPI and attributes passed
+
+- **usage:** zapi_to_rest.py [-h] [-attrs ATTRS] zapi
+
+- positional arguments:
+   - zapi      ZAPI
+
+- optional arguments:
+  - -h, --help      show this help message and exit
+  - -attrs ATTRS, -a ATTRS      comma separated list of attributes to map REST field equivalents
+  - --version VERSION      Specify target ONTAP version { 9_10_1 | 9_9_1 | 9_8 }
+
+![image](https://user-images.githubusercontent.com/61284863/153816352-4b1fc5c0-ffe0-4356-9823-9ed3c6b51099.png)
+
+
+SUPPORT
+-----------
+
+These scripts were developed by the CSI team at NetApp. For questions and for addressing bugs, please reach out to ng-ontap-rest-queries@netapp.com