Merge pull request #1 from ShruthyMohanram/master

Adding ACL Hit Counters Monitor scripts for 8320/8400
aruba · Nov 27, 2017 · 0aeb501 · 0aeb501
2 parents 9f2cd67 + 4557102
commit 0aeb501
Show file tree

Hide file tree

Showing 4 changed files with 276 additions and 0 deletions.
diff --git a/examples/ACL/8320/acl_hit_counters_monitor.1.0.md b/examples/ACL/8320/acl_hit_counters_monitor.1.0.md
@@ -0,0 +1,90 @@
+#### Script File Name: acl\_hit\_counters\_monitor.py
+
+Script Functionality Guide for Monitoring ACL Hit Counters
+
+==============================================================================
+
+### Contents
+
+------------------------------------------------------------------------------
+- [Overview](#Overview)
+- [Prerequisites](#Prerequisites)
+- [Use Case(s)](#Use_Case)
+- [Functional Description](#Functional_Description)
+- [Platform(s) Tested](#Platform_Tested)
+- [Error-Handling](#Error-Handling)
+
+
+<a id='Overview'></a>
+#### Overview:
+
+------------------------------------------------------------------------------
+This ACL Hit Counters monitoring script is intended to monitor the hit 
+counters for a configured ACL rule with a given ACE Id.
+
+<a id='Prerequisites'></a>
+#### Prerequisites:
+-----------------------------------------------------------------------------
+- Working knowledge of Python language to understand the script and have 
+access to any editor for writing/modifying python scripts.
+
+- Set up the scripts execution environment using the switch management access 
+of the 8320x switches.
+
+- Knowledge of how to upload the script using either the switch Web User 
+Interface/REST API's.
+
+- Knowledge of how to create an agent using either switch Web User 
+Interface/REST API's.
+
+<a id='Use_Case'/></a>
+#### Use Case(s):
+
+----------------------------------------------------------------------------
+Listed below are the high level use cases for ACL hit counters monitoring on 
+8320X switch:
+
+"As an Administrator, I would like to monitor the Hit Counters for a 
+configured ACL rule having the specified ACE Id. The monitored counters 
+will be represented in a time-series chart for analysis purpose."
+
+<a id='Functional_Description'/></a>
+#### Functional Description:
+
+-----------------------------------------------------------------------------
+The main sections of the ACL hit counters script are 'Manifest',
+'ParameterDefinitions' and the 'Policy Constructor'.
+
+The ’Manifest’ section defines the unique name for this script with short 
+description about script purpose. 'ParameterDefinitions' section defines 
+script parameters in this case - port number and the ACE number/Id. Port 
+number is any valid string value as configured in the 8320x switch. ACE
+number/Id is any valid Integer number that the administrator provides
+as a unique sequence number when applying the ACL rules on the port
+or interface.
+
+The 'Policy Constructor' handles the main logic for monitoring the ACL
+Hit counters values. A single monitor condition has been defined to
+monitor the ACL hit counters on the 8320x switch. There are no actions
+or call backs alerts associated with this monitor condition. 
+The monitored values are directly plotted on the time series charts 
+available in the the WEB-UI for analysis purpose.  
+
+Note: Dynamic parameter changes I.e. after agent creation, are not supported
+for this script.
+
+<a id='Platform_Tested'/></a>
+#### Platform(s) Tested:
+
+------------------------------------------------------------------------------
+This script has been tested on 8320X switch.
+
+<a id='Error-Handling'/></a>
+#### Error Handling:
+
+------------------------------------------------------------------------------
+
+- Ensure to provide the right port number of the 8320x switch on which the ACL 
+  rule was applied.
+- Ensure to provided the valid ACE Id (Integer number) which the administrator 
+  provided while configuring the ACL rules on the 8320x switch.
diff --git a/examples/ACL/8320/acl_hit_counters_monitor.1.0.py b/examples/ACL/8320/acl_hit_counters_monitor.1.0.py
@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+Manifest = {
+    'Name': 'acl_hit_counters_monitor',
+    'Description': 'Network Analytics Agent Script to monitor'
+                   'ACL hit counters for a given ACE number',
+    'Version': '1.0',
+    'Author': 'Aruba Networks'
+}
+
+ParameterDefinitions = {
+    'port_number': {
+        'Name': 'Port Number',
+        'Description': 'Port Number where the ACL rule is applied',
+        'Type': 'string',
+        'Default': '1/1/1'
+    },
+    'ace_number': {
+        'Name': 'ACE sequence number',
+        'Description': 'Access Control Entry sequence number',
+        'Type': 'integer',
+        'Default': 1
+    }
+}
+
+
+class Policy(NAE):
+
+    def __init__(self):
+        uri1 = '/rest/v1/system/ports/{}?attributes=aclv4_in_statistics.{}'
+        self.m1 = Monitor(uri1, 'ACL hit counters',
+                          [self.params['port_number']],
+                          [self.params['ace_number']])
diff --git a/examples/ACL/8400/acl_hit_counters_monitor.1.0.md b/examples/ACL/8400/acl_hit_counters_monitor.1.0.md
@@ -0,0 +1,90 @@
+#### Script File Name: acl\_hit\_counters\_monitor.py
+
+Script Functionality Guide for Monitoring ACL Hit Counters
+
+==============================================================================
+
+### Contents
+
+------------------------------------------------------------------------------
+- [Overview](#Overview)
+- [Prerequisites](#Prerequisites)
+- [Use Case(s)](#Use_Case)
+- [Functional Description](#Functional_Description)
+- [Platform(s) Tested](#Platform_Tested)
+- [Error-Handling](#Error-Handling)
+
+
+<a id='Overview'></a>
+#### Overview:
+
+------------------------------------------------------------------------------
+This ACL Hit Counters monitoring script is intended to monitor the hit 
+counters for a configured ACL rule with a given ACE Id.
+
+<a id='Prerequisites'></a>
+#### Prerequisites:
+-----------------------------------------------------------------------------
+- Working knowledge of Python language to understand the script and have 
+access to any editor for writing/modifying python scripts.
+
+- Set up the scripts execution environment using the switch management access 
+of the 8400x switches.
+
+- Knowledge of how to upload the script using either the switch Web User 
+Interface/REST API's.
+
+- Knowledge of how to create an agent using either switch Web User 
+Interface/REST API's.
+
+<a id='Use_Case'/></a>
+#### Use Case(s):
+
+----------------------------------------------------------------------------
+Listed below are the high level use cases for ACL hit counters monitoring on 
+8400X switch:
+
+"As an Administrator, I would like to monitor the Hit Counters for a 
+configured ACL rule having the specified ACE Id. The monitored counters 
+will be represented in a time-series chart for analysis purpose."
+
+<a id='Functional_Description'/></a>
+#### Functional Description:
+
+-----------------------------------------------------------------------------
+The main sections of the ACL hit counters script are 'Manifest',
+'ParameterDefinitions' and the 'Policy Constructor'.
+
+The ’Manifest’ section defines the unique name for this script with short 
+description about script purpose. 'ParameterDefinitions' section defines 
+script parameters in this case - port number and the ACE number/Id. Port 
+number is any valid string value as configured in the 8400x switch. ACE
+number/Id is any valid Integer number that the administrator provides
+as a unique sequence number when applying the ACL rules on the port
+or interface.
+
+The 'Policy Constructor' handles the main logic for monitoring the ACL
+Hit counters values. A single monitor condition has been defined to
+monitor the ACL hit counters on the 8400x switch. There are no actions
+or call backs alerts associated with this monitor condition. 
+The monitored values are directly plotted on the time series charts 
+available in the the WEB-UI for analysis purpose.  
+
+Note: Dynamic parameter changes I.e. after agent creation, are not supported
+for this script.
+
+<a id='Platform_Tested'/></a>
+#### Platform(s) Tested:
+
+------------------------------------------------------------------------------
+This script has been tested on 8400X switch.
+
+<a id='Error-Handling'/></a>
+#### Error Handling:
+
+------------------------------------------------------------------------------
+
+- Ensure to provide the right port number of the 8400x switch on which the ACL 
+  rule was applied.
+- Ensure to provided the valid ACE Id (Integer number) which the administrator 
+  provided while configuring the ACL rules on the 8400x switch.
diff --git a/examples/ACL/8400/acl_hit_counters_monitor.1.0.py b/examples/ACL/8400/acl_hit_counters_monitor.1.0.py
@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2017 Hewlett Packard Enterprise Development LP
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+Manifest = {
+    'Name': 'acl_hit_counters_monitor',
+    'Description': 'Network Analytics Agent Script to monitor'
+                   'ACL hit counters for a given ACE number',
+    'Version': '1.0',
+    'Author': 'Aruba Networks'
+}
+
+ParameterDefinitions = {
+    'port_number': {
+        'Name': 'Port Number',
+        'Description': 'Port Number where the ACL rule is applied',
+        'Type': 'string',
+        'Default': '1/1/1'
+    },
+    'ace_number': {
+        'Name': 'ACE sequence number',
+        'Description': 'Access Control Entry sequence number',
+        'Type': 'integer',
+        'Default': 1
+    }
+}
+
+
+class Policy(NAE):
+
+    def __init__(self):
+        uri1 = '/rest/v1/system/ports/{}?attributes=aclv4_in_statistics.{}'
+        self.m1 = Monitor(uri1, 'ACL hit counters',
+                          [self.params['port_number']],
+                          [self.params['ace_number']])