Merge pull request #446 from earies/yang-action-sros

Support for YANG 1.1 action + Nokia SROS devices

README.md

@@ -102,6 +102,7 @@ When instantiating a connection to a known type of NETCONF server:
     - `device_params={'name':'huawei'}`
     - `device_params={'name':'huaweiyang'}`
 * Alcatel Lucent: `device_params={'name':'alu'}`
+* Nokia SR OS: `device_params={'name':'sros'}`
 * H3C: `device_params={'name':'h3c'}`
 * HP Comware: `device_params={'name':'hpcomware'}`
 * Server or anything not in above: `device_params={'name':'default'}`

README.rst

@@ -97,6 +97,7 @@ Supported device handlers
     - `device_params={'name':'huawei'}`
     - `device_params={'name':'huaweiyang'}`
 * Alcatel Lucent: `device_params={'name':'alu'}`
+* Nokia SR OS: `device_params={'name':'sros'}`
 * H3C: `device_params={'name':'h3c'}`
 * HP Comware: `device_params={'name':'hpcomware'}`
 * Server or anything not in above: `device_params={'name':'default'}`

examples/nokia/sros/get_config.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python
+#
+
+import logging
+import sys
+
+from ncclient import manager
+from ncclient.xml_ import to_xml
+from ncclient.operations.rpc import RPCError
+
+_NS_MAP = {
+    'nc': 'urn:ietf:params:xml:ns:netconf:base:1.0',
+    'nokia-conf': 'urn:nokia.com:sros:ns:yang:sr:conf'
+}
+
+_NOKIA_MGMT_INT_FILTER = '''
+<configure xmlns="%s">
+  <system>
+    <management-interface/>
+  </system>
+</configure>
+''' % (_NS_MAP['nokia-conf'])
+
+def connect(host, port, user, password):
+    m = manager.connect(host=host, port=port,
+            username=user, password=password,
+            device_params={'name': 'sros'},
+            hostkey_verify=False)
+
+    ## Retrieve full configuration from the running datastore
+    running_xml = m.get_config(source='running')
+    logging.info(running_xml)
+
+    ## Retrieve full configuration from the running datastore and strip
+    ## the rpc-reply + data elements
+    running_xml = m.get_config(source='running').xpath(
+            '/nc:rpc-reply/nc:data/nokia-conf:configure',
+            namespaces=_NS_MAP)[0]
+    logging.info(to_xml(running_xml, pretty_print=True))
+
+    ## Retrieve full configuration from the running datastore and strip
+    ## out elements except for /configure/system/management-interface
+    running_xml = m.get_config(source='running').xpath(
+            '/nc:rpc-reply/nc:data/nokia-conf:configure' \
+            '/nokia-conf:system/nokia-conf:management-interface',
+            namespaces=_NS_MAP)[0]
+    logging.info(to_xml(running_xml, pretty_print=True))
+
+    ## Retrieve a specific filtered subtree from the running datastore
+    ## and handle any rpc-error should a portion of the filter criteria
+    ## be invalid
+    try:
+        running_xml = m.get_config(source='running',
+                filter=('subtree', _NOKIA_MGMT_INT_FILTER),
+                with_defaults='report-all').xpath(
+                        '/nc:rpc-reply/nc:data/nokia-conf:configure',
+                        namespaces=_NS_MAP)[0]
+        logging.info(to_xml(running_xml, pretty_print=True))
+
+    except RPCError as err:
+        logging.info('Error: %s' % err.message.strip())
+
+    m.close_session()
+
+if __name__ == '__main__':
+    LOG_FORMAT = '%(asctime)s %(levelname)s %(filename)s:%(lineno)d %(message)s'
+    logging.basicConfig(stream=sys.stdout, level=logging.INFO, format=LOG_FORMAT)
+
+    try:
+        connect(sys.argv[1], '830', 'admin', 'admin')
+
+    except IndexError:
+        logging.error('Must supply a valid hostname or IP address')
+

examples/nokia/sros/md_cli_raw_command.py

