Adding NX support

Author: miott

src/cisco_gnmi/builder.py

@@ -271,6 +271,61 @@ def construct(self):
         """Constructs and returns the desired Client object.
         The instance of this class will reset to default values for further building.
 
+        Returns
+        -------
+        Client or NXClient or XEClient or XRClient
+        """
+        channel = None
+        channel_ssl_creds = None
+        channel_metadata_creds = None
+        channel_creds = None
+        channel_ssl_creds = None
+        if any((self.__root_certificates, self.__private_key, self.__certificate_chain)):
+            channel_ssl_creds = grpc.ssl_channel_credentials(
+                self.__root_certificates, self.__private_key, self.__certificate_chain
+            )
+        if self.__username and self.__password:
+            channel_metadata_creds = grpc.metadata_call_credentials(
+                CiscoAuthPlugin(self.__username, self.__password)
+            )
+            logging.debug("Using username/password call authentication.")
+        if channel_ssl_creds and channel_metadata_creds:
+            channel_creds = grpc.composite_channel_credentials(
+                channel_ssl_creds, channel_metadata_creds
+            )
+            logging.debug("Using SSL/metadata authentication composite credentials.")
+        elif channel_ssl_creds:
+            channel_creds = channel_ssl_creds
+            logging.debug("Using SSL credentials, no metadata authentication.")
+        if channel_creds:
+            if self.__ssl_target_name_override is not False:
+                if self.__ssl_target_name_override is None:
+                    if not self.__root_certificates:
+                        raise Exception("Deriving override requires root certificate!")
+                    self.__ssl_target_name_override = get_cn_from_cert(
+                        self.__root_certificates
+                    )
+                    logging.warning(
+                        "Overriding SSL option from certificate could increase MITM susceptibility!"
+                    )
+                self.set_channel_option(
+                    "grpc.ssl_target_name_override", self.__ssl_target_name_override
+                )
+            channel = grpc.secure_channel(
+                self.__target_netloc.netloc, channel_creds, self.__channel_options
+            )
+        else:
+            channel = grpc.insecure_channel(self.__target_netloc.netloc)
+        if self.__client_class is None:
+            self.set_os()
+        client = self.__client_class(channel)
+        self._reset()
+        return client
+
+    def save_construct(self):
+        """Constructs and returns the desired Client object.
+        The instance of this class will reset to default values for further building.
+
         Returns
         -------
         Client or NXClient or XEClient or XRClient

src/cisco_gnmi/client.py

@@ -217,7 +217,6 @@ def set(
             request.extension.extend(extensions)
 
         LOGGER.debug(str(request))
-
         response = self.service.Set(request)
         return response
 

src/cisco_gnmi/nx.py

@@ -23,7 +23,7 @@
 
 """Wrapper for NX-OS to simplify usage of gNMI implementation."""
 
-
+import json
 import logging
 
 from six import string_types
@@ -159,7 +159,7 @@ def create_updates(name, configs):
         replaces = create_updates("replace_json_configs", replace_json_configs)
         return self.set(prefix=prefix, updates=updates, replaces=replaces)
 
-    def get_xpaths(self, xpaths, data_type="ALL", encoding="JSON_IETF"):
+    def get_xpaths(self, xpaths, data_type="ALL", encoding="JSON"):
         """A convenience wrapper for get() which forms proto.gnmi_pb2.Path from supplied xpaths.
 
         Parameters
@@ -178,7 +178,7 @@ def get_xpaths(self, xpaths, data_type="ALL", encoding="JSON_IETF"):
         -------
         get()
         """
-        supported_encodings = ["JSON", "JSON_IETF"]
+        supported_encodings = ["JSON"]
         encoding = util.validate_proto_enum(
             "encoding",
             encoding,
@@ -288,19 +288,18 @@ def subscribe_xpaths(
 
     def parse_xpath_to_gnmi_path(self, xpath, origin=None):
         """Attempts to determine whether origin should be YANG (device) or DME.
-        Errors on OpenConfig until support is present.
         """
-        if xpath.startswith("openconfig"):
-            raise NotImplementedError(
-                "OpenConfig data models not yet supported on NX-OS!"
-            )
         if origin is None:
             if any(
-                map(xpath.startswith, ["Cisco-NX-OS-device", "/Cisco-NX-OS-device"])
+                map(xpath.startswith, [
+                    "Cisco-NX-OS-device",
+                    "/Cisco-NX-OS-device",
+                    "cisco-nx-os-device",
+                    "/Cisco-nx-os-device"])
             ):
                 origin = "device"
                 # Remove the module
                 xpath = xpath.split(":", 1)[1]
             else:
-                origin = "DME"
+                origin = "openconfig"
         return super(NXClient, self).parse_xpath_to_gnmi_path(xpath, origin)