: The API, configReboot(), reboots the system by accepting dictionary request body input to indicate authorization.
+Clear Flow Counters
+In order to clear opb flow counters, the API, clearFlowCounters(), can be invoked with no paramters.
```py
-node.configReboot(dt={"reboot":"yes"})
+node.clearFlowCounters(flow="flow1", r_id="1")
```
-Output
-
Note: Client will receive the below status codes for both deleting funtions to indicate a successful request.
+
The below table lists and describes input attributes:
+
+
+
+
+ | Attribute |
+ Values |
+ Description |
+
+
+
+
+ | "flow" |
+ "flow1" |
+ flow identification |
+
+
+ | "r_id" |
+ int |
+ rule id number |
+
+
+
+
+Note: Output of clear APIs
+ APIs will not produce any output unless the below status code in produced, indicating a server error.
```py
-Status : 200 -> Response : b'200'
+Status : 500 -> Response : b'500'
```
-
The status code '500' indicates a server error.
diff --git a/docs/cpuUtil.md b/docs/cpuUtil.md
new file mode 100644
index 0000000..aa01490
--- /dev/null
+++ b/docs/cpuUtil.md
@@ -0,0 +1,51 @@
+# CPU Utilization
+
+Import OPBNOS API
+
+```py
+import opb_api as opbapi
+```
+
+Initialize client
+
Use the appropriate JSON file that corresponds to the targetted device name. This JSON file should contain request body parameters corresponding to any potential configuration/post requests.
+
+```py
+node = opbapi.connect_to('SN2010')
+```
+
+Get/Show CPU Utilization
+
Retrieves system CPU utilization
+
+```py
+node.execute(['show cpu util'])
+```
+Output
+
This is an example of the output of the above command:
+```py
+b'{"%CPU_Util": "14.249999999999998"}'
+```
+
+
The below table lists and describes input and output attributes:
+
+
+
+
+ | Attribute |
+ Values |
+ Description |
+
+
+
+
+ | "CPU_Util" |
+ float |
+ indicates average CPU usage |
+
+
+
+
+Note: Output of the API
+ API will not produce any output unless the below status code in produced, indicating a server error.
+```py
+Status : 500 -> Response : b'500'
+```
diff --git a/docs/memUtil.md b/docs/memUtil.md
new file mode 100644
index 0000000..202c3f2
--- /dev/null
+++ b/docs/memUtil.md
@@ -0,0 +1,51 @@
+# Memory Utilization
+
+Import OPBNOS API
+
+```py
+import opb_api as opbapi
+```
+
+Initialize client
+
Use the appropriate JSON file that corresponds to the targetted device name. This JSON file should contain request body parameters corresponding to any potential configuration/post requests.
+
+```py
+node = opbapi.connect_to('SN2010')
+```
+
+Get/Show Memory Utilization
+
Retrieves system memory utilization
+
+```py
+node.execute(['show memory utilisation'])
+```
+Output
+
This is an example of the output of the above command:
+```py
+b'{"%MEM_Util": "13.5"}'
+```
+
+
The below table lists and describes input and output attributes:
+
+
+
+
+ | Attribute |
+ Values |
+ Description |
+
+
+
+
+ | "MEM_Util" |
+ float |
+ indicates memory usage |
+
+
+
+
+Note: Output of the API
+ API will not produce any output unless the below status code in produced, indicating a server error.
+```py
+Status : 500 -> Response : b'500'
+```
diff --git a/docs/reboot.md b/docs/reboot.md
new file mode 100644
index 0000000..1d083d0
--- /dev/null
+++ b/docs/reboot.md
@@ -0,0 +1,28 @@
+# Reboot
+
Initiates Device Reboot
+Import OPBNOS API
+
+```py
+import opb_api as opbapi
+```
+
+Initialize client
+
Use the appropriate JSON file that corresponds to the targetted device name. This JSON file should contain request body parameters corresponding to any potential configuration/post requests.
+
+```py
+node = opbapi.connect_to('SN2010')
+```
+
+Device Reboot
+
+ : The API, configReboot(), reboots the system by accepting dictionary request body input to indicate authorization.
+
+```py
+node.configReboot(dt={"reboot":"yes"})
+```
+Output
+ Note: Client will receive the below status codes for both deleting funtions to indicate a successful request.
+```py
+Status : 200 -> Response : b'200'
+```
+
The status code '500' indicates a server error.
diff --git a/docs/tacacs.md b/docs/tacacs.md
new file mode 100644
index 0000000..970bf2a
--- /dev/null
+++ b/docs/tacacs.md
@@ -0,0 +1,98 @@
+# TACACS
+
+**Import OPBNOS API**
+
+```py
+import opb_api as opbapi
+```
+
+**Initialize client**
+
Use the appropriate JSON file that corresponds to the targetted device name. This JSON file should contain request body parameters corresponding to any potential configuration/post requests.
+
+```py
+node = opbapi.connect_to('SN2010')
+```
+
+Configure TACACS Server
+
In order to configure TACACS server information, the API, configTACACS(), must be invoked with input parameter, 'dt'. 'dt' accepts all request body inputs in a dictionary format.
+```py
+node.configTACACS(dt = {"host": "10.4.4.11","timeout": 8,"priority": 1,"auth_type": "pap","passkey": "support"})
+```
+
The below table has a list of attributes that pertain to this particular API:
+
+
+
+
+ | Attribute |
+ Values |
+ Description |
+
+
+
+
+ | "host" |
+ "10.X.X.XX" |
+ host id |
+
+
+ | "timeout" |
+ int |
+ indicates timeout value |
+
+
+ | "priority" |
+ int |
+ indicates priority |
+
+
+ | "auth_type" |
+ "pap" |
+ indicates authorization type (password authorization protocol) |
+
+
+ | "passkey" |
+ "support" |
+ server user credential string |
+
+
+
+
+Configure TACACS Global Server
+In order to configure port information, the API, configTACACSglobal(), must be invoked with input parameter, 'dt'. 'dt' accepts all request body inputs in a dictionary format.
+```py
+node.configTACACS(dt = {"auth_type": "pap","timeout": 8,"passkey": "support"})
+```
+
The below table has a list of attributes that pertain to this particular API:
+
+
+
+
+ | Attribute |
+ Values |
+ Description |
+
+
+
+
+ | "auth_type" |
+ "pap" |
+ indicates authorization type (password authorization protocol) |
+
+
+ | "timeout" |
+ int |
+ indicates timeout value |
+
+
+ | "passkey" |
+ "support" |
+ server user credential string |
+
+
+
+
+Note: Output of APIs
+ APIs will not produce any output unless the below status code in produced, indicating a server error.
+```py
+Status : 500 -> Response : b'500'
+```
diff --git a/docs/timezone.md b/docs/timezone.md
new file mode 100644
index 0000000..2134e8d
--- /dev/null
+++ b/docs/timezone.md
@@ -0,0 +1,39 @@
+# Timezone
+
+Import OPBNOS API
+
+```py
+import opb_api as opbapi
+```
+
+Initialize client
+
Use the appropriate JSON file that corresponds to the targetted device name. This JSON file should contain request body parameters corresponding to any potential configuration/post requests.
+
+```py
+node = opbapi.connect_to('SN2010')
+```
+
+Configure Timezone
+
In order to configure SNMP community information, the API, configSNMPcomm(), must be invoked with appropriate parameters in dictionary format within the parameter 'dt'.
+```py
+node.configTimezone(dt = {"timezone": "Asia/Kolkata"})
+```
+
+
The below table lists and describes input attributes:
+
+
+
+
+ | Attribute |
+ Values |
+ Description |
+
+
+
+
+ | "timezone" |
+ "Asia/Kolkata" |
+ indicates preferred timezone |
+
+
+
diff --git a/docs/uptime.md b/docs/uptime.md
new file mode 100644
index 0000000..c764ff9
--- /dev/null
+++ b/docs/uptime.md
@@ -0,0 +1,45 @@
+# System Uptime
+
+Import OPBNOS API
+
+```py
+import opb_api as opbapi
+```
+
+Initialize client
+Use the appropriate JSON file that corresponds to the targetted device name. This JSON file should contain request body parameters corresponding to any potential configuration/post requests.
+
+```py
+node = opbapi.connect_to('SN2010')
+```
+
+Get/Show System Uptime
+
Retrieves system uptime
+
+```py
+node.execute(['show uptime'])
+```
+Output
+
This is an example of the output of the above command:
+```py
+b'{"uptime": "01:05:51 up 26 days, 20:09, 2 users, load average: 0.54, 0.50, 0.51"}'
+```
+
+
The below table lists and describes input and output attributes:
+
+
+
+
+ | Attribute |
+ Values |
+ Description |
+
+
+
+
+ | "uptime" |
+ "01:05:51 up 26 days, 20:09, 2 users, load average: 0.54, 0.50, 0.51" |
+ indicates system uptime information |
+
+
+
diff --git a/mkdocs.yml b/mkdocs.yml
index c907b1e..1fd3ec2 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -31,3 +31,13 @@ nav:
- NTP: NTP.md
- ZTP: ZTP.md
- SNMP: snmp.md
+ - Time:
+ - Timezone: timezone.md
+ - Uptime: uptime.md
+ - Clock: clock.md
+ - Utilization:
+ - CPU Util: cpuUtil.md
+ - Memory Util: memUtil.md
+ - System:
+ - Boot Info: boot.md
+ - reboot: reboot.md