Merge pull request #6 from jkraenzle/main

Capacity Report Example

Author: saurabhjain06

examples/capacity_reports/README.rst

@@ -0,0 +1,43 @@
+Example Capacity Reports
+==============================
+
+**Capacity Reports** is an example Python script using the SteelScript libraries along with Python pandas and matplotlib libraries to pull utilization metrics for interfaces from NetIM, analyze them, and graph them.
+
+Quick start
+-----------
+
+.. code:: shell
+
+  # To execute the command
+  cd <SteelScript-NetIM installation path>/examples/capacity_reports
+  pip3 install -r requirements.txt
+  python3 report.py --sites_yml sites.yml --config_yml config.yml
+
+- sites_example.yml is an example of what needs to be included for each site and interface
+- config_example.yml is where the NetIM authentication information is provided, along with reporting period and other parameters
+- The output/ directory shows an example output from a lab environment
+
+Contribute
+-----------
+
+Feel free to use, enhance and contribute by creating issues, sendind pull requests (PR), ...
+
+Links
+-----
+
+- `SteelScript main code repository on GitHub <https://github.com/riverbed/steelscript>`__ 
+
+- `SteelScript complete guide <https://support.riverbed.com/apis/steelscript>`__
+
+License
+=======
+
+Copyright (c) 2021 Riverbed Technology, Inc.
+
+SteelScript is licensed under the terms and conditions of the MIT License
+accompanying the software ("License").  SteelScript is distributed "AS
+IS" as set forth in the License. SteelScript also includes certain third
+party code.  All such third party code is also distributed "AS IS" and is
+licensed by the respective copyright holders under the applicable terms and
+conditions (including, without limitation, warranty and liability disclaimers)
+identified in the license notices accompanying the software.

examples/capacity_reports/config_example.yml

@@ -0,0 +1,14 @@
+# Specify the authentication information for the NetIM source instance
+netim_hostname: 10.1.1.1
+netim_username: admin
+netim_password: admin
+
+# Provide reporting period, with time in format M-D-Y H:M:S
+start_time: 01-01-2021 00:00:00
+end_time: 12-31-2021 11:59:59
+
+# Provide granularity as one of RAW, HOURLY, DAILY, WEEKLY
+granularity: WEEKLY
+
+# Provide rollup as one of 'maximum', 'average', '95th percentile', '98th percentile'
+rollup: 95th percentile