bump to 0.16.1, fix for salt-nornir netbox pillar and added couple fi…

…els for retrieved connections data

docker-compose.rocky.py39.yaml

@@ -31,7 +31,7 @@ services:
       - type: bind
         source: .
         target: /tmp/salt_nornir/
-
+        
   salt-minion-nrp1:
     container_name: salt-minion-nrp1
     hostname: 'salt-minion-nrp1'
@@ -62,7 +62,11 @@ services:
       - type: bind
         source: .
         target: /tmp/salt_nornir/
-
+      # bind TTP Templates package for development
+      - type: bind
+        source: ../TTP_templates/ttp_templates
+        target: /usr/local/lib/python3.9/site-packages/ttp_templates/
+
   salt-minion-nrp2:
     container_name: salt-minion-nrp2
     hostname: 'salt-minion-nrp2'
@@ -93,7 +97,11 @@ services:
       - type: bind
         source: .
         target: /tmp/salt_nornir/
-
+      # bind TTP Templates package for development
+      - type: bind
+        source: ../TTP_templates/ttp_templates
+        target: /usr/local/lib/python3.9/site-packages/ttp_templates/
+
   salt-minion-nrp3:
     container_name: salt-minion-nrp3
     hostname: 'salt-minion-nrp3'
@@ -124,7 +132,11 @@ services:
       - type: bind
         source: .
         target: /tmp/salt_nornir/
-
+      # bind TTP Templates package for development
+      - type: bind
+        source: ../TTP_templates/ttp_templates
+        target: /usr/local/lib/python3.9/site-packages/ttp_templates/
+
   ceos1:
     container_name: ceos1
     hostname: 'ceos1'

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "salt_nornir"
-version = "0.16.0"
+version = "0.16.1"
 description = "Salt-Nornir Proxy Minion SaltStack Modules"
 authors = ["Denis Mulyalin <[email protected]>"]
 maintainers = ["Denis Mulyalin <[email protected]>"]
@@ -180,6 +180,9 @@ dataprocessor = [
     "xmltodict",
     "lxml"
 ]
+netbox = [
+    "pynetbox"
+]
 
 [tool.poetry.plugins."salt.loader"]
 "module_dirs" = "salt_nornir.loader:module_dirs"

salt_nornir/modules/nornir_proxy_execution_module.py

@@ -1091,6 +1091,7 @@ def task(task):
     model_exec_nr_do_action,
     model_exec_nr_snmp,
 )
+from salt_nornir.netbox_utils import netbox_tasks
 
 log = logging.getLogger(__name__)
 
@@ -2637,8 +2638,8 @@ def nornir_fun(fun, *args, **kwargs):
     * ``kill`` - executes immediate shutdown of Nornir Proxy Minion process and child processes
     * ``shutdown`` - gracefully shutdowns Nornir Proxy Minion process and child processes
     * ``inventory`` - interact with Nornir Process inventory data, using ``InventoryFun`` function,
-      by default, for ``read_host, read, read_inventory, list_hosts`` operations any Nornir worker
-      can respond, for other, non-read operations targets all Nornir workers
+      by default, for ``read_host, read, read_inventory, list_hosts, list_hosts_platforms`` operations any
+      Nornir worker can respond, for other, non-read operations targets all Nornir workers
     * ``stats`` - returns statistics about Nornir proxy process, accepts ``stat`` argument of stat
       name to return
     * ``version`` - returns a report of Nornir related packages installed versions
@@ -2696,7 +2697,13 @@ def nornir_fun(fun, *args, **kwargs):
     if fun == "inventory":
         kwargs.setdefault("call", args[0] if args else "read_inventory")
         # make sure by default targets all workers for non read operations
-        if kwargs["call"] not in ["read_host", "read", "read_inventory", "list_hosts"]:
+        if kwargs["call"] not in [
+            "read_host",
+            "read",
+            "read_inventory",
+            "list_hosts",
+            "list_hosts_platforms",
+        ]:
             kwargs.setdefault("worker", "all")
         return task(plugin="inventory", **kwargs)
     elif fun == "stats":
