Fix for isses #80, #102, #103.

Fix pydocstyle

Increase version to 1.3.0

Adds doc to restart NB svcs, Adds doc for install in venv

Onboarding process refactor

fix async task race condition

NetBox 2.9 support

expose onboarding details in device view

skip onboarding

update version to 2.0.0-beta1

Improve Logging for netdev_keeper.py

Fixes onboarding_extensions_map issue

The onboarding_extensions_map setting (specified in netbox_onboarding/__init__.py
or overridden in configuration.py) is used to map napalm driver names to a custom
class which extends the driver, allowing extensibility. Currently, when a mapping
doesn't exist for a napalm driver, the NetdevKeepr class's get_onboarding_facts()
method fails. This causes the rq-worker to be unable to run the onbaord_device()
function to onboard a device. The changes in this commit fix the issue.

Render right_page onboarding template correctly

Currently, the template_content.py DeviceContent class returns `None`
if onboarding is not enabled for an OnboardingDevice object. Likewise,
if no OnboardingDevice object exists, the template continues trying to
access attributes for an OnboardingDevice object. In the first case,
template rendering will fail as an empty string is needed in order
to insert nothing into the rendered HTML template presented to the user.
In the second case, an AttributeError is raised as you can not access
attributes of a NoneType object.

Enhance logging and error handling

Change version to 2.0.0-beta.2

Add NetBox's changelog model to OnboardingTask

documentation update

support to skip device type updates

Expose onboarding metrics on worker level

Changes for multiple criteria searching

Update version to 2.0.0

Optional arguments for NAPALM and Netmiko

Rebase

Rebase fix

Fixes for issues #80, #102, #103

Black reformatting

Platform option args removed

Rebase

Rebase fix

Fixes for issues #80, #102, #103

Fixes for issues #80, #102, #103

Author: dgarros

netbox_onboarding/__init__.py

@@ -44,6 +44,7 @@ class OnboardingConfig(PluginConfig):
         "platform_map": {},
         "onboarding_extensions_map": {"ios": "netbox_onboarding.onboarding_extensions.ios",},
         "object_match_strategy": "loose",
+        "netmiko_optional_args": {"timeout": 10, "session_timeout": 10, "auth_timeout": 10, "banner_timeout": 10},
     }
     caching_config = {}
 

netbox_onboarding/netdev_keeper.py

@@ -20,6 +20,7 @@
 from django.conf import settings
 from napalm import get_network_driver
 from napalm.base.exceptions import ConnectionException, CommandErrorException
+from napalm.base.netmiko_helpers import netmiko_args
 from netaddr.core import AddrFormatError
 from netmiko.ssh_autodetect import SSHDetect
 from netmiko.ssh_exception import NetMikoAuthenticationException
@@ -64,7 +65,15 @@ class NetdevKeeper:
     """Used to maintain information about the network device during the onboarding process."""
 
     def __init__(  # pylint: disable=R0913
-        self, hostname, port=None, timeout=None, username=None, password=None, secret=None, napalm_driver=None
+        self,
+        hostname,
+        port=None,
+        timeout=None,
+        username=None,
+        password=None,
+        secret=None,
+        napalm_driver=None,
+        optional_args=None,
     ):
         """Initialize the network device keeper instance and ensure the required configuration parameters are provided.
 
@@ -85,10 +94,11 @@ def __init__(  # pylint: disable=R0913
         self.hostname = hostname
         self.port = port
         self.timeout = timeout
-        self.username = username or settings.NAPALM_USERNAME
-        self.password = password or settings.NAPALM_PASSWORD
-        self.secret = secret or settings.NAPALM_ARGS.get("secret", None)
+        self.username = username
+        self.password = password
+        self.secret = secret
         self.napalm_driver = napalm_driver
+        self.optional_args = optional_args
 
         self.facts = None
         self.ip_ifs = None
@@ -162,14 +172,25 @@ def guess_netmiko_device_type(self):
         """Guess the device type of host, based on Netmiko."""
         guessed_device_type = None
 
+        netmiko_optional_args = netmiko_args(self.optional_args)
+
         remote_device = {
             "device_type": "autodetect",
             "host": self.hostname,
             "username": self.username,
             "password": self.password,
-            "secret": self.secret,
+            **netmiko_optional_args,
         }
 
+        if self.secret:
+            remote_device["secret"] = self.secret
+
+        if self.port:
+            remote_device["port"] = self.port
+
+        if self.timeout:
+            remote_device["timeout"] = self.timeout
+
         try:
             logger.info("INFO guessing device type: %s", self.hostname)
             guesser = SSHDetect(**remote_device)
@@ -246,8 +267,13 @@ def get_onboarding_facts(self):
             self.check_napalm_driver_name()
 
             driver = get_network_driver(self.napalm_driver)
-            optional_args = settings.NAPALM_ARGS.copy()
-            optional_args["secret"] = self.secret
+
+            optional_args = self.optional_args
+            if self.port:
+                optional_args["port"] = self.port
+
+            if self.secret:
+                optional_args["secret"] = self.secret
 
             napalm_device = driver(
                 hostname=self.hostname,

netbox_onboarding/onboard.py

@@ -12,6 +12,8 @@
 limitations under the License.
 """
 
+import json
+
 from django.conf import settings
 
 from .netdev_keeper import NetdevKeeper
@@ -34,6 +36,16 @@ def napalm_driver(self):
 
         return None
 
+    @property
+    def optional_args(self):
+        """Return platform optional args."""
+        if self.ot.platform and self.ot.platform.napalm_args:
+            napalm_args = json.loads(self.ot.platform.napalm_args)
+
+            return napalm_args
+
+        return {}
+
     @property
     def ip_address(self):
         """Return ot's ip address."""
@@ -86,10 +98,11 @@ def __init__(self, ot, username, password, secret):
             hostname=otm.ip_address,
             port=otm.port,
             timeout=otm.timeout,
-            username=self.username,
-            password=self.password,
-            secret=self.secret,
+            username=self.username or settings.NAPALM_USERNAME,
+            password=self.password or settings.NAPALM_PASSWORD,
+            secret=self.secret or otm.optional_args.get("secret", None) or settings.NAPALM_ARGS.get("secret", None),
             napalm_driver=otm.napalm_driver,
+            optional_args=otm.optional_args or settings.NAPALM_ARGS,
         )
 
         netdev.get_onboarding_facts()