sc-napalm 1.0.0__py3-none-any.whl

custom_napalm/junos/junos.py

@@ -0,0 +1,223 @@
+# # pylint: disable=no-member
+from typing import List
+import re
+import logging
+
+from napalm.junos import JunOSDriver
+from napalm.base.models import LLDPNeighborDict, ConfigDict
+from ..models import InventoryDict
+from ..base import SCBaseNetconfDriver
+
+
+from . import junos_views
+
+logger = logging.getLogger(__name__)
+
+XCVR_DESC_TO_INTERFACE_PREFIX = {
+    r"100GBASE-": "et-",
+    r"QSFP": "et-",
+    r"SFP28": "et-",
+    r"SFP\+": "xe-",
+    r"SFP-": "ge-",
+    r"CFP-": "et-",
+    r"(UNKNOWN|UNSUPPORTED)": "ge-",  # default
+}
+
+DEFAULT_ARP_AGING_TIMER = 1200
+
+
+class SCJunOS(JunOSDriver, SCBaseNetconfDriver):
+    """
+    Junos parser
+    """
+
+    netmiko_host_type = "juniper_junos"
+
+    # mapping of inventory name regex to their netbox types
+    INVENTORY_TO_TYPE = {
+        r"Fan Tray": "fan",
+        r"(PIC|MIC|FPC)": "linecard",
+        r"Xcvr": "optic",
+        r"(PEM|Power Supply)": "psu",
+        r"Routing Engine": "re",
+        # don't care about these inventory items
+        r"(CPU|PDM|FPM|Midplane|CB|SFB|TIB)": None,
+    }
+
+    def _get_junos_inventory_type(self, name: str, model_number: str) -> str:
+        """
+        Maps the name and part number of the Junos inventory item to its type
+        """
+        # "Xcvr" parts are always optics
+        if name.startswith("Xcvr"):
+            return "optic"
+
+        # non-optic parts should always have a model number, if not
+        # we don't care about them
+        if not (model_number):
+            return None
+
+        # EX switches and virtual chassis save their vc members and uplink modules
+        # as FPC X and PIC X - we want to classify those correctly
+        if re.match(r"EX[234]", model_number):
+            if re.search(r"FPC \d+", name):
+                return "stack-member"
+
+            if re.search(r"PIC \d+", name):
+                return None
+
+        # uplink modules are also saved under PIC X, must classify based
+        # on their model number
+        if re.match(r"EX-UM", model_number):
+            return "uplink-module"
+
+        # otherwise we want to pattern-match based on the INVENTORY_TO_TYPE
+        # dictionary
+        return self._get_inventory_type(name)
+
+    def _get_xcvr_interface_prefix(self, xcvr_desc: str) -> str:
+        """
+        Maps xcvr description from "show chassis hardware" to
+        interface prefix
+        """
+        for pattern, prefix in XCVR_DESC_TO_INTERFACE_PREFIX.items():
+            if re.match(pattern, xcvr_desc):
+                return prefix
+
+        raise ValueError(f"{self.hostname}: Unknown xcvr type {xcvr_desc}")
+
+    def _get_mod_number(self, mod_name: str) -> str:
+        """
+        Strips out "FPC|MIC|PIC" from a module name seen in "show chassis hardware"
+        """
+        return re.sub(r"(MIC|PIC|FPC) ", "", mod_name)
+
+    def _get_inventory_part_number(self, item: any) -> str:
+        """
+        Extracts the part number from an inventory item
+        which, depending on the specific item, is stashed in
+        the part number, model number, or description field
+        """
+        if item.model_number and item.model_number != "model-number":
+            return item.model_number
+        return item.part_number
+
+    def _save_inventory_item(
+        self, output: list, item: any, parent: str = None, grandparent: str = None
+    ) -> bool:
+        """
+        Extracts data from a particular inventory item object.
+        Returns whether we care aobut this item or not (so we know whether or not)
+        to loop over its children
+        """
+        # skip builtin types, or parts without model numbers that aren't transcievers
+        if item.part_number == "BUILTIN":
+            return False
+
+        # get inventory type based on item name and P/N
+        inv_type = self._get_junos_inventory_type(item.name, item.model_number)
+
+        if not inv_type:
+            return False
+
+        # for transcievers, change the name from Xcvr X to be the junos interface name
+        # note that we expect transcievers to always be at the sub-sub module level
+        # and thus to have a grandparent and parent
+        m = re.search(r"Xcvr (\d+)", item.name)
+        if m:
+            if not (grandparent or parent):
+                raise ValueError(
+                    f"{self.hostname}: No MIC and PIC found for {item.name}"
+                )
+            prefix = self._get_xcvr_interface_prefix(item.description)
+
+            item_name = f"{prefix}{self._get_mod_number(grandparent)}/{self._get_mod_number(parent)}/{m.group(1)}"
+
+        # for sub-linecards (mics or pics) we want to prepend the parent to the item name
+        elif parent:
+            item_name = f"{parent} {item.name}"
+        else:
+            item_name = item.name
+
+        output.append(
+            {
+                "type": inv_type,
+                "name": item_name,
+                "subtype": item.description,
+                "part_number": self._get_inventory_part_number(item),
+                "serial_number": item.serial_number,
+            }
+        )
+
+        return True
+
+    def get_config(
+        self, retrieve="all", full=False, sanitized=False, format="text"
+    ) -> ConfigDict:
+        """
+        pulling running config via ssh sow we can have it in 'display set' format.
+        """
+        if format != "text":
+            return super().get_config(
+                retrieve=retrieve, full=full, sanitized=sanitized, format=format
+            )
+
+        config = {"startup": "", "running": "", "candidate": ""}
+
+        with self.ssh_conn() as ssh_device:
+            config["running"] = ssh_device.send_command(
+                "show configuration | display set"
+            )
+
+        return config
+
+    def get_lldp_neighbors(self) -> LLDPNeighborDict:
+        """
+        Overrides napalm get_lldp_neighbors so that we actually get the remote
+        interface ID instead of the description.
+
+        NAPALM's get_lldp_neighbors_detail gets this for us - note that to get this detail,
+        you need to execute a command for each interface just like on the cli :(
+        """
+        neighs = super().get_lldp_neighbors_detail()
+        output = {}
+        for port, neighs in neighs.items():
+            output[port] = []
+            for neigh in neighs:
+                output[port].append(
+                    {
+                        "hostname": neigh["remote_system_name"]
+                        if neigh["remote_system_name"]
+                        else neigh["remote_chassis_id"],
+                        "port": neigh["remote_port"],
+                    }
+                )
+        return output
+
+    def get_inventory(self) -> List[InventoryDict]:
+        """
+        parses the get-chassis-inventory RPC call, which maps to "show chassis hardware"
+        """
+        result = junos_views.junos_inventory(self.device).get()
+
+        output = []
+        for chassis in dict(result).values():
+            # note that the chassis model and s/n are at this level, but
+            # that doesn't count as an 'inventory item' so we're ignoring it
+
+            # saving modules, sub-modules and sub-sub modules
+            for module in dict(chassis.modules).values():
+                self._save_inventory_item(output, module)
+
+                for sub_module in dict(module.sub_modules).values():
+                    self._save_inventory_item(output, sub_module, parent=module.name)
+
+                    for sub_sub_module in dict(sub_module.sub_sub_modules).values():
+                        self._save_inventory_item(
+                            output,
+                            sub_sub_module,
+                            parent=sub_module.name,
+                            grandparent=module.name,
+                        )
+
+        return output