@@ -3024,7 +3031,22 @@ def netbox(*args, **kwargs):
         salt nrp1 nr.netbox sync_from FB="ceos1"
         salt nrp1 nr.netbox task="sync_to" FB="ceos1" via=prod
     """
-    kwargs["task_name"] = args[0] if args else kwargs.pop("task")
+    task_name = args[0] if args else kwargs.pop("task")
+    kwargs["task_name"] = task_name
+    if task_name in netbox_tasks:
+        ret = []
+        # get a list of tasks to execute
+        tasks_list = netbox_tasks[task_name]["tasks"](
+            hosts=nornir_fun("inventory", "list_hosts_platforms")
+        )
+        # execute tasks to retrieve data from hosts
+        for task_data in tasks_list:
+            ret.append(
+                globals()[task_data["fun"]](
+                    *task_data.get("args", []), **task_data.get("kwargs", {})
+                )
+            )
+        return ret
     return __proxy__["nornir.execute_job"](
         task_fun="nornir_salt.plugins.tasks.netbox_tasks",
         kwargs=kwargs,

salt_nornir/netbox_utils.py

@@ -0,0 +1,74 @@
+"""
+Netbox Utils
+============
+
+Collection of functions for Salt-Nornir to interact with Netbox.
+
+
+"""
+import logging
+import json
+import requests
+
+log = logging.getLogger(__name__)
+
+try:
+    import pynetbox
+
+    HAS_PYNETBOX = True
+except ImportError:
+    HAS_PYNETBOX = False
+
+
+def get_load_config_tasks(hosts: dict):
+    """
+    Function to produce a list of tasks to collect output from devices
+    for load_config function.
+
+    :param data: dictionary with Nornir Inventory data of hosts to produce tasks for
+    """
+    ret = []
+    platforms_added = set()
+    for host_name, platform in hosts.items():
+        task_kwargs = {}
+        if platform in platforms_added:
+            continue
+        elif platform in ["cisco_xr", "iosxr"]:
+            template = "ttp://misc/Netbox/parse_cisco_xr_config.txt"
+        elif platform in ["juniper_junos", "junos", "juniper"]:
+            template = "ttp://misc/Netbox/parse_juniper_junos_config.txt"
+        elif platform in ["arista_eos", "eos"]:
+            template = "ttp://misc/Netbox/parse_arista_eos_config.txt"
+            task_kwargs["enable"] = True
+        else:
+            log.info(
+                f"netbox_utils:get_load_config_tasks unsupported "
+                f"platform '{platform}', host name '{host_name}'"
+            )
+            continue
+        ret.append(
+            {
+                "fun": "cli",
+                "kwargs": {
+                    **task_kwargs,
+                    "FL": [h for h, p in hosts.items() if p == platform],
+                    "run_ttp": template,
+                    "ttp_structure": "dictionary",
+                },
+            }
+        )
+        platforms_added.add(platform)
+
+    return ret
+
+
+def load_config(data: dict):
+    """
+    Function to parse devices confgiuration and load it into Netbox device
+    confguration context.
+    """
+    pass
+
+
+# dispatch dictionary of Netbox tasks exposed for calling
+netbox_tasks = {"load_config": {"fun": load_config, "tasks": get_load_config_tasks}}

salt_nornir/pillar/salt_nornir_netbox.py

@@ -929,6 +929,7 @@ def _host_add_interfaces(device, host, params):
         intf_dict[intf.pop("name")] = intf
     # save data into Nornir host's inventory
     dk = host_add_interfaces if isinstance(host_add_interfaces, str) else "interfaces"
+    host.setdefault("data", {})
     host["data"][dk] = intf_dict
 
 
@@ -1016,6 +1017,7 @@ def _host_add_connections(device, host, params):
     cables_dict = {}
     while cables:
         cable = cables.pop()
+        # extract CableTerminationType items
         terminations = cable.pop("terminations")
         local_interface_index = None
         # map interface ID to interface data
@@ -1037,20 +1039,23 @@ def _host_add_connections(device, host, params):
                 f"salt_nornir_netbox '{device['name']}' device, failed to find local "
                 f"interface for connection '{cable}', terminations '{terminations}'"
             )
-
+        # extract interface termiantion
         local_interface = terminations.pop(local_interface_index)
         remote_interface = terminations.pop()
 
         cables_dict[local_interface["interface"]["name"]] = {
             **cable,
             "remote_device": remote_interface["_device"]["name"],
             "remote_interface": remote_interface["interface"]["name"],
+            "termination_type": local_interface["termination_type"]["model"],
+            "remote_termination_type": remote_interface["termination_type"]["model"],
         }
 
     # save data into Nornir host's inventory
     dk = (
         host_add_connections if isinstance(host_add_connections, str) else "connections"
     )
+    host.setdefault("data", {})
     host["data"][dk] = cables_dict
 
 

test/ceos1.cfg

@@ -24,6 +24,7 @@ username nornir privilege 15 secret sha512 $6$EkriX8oB5g3Midq4$ErOpqzIWT7FxiW1Ik
 interface Ethernet1
    no switchport
    ip address 10.0.1.4/24
+   mtu 9200
 !
 interface Loopback1
    ip address 1.1.1.1/24

test/ceos2.cfg

@@ -24,6 +24,7 @@ username nornir privilege 15 secret sha512 $6$EkriX8oB5g3Midq4$ErOpqzIWT7FxiW1Ik
 interface Ethernet1
    no switchport
    ip address 10.0.1.5/24
+   mtu 9200
 !
 interface Loopback100
    description MGMT Range xYz