@@ -0,0 +1,92 @@
+#!/usr/bin/env python
+#
+# For Nokia SR OS > 20.10, support for issuing a subset of CLI commands
+# (e.g. 'show', 'admin', 'clear', 'ping', etc..) over NETCONF RPCs is
+# achieved by the use of the <md-cli-raw-command> YANG 1.1 action
+
+import logging
+import sys
+
+from ncclient import manager
+from ncclient.operations.rpc import RPCError
+
+_NS_MAP = {
+    'nc': 'urn:ietf:params:xml:ns:netconf:base:1.0',
+    'nokia-oper': 'urn:nokia.com:sros:ns:yang:sr:oper-global'
+}
+
+def connect(host, port, user, password):
+    m = manager.connect(host=host, port=port,
+            username=user, password=password,
+            device_params={'name': 'sros'},
+            hostkey_verify=False)
+
+    ## Issue 'show card' and display the raw XML output
+    result = m.md_cli_raw_command('show card')
+    logging.info(result)
+
+    ## Issue 'show port' from MD-CLI context and emit only
+    ## the returned command contents
+    result = m.md_cli_raw_command('show port')
+    output = result.xpath(
+            '/nc:rpc-reply/nokia-oper:results' \
+            '/nokia-oper:md-cli-output-block',
+            namespaces=_NS_MAP)[0].text
+    logging.info(output)
+
+    ## Issue 'show version' from Classic CLI context and emit
+    ## only the returned command contents
+    result = m.md_cli_raw_command('//show version')
+    output = result.xpath(
+            '/nc:rpc-reply/nokia-oper:results' \
+            '/nokia-oper:md-cli-output-block',
+            namespaces=_NS_MAP)[0].text
+    logging.info(output)
+
+    ## Issue 'ping' from MD-CLI context and emit only the
+    ## returned command contents
+    result = m.md_cli_raw_command(
+            'ping 127.0.0.1 router-instance "Base" count 3')
+    output = result.xpath(
+            '/nc:rpc-reply/nokia-oper:results' \
+            '/nokia-oper:md-cli-output-block',
+            namespaces=_NS_MAP)[0].text
+    logging.info(output)
+
+    ## Issue an admin command that returns only NETCONF <ok/> or
+    ## <rpc-error/>
+    result = m.md_cli_raw_command('admin save')
+    try:
+        if len(result.xpath('/nc:rpc-reply/nc:ok', namespaces=_NS_MAP)) > 0:
+            logging.info('Admin save successful')
+        else:
+            logging.info('Admin save unsuccessful')
+
+    except RPCError as err:
+        logging.info('Error: %s' % err.message.strip())
+
+
+    ## Issue an unsupported command and handle the RPC error gracefully
+    try:
+        result = m.md_cli_raw_command('configure')
+        if len(result.xpath('/nc:rpc-reply/nc:ok', namespaces=_NS_MAP)) > 0:
+            logging.info('Command successful')
+        else:
+            logging.info('Command unsuccessful')
+
+    except RPCError as err:
+        logging.info('Error: %s' % err.message.strip())
+
+    m.close_session()
+
+if __name__ == '__main__':
+    LOG_FORMAT = '%(asctime)s %(levelname)s %(filename)s:%(lineno)d %(message)s'
+    logging.basicConfig(stream=sys.stdout, level=logging.INFO, format=LOG_FORMAT)
+
+    try:
+        connect(sys.argv[1], '830', 'admin', 'admin')
+
+    except IndexError:
+        logging.error('Must supply a valid hostname or IP address')
+
+

ncclient/devices/__init__.py

@@ -1,4 +1,4 @@
-# supported devices config, add new device (eg: 'device name':'device lable').
+# supported devices config, add new device (eg: 'device name':'device label').
 supported_devices_cfg = {'junos':'Juniper',
                          'csr':'Cisco CSR1000v',
                          'nexus':'Cisco Nexus',
@@ -9,6 +9,7 @@
                          'alu':'Alcatel Lucent',
                          'h3c':'H3C',
                          'hpcomware':'HP Comware',
+                         'sros':'Nokia SR OS',
                          'default':'Server or anything not in above'}
 
 def get_supported_devices():

