Merge pull request #219 from mirceaulinic/CF-SNMP

dbarrosop · dbarrosop · commit b265e750fb2c · 2016-03-04T12:58:10.000+01:00
Add get_snmp_information() to JunOS, IOS-XR, NXOS &amp; EOS
diff --git a/.travis.yml b/.travis.yml
@@ -24,6 +24,7 @@ script:
   - nosetests -v TestJunOSDriver:TestGetterJunOSDriver.test_get_interfaces_ip
   - nosetests -v TestJunOSDriver:TestGetterJunOSDriver.test_get_mac_address_table
   - nosetests -v TestJunOSDriver:TestGetterJunOSDriver.test_get_route_to
+  - nosetests -v TestJunOSDriver:TestGetterJunOSDriver.test_get_snmp_information
   # testing eos getters
   - nosetests -v TestEOSDriver:TestGetterEOSDriver.test_get_bgp_config
   - nosetests -v TestEOSDriver:TestGetterEOSDriver.test_get_bgp_neighbors
@@ -40,6 +41,7 @@ script:
   - nosetests -v TestEOSDriver:TestGetterEOSDriver.test_get_interfaces_ip
   - nosetests -v TestEOSDriver:TestGetterEOSDriver.test_get_mac_address_table
   - nosetests -v TestEOSDriver:TestGetterEOSDriver.test_get_route_to
+  - nosetests -v TestEOSDriver:TestGetterEOSDriver.test_get_snmp_information
   # testing iosxr getters
   - nosetests -v TestIOSXRDriver:TestGetterIOSXRDriver.test_get_bgp_config
   - nosetests -v TestIOSXRDriver:TestGetterIOSXRDriver.test_get_bgp_neighbors
@@ -55,6 +57,7 @@ script:
   - nosetests -v TestIOSXRDriver:TestGetterIOSXRDriver.test_get_interfaces_ip
   - nosetests -v TestIOSXRDriver:TestGetterIOSXRDriver.test_get_mac_address_table
   - nosetests -v TestIOSXRDriver:TestGetterIOSXRDriver.test_get_route_to
+  - nosetests -v TestIOSXRDriver:TestGetterIOSXRDriver.test_get_snmp_information
 # testing nxos getters
   - nosetests -v TestNXOSDriver:TestGetterNXOSDriver.test_get_facts
   - nosetests -v TestNXOSDriver:TestGetterNXOSDriver.test_get_interfaces
@@ -64,13 +67,15 @@ script:
   - nosetests -v TestNXOSDriver:TestGetterNXOSDriver.test_get_ntp_peers
   - nosetests -v TestNXOSDriver:TestGetterNXOSDriver.test_get_interfaces_ip
   - nosetests -v TestNXOSDriver:TestGetterNXOSDriver.test_get_mac_address_table
+  - nosetests -v TestNXOSDriver:TestGetterNXOSDriver.test_get_snmp_information
 # testing pluribus getters
   - nosetests -v TestPluribusDriver:TestGetterPluribusDriver.test_get_facts
   - nosetests -v TestPluribusDriver:TestGetterPluribusDriver.test_get_interfaces
   - nosetests -v TestPluribusDriver:TestGetterPluribusDriver.test_get_lldp_neighbors
   - nosetests -v TestPluribusDriver:TestGetterPluribusDriver.test_get_lldp_neighbors_detail
   - nosetests -v TestPluribusDriver:TestGetterPluribusDriver.test_get_ntp_peers
   - nosetests -v TestPluribusDriver:TestGetterPluribusDriver.test_get_mac_address_table
+  - nosetests -v TestPluribusDriver:TestGetterPluribusDriver.test_get_snmp_information
 # testing ios getters
   - nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_bgp_neighbors
   - nosetests -v TestIOSDriver:TestGetterIOSDriver.test_get_environment
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,3 +1,4 @@
 include requirements.txt
 include napalm/utils/*.yml
 include napalm/templates/*/*.j2