custom_napalm/junos/junos_views.py

@@ -0,0 +1,17 @@
+## https://www.juniper.net/documentation/us/en/software/junos-pyez/junos-pyez-developer/topics/task/junos-pyez-tables-views-loading.html
+
+"""
+Load tables/views
+"""
+
+from os.path import splitext
+import yaml
+from jnpr.junos.factory import FactoryLoader
+
+
+_YAML_ = splitext(__file__)[0] + ".yml"
+
+with open(_YAML_, encoding="utf-8") as f:
+    yaml_str = f.read()
+
+globals().update(FactoryLoader().load(yaml.safe_load(yaml_str)))

custom_napalm/junos/junos_views.yml

@@ -0,0 +1,228 @@
+### ip interfaces ###
+junos_ip_interfaces:
+  rpc: get-interface-information
+  item: physical-interface/logical-interface/address-family/interface-address
+  key: ifa-local
+  view: junos_ip_interfaces_view
+
+junos_ip_interfaces_view:
+  fields:
+    ip: ifa-local
+    subnet: ifa-destination
+    family: ../address-family-name
+    interface: ../../name
+    mtu: ../mtu
+    description: ../../description
+    primary: ifa-flags/ifaf-current-primary
+    preferred: ifa-flags/ifaf-current-preferred
+    admin_up: ../../if-config-flags/iff-up
+    device_down: ../../if-config-flags/iff-device-down
+    hardware_down: ../../if-config-flags/iff-hardware-down
+
+
+junos_vrf_interfaces:
+  rpc: get-instance-information
+  args:
+    detail: True
+  item: instance-core/instance-interface
+  key: interface-name
+  view: junos_vrf_interfaces_view
+
+junos_vrf_interfaces_view:
+  fields:
+    vrf: ../instance-name
+
+## show route active-path ####
+junos_route_table:
+  rpc: get-route-information
+  item: route-table/rt
+  args:
+    active-path: True
+  key: 
+    - rt-destination
+    - ../table-name
+  view: junos_route_table_view
+
+junos_route_table_view:
+  fields:
+    vrf: ../table-name
+    prefix: rt-destination
+    rt_entry: _entry_table
+
+_entry_table:
+  item: rt-entry
+  key:
+   - protocol-name
+   - learned-from
+  view: _entry_view
+
+_entry_view:
+  fields:
+    age: age
+    protocol: protocol-name
+    learned_from: gateway
+    next_hop: _nh_table
+    
+_nh_table:
+  item: nh
+  key:
+    - to
+    - via
+  view: _nh_view
+
+_nh_view:
+  fields:
+    nh_ip: to
+    nh_interface: via
+    mpls_label: mpls-label
+    selected_next_hop: selected-next-hop
+#    nh_table_receive: nh-table-receive
+#    nh_table: nh-table
+
+### show route table mpls ###
+junos_mpls_table:
+  rpc: get-route-information
+  item: route-table/rt
+  args:
+    table: mpls.0
+    active-path: True
+  key: 
+    - rt-destination
+  view: junos_mpls_table_view
+
+junos_mpls_table_view:
+  fields:
+    prefix: rt-destination
+    rt_entry: _mpls_entry_table
+
+_mpls_entry_table:
+  item: rt-entry
+  key:
+   - protocol-name
+   - learned-from
+  view: _mpls_entry_view
+
+_mpls_entry_view:
+  fields:
+    next_hop: _mpls_nh_table
+    
+_mpls_nh_table:
+  item: nh
+  key:
+    - to
+    - via
+  view: _mpls_nh_view
+
+_mpls_nh_view:
+  fields:
+    nh_ip: to
+    nh_interface: via
+    mpls_label: mpls-label
+#    selected_next_hop: selected-next-hop
+    nh_table_receive: nh-table-receive
+    nh_table: nh-table
+
+
+### show chassis inventory ###
+junos_inventory:
+  rpc: get-chassis-inventory
+  item: chassis
+  view: junos_inventory_view
+
+junos_inventory_view:
+  fields:
+    system_serial: serial-number
+    system_description: description
+    modules: _module_table
+
+_module_table:
+  item: chassis-module
+  key: name
+  view: _module_view
+
+_module_view:
+  fields:
+    name: name
+    part_number: part-number
+    serial_number: serial-number
+    description: description
+    model_number: model-number
+    sub_modules: _sub_module_table
+
+_sub_module_table:
+  item: chassis-sub-module
+  key: name
+  view: _sub_module_view
+
+_sub_module_view:
+  fields:
+    name: name
+    part_number: part-number
+    serial_number: serial-number
+    description: description
+    model_number: model-number
+    sub_sub_modules: _sub_sub_module_table
+
+_sub_sub_module_table:
+  item: chassis-sub-sub-module
+  key: name
+  view: _sub_sub_module_view
+
+_sub_sub_module_view:
+  fields:
+    name: name
+    part_number: part-number
+    serial_number: serial-number
+    description: description
+    model_number: model-number
+
+
+### show route summary (for determining VPNs for ARP table) ###
+junos_route_summary:
+  rpc: get-route-summary-information
+  item: route-table
+  key: table-name
+  view: junos_route_summary_view
+
+junos_route_summary_view:
+  fields:
+    table: table-name
+
+
+junos_show_int_lag:
+  rpc: get-interface-information
+  args:
+    terse: True
+  item: physical-interface/logical-interface
+  key: name
+  view: junos_show_int_lag_view
+
+junos_show_int_lag_view:
+  fields:
+    phy_admin_status: ../admin-status
+    admin_status: admin-status
+    oper_status: oper-status
+    lag_name: address-family/ae-bundle-name
+
+
+junos_show_lacp:
+  rpc: get-lacp-interface-information
+  item: lacp-interface-information
+  key: lag-lacp-header/aggregate-name
+  view: show_lacp_view
+
+show_lacp_view:
+  fields:
+    name: lag-lacp-header/aggregate-name
+    members: _lacp_member_table
+
+_lacp_member_table:
+  item: lag-lacp-state
+  key: name
+  view: _show_lacp_member_view
+
+_show_lacp_member_view:
+  fields:
+    lacp_timeout: lacp-timeout
+    lacp_activity: lacp-activity
+

