Add napalm/netmiko extras support to plugin config

README.md

@@ -41,6 +41,18 @@ PLUGINS = ["nautobot_plugin_nornir"]
 
 PLUGINS_CONFIG = {
   "nautobot_plugin_nornir": {
+  "connection_options": {
+      "napalm": {
+          "extras": {
+              "optional_args": {"global_delay_factor": 1},
+          },
+      },
+      "netmiko": {
+          "extras": {
+              "global_delay_factor": 1,
+          },
+      },
+  },
     "nornir_settings": {
       "credentials": "nautobot_plugin_nornir.plugins.credentials.env_vars.CredentialsEnvVars",
       "runner": {
@@ -59,6 +71,18 @@ Alternatively you can use the `CredentialsSettingsVars` class to set the usernam
 PLUGINS_CONFIG = {
   "nautobot_plugin_nornir": {
     "nornir_settings": {
+  "connection_options": {
+      "napalm": {
+          "extras": {
+              "optional_args": {"global_delay_factor": 1},
+          },
+      },
+      "netmiko": {
+          "extras": {
+              "global_delay_factor": 1,
+          },
+      },
+  },
       "credentials": "nautobot_plugin_nornir.plugins.credentials.settings_vars.CredentialsSettingsVars",
       "runner": {
         "plugin": "threaded",
@@ -83,6 +107,7 @@ The plugin behavior can be controlled with the following list of settings.
 | username | ntc | N/A | The username when leveraging the `CredentialsSettingsVars` credential provider. |
 | password | password123 | N/A | The password when leveraging the `CredentialsSettingsVars` credential provider. |
 | secret | password123 | N/A | The secret password when leveraging the `CredentialsSettingsVars` credential provider, **placeholder only, not currently functioning**. |
+| connection_options | {"netmiko": {"extras": "global_delay_factor": 1}}} | N/A | Connection Options for the given plugin provider in use. |
 
 Finally, as root, restart Nautobot and the Nautobot worker.
 
@@ -108,7 +133,7 @@ The `dispatcher_mapping` configuration option can be set to extend or map the pl
 The above example demonstrates the following use cases.
 
 * Creating a custom only local dispatcher
-* Mapping a user defined and preffered platform slug name to expected driver (e.g. ios -> cisco_ios)
+* Mapping a user defined and preferred platform slug name to expected driver (e.g. ios -> cisco_ios)
 * Overloading platform slug keys, by mapping ios and ios_xe to the same class
 * Leveraging the existing "default" Netmiko driver
 
@@ -117,7 +142,7 @@ allow users to define their own mappings as described above.
 
 # Inventory
 
-The Nautobot ORM inventory is rather static in nature at this point. The user has the ability to define the `default` data. The native capabilites
+The Nautobot ORM inventory is rather static in nature at this point. The user has the ability to define the `default` data. The native capabilities
 include. 
 
 * Providing an object called within the `obj` key that is a Nautobot `Device` object instance.

development/nautobot_config.py

@@ -7,7 +7,6 @@
 from nautobot.core.settings import *  # noqa: F403
 from nautobot.core.settings_funcs import parse_redis_connection
 
-
 #
 # Misc. settings
 #
@@ -132,6 +131,18 @@
 # Each key in the dictionary is the name of an installed plugin and its value is a dictionary of settings.
 PLUGINS_CONFIG = {
     "nautobot_plugin_nornir": {
+        "connection_options": {
+            "napalm": {
+                "extras": {
+                    "optional_args": {"global_delay_factor": 1},
+                },
+            },
+            "netmiko": {
+                "extras": {
+                    "global_delay_factor": 1,
+                },
+            },
+        },
         "nornir_settings": {
             "credentials": "nautobot_plugin_nornir.plugins.credentials.env_vars.CredentialsEnvVars",
             "runner": {

nautobot_plugin_nornir/constants.py

@@ -12,3 +12,9 @@
 NORNIR_SETTINGS = PLUGIN_CFG.get("nornir_settings", _NORNIR_SETTINGS)
 
 DEFAULT_DRIVERS_MAPPING = PLUGIN_CFG.get("dispatcher_mapping", _DEFAULT_DRIVERS_MAPPING)
+
+CONNECTION_SECRETS_PATHS = {
+    "netmiko": "netmiko.extras.secret",
+    "napalm": "napalm.extras.optional_args.secret",
+    "scrapli": "scrapli.extras.auth_secondary",
+}

nautobot_plugin_nornir/plugins/inventory/nautobot_orm.py

@@ -5,21 +5,21 @@
 
 from django.db.models import QuerySet
 from django.utils.module_loading import import_string
-from nornir.core.inventory import (
-    Inventory,
-    ConnectionOptions,
-    Defaults,
-    Groups,
-    Host,
-    Hosts,
-    Group,
-    ParentGroups,
-)
-
 from nautobot.dcim.models import Device
+from nautobot_plugin_nornir.constants import CONNECTION_SECRETS_PATHS, PLUGIN_CFG
+from nornir.core.inventory import ConnectionOptions, Defaults, Group, Groups, Host, Hosts, Inventory, ParentGroups
 from nornir_nautobot.exceptions import NornirNautobotException
 
 
+def _set_dict_key_path(dictionary, key_path, value):
+    *keys, last_key = key_path.split(".")
+    pointer = dictionary
+    for key in keys:
+
+        pointer = pointer.setdefault(key, {})
+    pointer[last_key] = value
+
+
 def _set_host(data: Dict[str, Any], name: str, groups, host, defaults) -> Host:
     connection_option = {}
     for key, value in data.get("connection_options", {}).items():
@@ -145,14 +145,7 @@ def create_host(self, device, cred, params: Dict):
         Returns:
             dict: Nornir Host dictionnary
         """
-        host = {
-            "data": {
-                "connection_options": {
-                    "netmiko": {"extras": {}},
-                    "napalm": {"extras": {"optional_args": {}}},
-                },
-            },
-        }
+        host = {"data": {}}
         if "use_fqdn" in params and params.get("use_fqdn"):
             host["hostname"] = f"{device.name}.{params.get('fqdn')}"
         else:
@@ -165,9 +158,6 @@ def create_host(self, device, cred, params: Dict):
         if not device.platform:
             raise NornirNautobotException(f"Platform missing from device {device.name}")
         host["platform"] = device.platform.slug
-        if device.platform.napalm_driver:
-            host["data"]["connection_options"]["napalm"]["platform"] = device.platform.napalm_driver
-
         host["data"]["id"] = device.id
         host["data"]["type"] = device.device_type.slug
         host["data"]["site"] = device.site.slug
@@ -183,14 +173,34 @@ def create_host(self, device, cred, params: Dict):
         # require password for now
         host["password"] = password
 
-        # Use secret if specified.
-        # Netmiko
-        host["data"]["connection_options"]["netmiko"]["extras"]["secret"] = secret
-
-        # Napalm
-        host["data"]["connection_options"]["napalm"]["extras"]["optional_args"]["secret"] = secret
+        if PLUGIN_CFG.get("connection_options"):
+            for nornir_provider, nornir_options in PLUGIN_CFG["connection_options"].items():
+                if nornir_options.get("connection_secret_path"):
+                    secret_path = nornir_options.pop("connection_secret_path")
+                elif CONNECTION_SECRETS_PATHS.get(nornir_provider):
+                    secret_path = CONNECTION_SECRETS_PATHS["nornir_provider"]
+                else:
+                    continue
+                _set_dict_key_path(PLUGIN_CFG["connection_options"], secret_path, secret)
+        else:
+            # Supporting, but not documenting, and will be deprecated in nautobot-plugin-nornir 2.X
+            host["data"]["connection_options"] = {
+                "netmiko": {"extras": {}},
+                "napalm": {"extras": {"optional_args": {}}},
+            }
+            # Use secret if specified.
+            # Netmiko
+            host["data"]["connection_options"]["netmiko"]["extras"]["secret"] = secret
+
+            # Napalm
+            host["data"]["connection_options"]["napalm"]["extras"]["optional_args"]["secret"] = secret
 
         host["groups"] = self.get_host_groups(device=device)
+
+        if device.platform.napalm_driver:
+            if not host["data"]["connection_options"].get("napalm"):
+                host["data"]["connection_options"]["napalm"] = {}
+            host["data"]["connection_options"]["napalm"]["platform"] = device.platform.napalm_driver
         return host
 
     @staticmethod

nautobot_plugin_nornir/tests/inventory/test_nautobot_orm.py

@@ -2,7 +2,7 @@
 from unittest import skip
 
 from django.test import TestCase
-from nautobot.dcim.models import Device, Manufacturer, Site, DeviceType, DeviceRole
+from nautobot.dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Site
 from nautobot_plugin_nornir.plugins.inventory.nautobot_orm import NautobotORMInventory