+include napalm/utils/textfsm_templates/*/*.tpl
diff --git a/docs/support/index.rst b/docs/support/index.rst
@@ -71,7 +71,7 @@ _                               EOS   JunOS   IOS-XR  FortiOS  IBM     NXOS    I
 **get_environment**            |yes|  |yes|   |yes|   |yes|    |no|    |no|    |yes|  |no|
 **get_mac_address_table**      |yes|  |yes|   |yes|   |no|     |no|    |yes|   |yes|  |yes|
 **get_arp_table**              |yes|  |yes|   |yes|   |no|     |no|    |yes|   |yes|  |no|
-**get_snmp_information**       |no|   |no|    |no|    |no|     |no|    |no|    |yes|  |yes|
+**get_snmp_information**       |yes|  |yes|   |yes|   |no|     |no|    |yes|   |yes|  |yes|
 **get_ntp_peers**              |yes|  |yes|   |yes|   |no|     |no|    |yes|   |yes|  |yes|
 **get_interfaces_ip**          |yes|  |yes|   |yes|   |no|     |no|    |yes|   |yes|  |no|
 ============================== =====  =====   ======  =======  ======  ======  =====  =========
diff --git a/napalm/base.py b/napalm/base.py
@@ -16,6 +16,8 @@
 import sys
 import jinja2
 
+import textfsm
+
 import napalm.exceptions
 
 
@@ -178,6 +180,54 @@ def load_template(self, template_name, template_vars):
 
         self.load_merge_candidate(config=configuration)
 
+    def _textfsm_extractor(self, template_name, raw_text):
+
+        """
+        Will apply a TextFSM template over a raw text and return the matching table.
+        Main usage of this method will be to extract data form a non-structured output
+        from a network device and return the values in a table format.
+
+        :param template_name: Specifies the name of the template to be used
+        :param raw_text: Text output as the devices prompts on the CLI
+        """
+
+        textfsm_data = list()
+
+        driver_name = self.__class__.__name__.replace('Driver', '')
+        current_dir = os.path.dirname(os.path.abspath(__file__))
+        template_path = '{current_dir}/utils/textfsm_templates/{driver_name}/{template_name}.tpl'.format(
+            current_dir=current_dir,
+            driver_name=driver_name.lower(),
+            template_name=template_name
+        )
+
+        try:
+             fsm_handler = textfsm.TextFSM(open(template_path))
+        except IOError:
+            raise napalm.exceptions.TemplateNotImplemented(
+                "TextFSM template {template_name} not defined!".format(
+                    template_name=template_name
+                )
+            )
+        except textfsm.textfsm.TextFSMTemplateError:
+            raise napalm.exceptions.TemplateRenderException(
+                "Wrong format of template {template_name}".format(
+                    template_name=template_name
+                )
+            )
+
+        objects = fsm_handler.ParseText(raw_text)
+
+        for obj in objects:
+            index = 0
+            entry = {}
+            for entry_value in obj:
+                entry[fsm_handler.header[index].lower()] = str(entry_value)
+                index += 1
+            textfsm_data.append(entry)
+
+        return textfsm_data
+
     def get_facts(self):
         """
         Returns a dictionary containing the following information:
diff --git a/napalm/eos.py b/napalm/eos.py
@@ -1008,3 +1008,34 @@ def get_route_to(self, destination = '', protocol = ''):
                     routes[prefix].append(route_next_hop)
 
         return routes
+
+    def get_snmp_information(self):
+
+        snmp_information = dict()
+
+        commands = list()
+        commands.append('show running-config | section snmp-server')
+        raw_snmp_config = self.device.run_commands(commands, encoding = 'text')[0].get('output', '')
+
+        snmp_config = self._textfsm_extractor('snmp_config', raw_snmp_config)
+
+        if not snmp_config:
+            return snmp_information
+
+        snmp_information = {
+            'contact'   : unicode(snmp_config[0].get('contact', '')),
+            'location'  : unicode(snmp_config[0].get('location', '')),
+            'chassis_id': unicode(snmp_config[0].get('chassis_id', '')),
+            'community' : {}
+        }
+
+        for snmp_entry in snmp_config:
+            community_name = unicode(snmp_entry.get('community', ''))
+            if not community_name:
+                continue
+            snmp_information['community'][community_name] = {
+                'acl': unicode(snmp_entry.get('acl', '')),
+                'mode': unicode(snmp_entry.get('mode', 'ro').lower())
+            }
+
+        return snmp_information
diff --git a/napalm/iosxr.py b/napalm/iosxr.py
@@ -1297,3 +1297,34 @@ def get_route_to(self, destination = '', protocol = ''):
                     first_route = False
 
         return routes
+
+    def get_snmp_information(self):
+
+        snmp_information = dict()
+
+        snmp_rpc_command = '<Get><Configuration><SNMP></SNMP></Configuration></Get>'
+
+        snmp_result_tree = ET.fromstring(self.device.make_rpc_call(snmp_rpc_command))
+
+        _PRIVILEGE_MODE_MAP_ = {
+            'ReadOnly': u'ro',
+            'ReadWrite': u'rw'
+        }
+
+        snmp_information = {
+            'chassis_id': unicode(self._find_txt(snmp_result_tree, './/ChassisID')),
+            'contact': unicode(self._find_txt(snmp_result_tree, './/Contact')),
+            'location': unicode(self._find_txt(snmp_result_tree, './/Location')),
+            'community': {}
+        }
+
+        for community in snmp_result_tree.iter('DefaultCommunity'):
+            name = unicode(self._find_txt(community, 'Naming/CommunityName'))
+            privilege = self._find_txt(community, 'Priviledge')
+            acl = unicode(self._find_txt(community, 'AccessList'))
+            snmp_information['community'][name] = {
+                'mode': _PRIVILEGE_MODE_MAP_.get(privilege, u''),
+                'acl' : acl
+            }
+
+        return snmp_information
diff --git a/napalm/junos.py b/napalm/junos.py
@@ -404,6 +404,8 @@ def cli(self, commands = None):
 
     @staticmethod
     def _convert(to, who, default = u''):
+        if who is None:
+            return default
         try:
             return to(who)
         except:
@@ -923,3 +925,44 @@ def get_route_to(self, destination = '', protocol = ''):
             routes[destination].append(d)
 
         return routes
+
+    def get_snmp_information(self):
+
+        snmp_information = dict()
+
+        _AUTHORIZATION_MODE_MAP_ = {
+            'read-only': u'ro',
+            'read-write': u'rw'
+        }
+
+        snmp_config = junos_views.junos_snmp_config_table(self.device)
+        snmp_config.get()
+        snmp_items = snmp_config.items()
+
+        if not snmp_items:
+            return snmp_information
+
+        communities = list()
+        for snmp_config_out in snmp_items:
+            community_name = snmp_config_out[0]
+            community_details = snmp_config_out[1]
+            communities.append({
+                c[0]: c[1] for c in community_details
+            })
+
+        snmp_information = {
+            'contact': self._convert(unicode, communities[0].get('contact')),
+            'location': self._convert(unicode, communities[0].get('location')),
+            'chassis_id': self._convert(unicode, communities[0].get('chassis')),
+            'community': {}
+        }
+
+        for snmp_entry in communities:
+            name = self._convert(unicode, snmp_entry.get('name'))
+            authorization = self._convert(unicode, snmp_entry.get('authorization'))
+            snmp_information['community'][name] = {
+                'mode': _AUTHORIZATION_MODE_MAP_.get(authorization, u''),
+                'acl': u''
+            }
+
+        return snmp_information
diff --git a/napalm/nxos.py b/napalm/nxos.py
@@ -514,3 +514,34 @@ def get_mac_address_table(self):
             )
 
         return mac_table
+
+    def get_snmp_information(self):
+
+        snmp_information = dict()
+
+        snmp_command = 'show running-config | section snmp-server'
+
+        snmp_raw_output = self.cli([snmp_command]).get(snmp_command, '')
+
+        snmp_config = self._textfsm_extractor('snmp_config', snmp_raw_output)
+
+        if not snmp_config:
+            return snmp_information
+
+        snmp_information = {
+            'contact'   : unicode(snmp_config[0].get('contact', '')),
+            'location'  : unicode(snmp_config[0].get('location', '')),
+            'chassis_id': unicode(snmp_config[0].get('chassis_id', '')),
+            'community' : {}
+        }
+
+        for snmp_entry in snmp_config:
+            community_name = unicode(snmp_entry.get('community', ''))
+            if not community_name:
+                continue
+            snmp_information['community'][community_name] = {
+                'acl': unicode(snmp_entry.get('acl', '')),
+                'mode': unicode(snmp_entry.get('mode', '').lower())
+            }
+
+        return snmp_information
diff --git a/napalm/pluribus.py b/napalm/pluribus.py
@@ -260,7 +260,7 @@ def get_snmp_information(self):
         for snmp_line in snmp_lines:
             snmp_line_details = snmp_line.split(';')
             snmp_community = unicode(snmp_line_details[1])
-            snmp_mode      = _SNMP_MODE_MAP_.get(snmp_line_details[1])
+            snmp_mode      = _SNMP_MODE_MAP_.get(snmp_line_details[2], u'ro')
             snmp_acl       = u''
             snmp_information['community'][snmp_community] = {
                 'acl' : snmp_acl,
diff --git a/napalm/utils/junos_views.yml b/napalm/utils/junos_views.yml
@@ -458,3 +458,19 @@ junos_route_table_view:
     ### ISIS Specific fields
     ###
     level: {../rt-isis-level: int}
+
+###
+### SNMP Config
+###
+
+junos_snmp_config_table:
+  get: snmp/community
+  view: junos_snmp_config_view
+
+junos_snmp_config_view:
+  fields:
+    name: name
+    authorization: authorization
+    location: ../location
+    contact: ../contact
+    chassis: ../system-name
diff --git a/napalm/utils/textfsm_templates/eos/snmp_config.tpl b/napalm/utils/textfsm_templates/eos/snmp_config.tpl
@@ -0,0 +1,14 @@
+Value Location (\w+.*)
+Value Contact (\w+.*)
+Value Chassis_ID (\w+.*)
+Value Community (\w+.*)
+Value Mode (ro|rw)
+Value ACL (\w+.*)
+
+Start
+  ^snmp-server\slocation\s${Location}
+  ^snmp-server\scontact\s${Contact}
+  ^snmp-server\schassis-id\s${Chassis_ID}
+  ^snmp-server\scommunity\s${Community}\s((${Mode} ${ACL})|(group\s(.*))) -> Next.Record
+
+EOF
diff --git a/napalm/utils/textfsm_templates/nxos/snmp_config.tpl b/napalm/utils/textfsm_templates/nxos/snmp_config.tpl
@@ -0,0 +1,14 @@
+Value Location (\w+.*)
+Value Contact (\w+.*)
+Value Chassis_ID (\w+.*)
+Value Community (\w+.*)
+Value Mode (ro|rw)
+Value ACL (\w+.*)
+
+Start
+  ^snmp-server\slocation\s${Location}
+  ^snmp-server\scontact\s${Contact}
+  ^snmp-server\schassis-id\s${Chassis_ID}
+  ^snmp-server\scommunity\s${Community}\s((${Mode} ${ACL})|(group\s(.*))) -> Next.Record
+
+EOF
diff --git a/test/unit/eos/mock_data/show_running_config_section_snmp_server.txt b/test/unit/eos/mock_data/show_running_config_section_snmp_server.txt
@@ -0,0 +1,5 @@
+snmp-server contact noc@cloudflare.com
+snmp-server location Marseille, France
+snmp-server chassis-id edge02.mrs01
+snmp-server community hackme ro ifyoucan
+snmp-server community tryagain group not-enough
diff --git a/test/unit/iosxr/mock_data/_Get__Configuration__SNMP___SNMP___Configuration___Get_.rpc b/test/unit/iosxr/mock_data/_Get__Configuration__SNMP___SNMP___Configuration___Get_.rpc
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Response MajorVersion="1" MinorVersion="0">
+    <Get>
+        <Configuration>
+            <SNMP MajorVersion="12" MinorVersion="6">
+                <Administration>
+                    <DefaultCommunityTable>
+                        <DefaultCommunity>
+                            <Naming>
+                                <CommunityName>
+                                    hackme
+                                </CommunityName>
+                            </Naming>
+                            <Priviledge>
+                                ReadOnly
+                            </Priviledge>
+                            <AccessList>
+                                ifyoucan
+                            </AccessList>
+                        </DefaultCommunity>
+                    </DefaultCommunityTable>
+                </Administration>
+                <System>
+                    <ChassisID>
+                        edge01.yyz01
+                    </ChassisID>
+                    <Contact>
+                        noc@cloudflare.com
+                    </Contact>
+                    <Location>
+                        Toronto, Canada
+                    </Location>
+                </System>
+            </SNMP>
+        </Configuration>
+    </Get>
+    <ResultSummary ErrorCount="0"/>
+</Response>
diff --git a/test/unit/junos/mock_data/_configuration__snmp__community____snmp___configuration_.txt b/test/unit/junos/mock_data/_configuration__snmp__community____snmp___configuration_.txt
@@ -0,0 +1,11 @@
+<configuration commit-seconds="1457011246" commit-localtime="2016-03-03 13:20:46 UTC">
+        <snmp>
+            <contact>noc@cloudflare.com</contact>
+            <location>Stockholm, Sweden</location>
+            <system-name>edge02.arn02</system-name>
+            <community>
+                <name>hackme</name>
+                <authorization>read-only</authorization>
+            </community>
+        </snmp>
+</configuration>
diff --git a/test/unit/nxos/mock_data/show_running-config___section_snmp-server.txt b/test/unit/nxos/mock_data/show_running-config___section_snmp-server.txt
@@ -0,0 +1,5 @@
+snmp-server contact noc@cloudflare.com
+snmp-server location Manila, Philippines
+snmp-server chassis-id sw20.mnl01
+snmp-server community hackme ro ifyoucan
+snmp-server community tryagain group not-enough