ncclient/devices/sros.py

@@ -0,0 +1,54 @@
+from lxml import etree
+
+from .default import DefaultDeviceHandler
+from ncclient.operations.third_party.sros.rpc import MdCliRawCommand
+from ncclient.xml_ import BASE_NS_1_0
+
+
+def passthrough(xml):
+    return xml
+
+class SrosDeviceHandler(DefaultDeviceHandler):
+    """
+    Nokia SR OS handler for device specific information.
+    """
+
+    def __init__(self, device_params):
+        super(SrosDeviceHandler, self).__init__(device_params)
+
+    def get_capabilities(self):
+        """Set SR OS device handler client capabilities
+
+        Set additional capabilities beyond the default device handler.
+
+        Returns:
+            A list of strings representing NETCONF capabilities to be
+            sent to the server.
+        """
+        base = super(SrosDeviceHandler, self).get_capabilities()
+        additional = [
+            'urn:ietf:params:xml:ns:netconf:base:1.0',
+            'urn:ietf:params:xml:ns:yang:1',
+            'urn:ietf:params:netconf:capability:confirmed-commit:1.1',
+            'urn:ietf:params:netconf:capability:validate:1.1']
+        return base + additional
+
+    def get_xml_base_namespace_dict(self):
+        return {None: BASE_NS_1_0}
+
+    def get_xml_extra_prefix_kwargs(self):
+        d = {}
+        d.update(self.get_xml_base_namespace_dict())
+        return {"nsmap": d}
+
+    def add_additional_operations(self):
+        operations = {
+            'md_cli_raw_command': MdCliRawCommand
+        }
+        return operations
+
+    def perform_qualify_check(self):
+        return False
+
+    def transform_reply(self):
+        return passthrough

ncclient/operations/third_party/sros/rpc.py

@@ -0,0 +1,26 @@
+from ncclient.xml_ import *
+
+from ncclient.operations.rpc import RPC
+
+def global_operations(node):
+    """Instantiate an SR OS global operation action element
+
+    Args:
+        node: A string representing the top-level action for a
+            given global operation.
+    Returns:
+        A tuple of 'lxml.etree._Element' values.  The first value
+        represents the top-level YANG action element and the second
+        represents the caller supplied initial node.
+    """
+    parent, child = yang_action('global-operations',
+            attrs={'xmlns': SROS_GLOBAL_OPS_NS})
+    ele = sub_ele(child, node)
+    return (parent, ele)
+
+class MdCliRawCommand(RPC):
+    def request(self, command=None):
+        node, raw_cmd_node = global_operations('md-cli-raw-command')
+        sub_ele(raw_cmd_node, 'md-cli-input-line').text = command
+        self._huge_tree = True
+        return self._request(node)

ncclient/xml_.py

@@ -45,9 +45,11 @@ class XMLError(NCClientError):
 
 #: Base NETCONF namespace
 BASE_NS_1_0 = "urn:ietf:params:xml:ns:netconf:base:1.0"
-# NXOS_1_0
+#: YANG (RFC 6020/RFC 7950) namespace
+YANG_NS_1_0 = "urn:ietf:params:xml:ns:yang:1"
+#: NXOS_1_0
 NXOS_1_0 = "http://www.cisco.com/nxos:1.0"
-# NXOS_IF
+#: NXOS_IF
 NXOS_IF = "http://www.cisco.com/nxos:1.0:if_manager"
 #: Namespace for Tail-f core data model
 TAILF_AAA_1_1 = "http://tail-f.com/ns/aaa/1.1"
@@ -75,9 +77,12 @@ class XMLError(NCClientError):
 NETCONF_NOTIFICATION_NS = "urn:ietf:params:xml:ns:netconf:notification:1.0"
 #: Namespace for netconf with-defaults (RFC 6243)
 NETCONF_WITH_DEFAULTS_NS = "urn:ietf:params:xml:ns:yang:ietf-netconf-with-defaults"