custom_napalm/models.py

@@ -0,0 +1,27 @@
+from typing import Literal
+from typing_extensions import TypedDict
+
+VALID_INVENTORY_TYPES = Literal[
+    "fabric_module",
+    "fan",
+    "linecard",
+    "optic",
+    "psu",
+    "re",
+    "stack_cable",
+    "stack_member",
+    "uplink_module",
+    "aoc",
+    "dac",
+]
+
+InventoryDict = TypedDict(
+    "InventoryDict",
+    {
+        "type": VALID_INVENTORY_TYPES,
+        "subtype": str,
+        "name": str,
+        "part_number": str,
+        "serial_number": str,
+    },
+)

custom_napalm/nos/__init__.py

@@ -0,0 +1 @@
+from .nos import SCNOSDriver

custom_napalm/nos/constants.py

@@ -0,0 +1,111 @@
+NS = {
+    "dn-top": "http://drivenets.com/ns/yang/dn-top",
+    "dn-sys": "http://drivenets.com/ns/yang/dn-system",
+    "dn-sys-dns": "http://drivenets.com/ns/yang/dn-sys-dns",
+    "dn-sys-ncp": "http://drivenets.com/ns/yang/dn-sys-ncp",
+    "dn-platform": "http://drivenets.com/ns/yang/dn-platform",
+    "dn-if": "http://drivenets.com/ns/yang/dn-interfaces",
+    "dn-trans": "http://drivenets.com/ns/yang/dn-transceivers",
+    "dn-lldp": "http://drivenets.com/ns/yang/dn-lldp",
+    "dn-proto": "http://drivenets.com/ns/yang/dn-protocol",
+}
+
+FACTS_RPC_REQ = """<get xmlns="urn:ietf:params:xml:ns:netconf:base:1.1">
+  <filter>
+    <drivenets-top xmlns="http://drivenets.com/ns/yang/dn-top">
+      <system xmlns="http://drivenets.com/ns/yang/dn-system">
+        <oper-items>
+          <system-type/>
+          <system-uptime/>
+          <system-version/>
+        </oper-items>
+        <config-items>
+          <name/>
+        </config-items>
+        <ncps xmlns="http://drivenets.com/ns/yang/dn-sys-ncp">
+          <ncp>
+            <config-items>
+              <platform>
+                <oper-items>
+                  <serial-number/>
+                </oper-items>
+              </platform>
+            </config-items>
+          </ncp>
+        </ncps>
+        <dns xmlns="http://drivenets.com/ns/yang/dn-sys-dns">
+          <config-items>
+            <domain-name/>
+          </config-items>
+        </dns>
+      </system>
+      <interfaces xmlns="http://drivenets.com/ns/yang/dn-interfaces">
+        <interface>
+          <name/>
+        </interface>
+      </interfaces>
+    </drivenets-top>
+  </filter>
+</get>
+"""
+
+OPTICS_RPC_REQ = """<get xmlns="urn:ietf:params:xml:ns:netconf:base:1.1">
+<filter>
+  <drivenets-top xmlns="http://drivenets.com/ns/yang/dn-top">
+    <interfaces xmlns="http://drivenets.com/ns/yang/dn-interfaces">
+       <interface>
+          <transceivers xmlns="http://drivenets.com/ns/yang/dn-transceivers">
+            <oper-items>
+              <digital-optical-monitoring/>
+            </oper-items>
+        </transceivers>
+      </interface>
+    </interfaces>
+  </drivenets-top>
+</filter>
+</get>
+"""
+
+LLDP_NEIGH_RPC_REQ = """<get xmlns="urn:ietf:params:xml:ns:netconf:base:1.1">
+<filter>
+	<drivenets-top xmlns="http://drivenets.com/ns/yang/dn-top">
+    <protocols xmlns="http://drivenets.com/ns/yang/dn-protocol">
+      <lldp xmlns="http://drivenets.com/ns/yang/dn-lldp">
+        <interfaces>
+          <interface>
+            <neighbors>
+              <neighbor/>
+            </neighbors>
+          </interface>
+        </interfaces>
+      </lldp>      
+    </protocols>
+	</drivenets-top>
+</filter>
+</get>
+"""
+
+INVENTORY_RPC_REQ = """<get xmlns="urn:ietf:params:xml:ns:netconf:base:1.1">
+<filter>
+  <drivenets-top xmlns="http://drivenets.com/ns/yang/dn-top">
+    <interfaces xmlns="http://drivenets.com/ns/yang/dn-interfaces">
+       <interface>
+        <oper-items>
+          <interface-speed/>
+        </oper-items>
+        <transceivers xmlns="http://drivenets.com/ns/yang/dn-transceivers">
+          <oper-items>
+            <form-factor/>
+            <ethernet-pmd/>
+            <vendor/>
+            <vendor-part/>
+            <serial-no/>
+            <wavelength/>
+          </oper-items>
+        </transceivers>
+      </interface>
+    </interfaces>
+  </drivenets-top>
+</filter>
+</get>
+"""