-#: Namespace for Alcatel-Lucent
+#: Namespace for Alcatel-Lucent SR OS Base r13 YANG models
 ALU_CONFIG = "urn:alcatel-lucent.com:sros:ns:yang:conf-r13"
-#
+#: Namespace for Nokia SR OS global operations
+SROS_GLOBAL_OPS_NS = "urn:nokia.com:sros:ns:yang:sr:oper-global"
+
+
 try:
     register_namespace = etree.register_namespace
 except AttributeError:
@@ -173,13 +178,22 @@ def __init__(self, result, transform_reply, huge_tree=False):
         else:
             self.__doc = self.remove_namespaces(self.__result)
 
-    def xpath(self, expression):
-        """
-            return result for a call to lxml xpath()
-            output will be a list
+    def xpath(self, expression, namespaces={}):
+        """Perform XPath navigation on an object
+
+        Args:
+            expression: A string representing a compliant XPath
+                expression.
+            namespaces: A dict of caller supplied prefix/xmlns to
+                append to the static dict of XPath namespaces.
+        Returns:
+            A list of 'lxml.etree._Element' should a match on the
+            expression be successful.  Otherwise, an empty list will
+            be returned to the caller.
         """
         self.__expression = expression
         self.__namespaces = XPATH_NAMESPACES
+        self.__namespaces.update(namespaces)
         return self.__doc.xpath(self.__expression, namespaces=self.__namespaces)
 
     def find(self, expression):
@@ -199,7 +213,7 @@ def findall(self, expression):
 
     def __str__(self):
         """syntactic sugar for str() - alias to tostring"""
-        if sys.version<'3':
+        if sys.version < '3':
             return self.tostring
         else:
             return self.tostring.decode('UTF-8')
@@ -232,6 +246,22 @@ def parent_ns(node):
         return node.nsmap[node.prefix]
     return None
 
+def yang_action(name, attrs):
+    """Instantiate a YANG action element
+
+    Args:
+        name: A string representing the first descendant name of the
+            XML element for the YANG action.
+        attrs: A dict of attributes to apply to the XML element
+            (e.g. namespaces).
+    Returns:
+        A tuple of 'lxml.etree._Element' values.  The first value
+        represents the top-level YANG action element and the second
+        represents the caller supplied initial node.
+    """
+    node = new_ele('action', attrs={'xmlns': YANG_NS_1_0})
+    return (node, sub_ele(node, name, attrs))
+
 new_ele_nsmap = lambda tag, nsmap, attrs={}, **extra: etree.Element(qualify(tag), attrs, nsmap, **extra)
 
 new_ele = lambda tag, attrs={}, **extra: etree.Element(qualify(tag), attrs, **extra)

setup.py

@@ -23,7 +23,7 @@
 import versioneer
 
 __author__ = "Shikhar Bhushan, Leonidas Poulopoulos, Ebben Aries, Einar Nilsen-Nygaard"
-__author_email__ = "shikhar@schmizz.net, lpoulopoulos@verisign.com, earies@juniper.net, einarnn@gmail.com"
+__author_email__ = "shikhar@schmizz.net, lpoulopoulos@verisign.com, exa@dscp.org, einarnn@gmail.com"
 __licence__ = "Apache 2.0"
 
 if sys.version_info.major == 2 and sys.version_info.minor < 7:

test/unit/devices/test_get_supported_devices.py

@@ -15,6 +15,7 @@ def test_get_supported_devices(self):
                                                             'alu',
                                                             'h3c',
                                                             'hpcomware',
+                                                            'sros',
                                                             'default')))
 
     def test_get_supported_device_labels(self):
@@ -29,5 +30,6 @@ def test_get_supported_device_labels(self):
                                                    'alu':'Alcatel Lucent',
                                                    'h3c':'H3C',
                                                    'hpcomware':'HP Comware',
+                                                   'sros':'Nokia SR OS',
                                                    'default':'Server or anything not in above'})