Credentials attribute in onboarding class

Author: mzbroch

netbox_onboarding/netdev_keeper.py

@@ -107,46 +107,6 @@ def __init__(  # pylint: disable=R0913
         # Enable loading driver extensions
         self.load_driver_extension = True
 
-    def check_ip(self):
-        """Method to check if the IP address form field was an IP address.
-
-        If it is a DNS name, attempt to resolve the DNS address and assign the IP address to the
-        name.
-
-        Returns:
-            (bool): True if the IP address is an IP address, or a DNS entry was found and
-                    reassignment of the ot.ip_address was done.
-                    False if unable to find a device IP (error)
-
-        Raises:
-          OnboardException("fail-general"):
-            When a prefix was entered for an IP address
-          OnboardException("fail-dns"):
-            When a Name lookup via DNS fails to resolve an IP address
-        """
-        try:
-            # Assign checked_ip to None for error handling
-            # If successful, this is an IP address and can pass
-            checked_ip = netaddr.IPAddress(self.hostname)
-            return True
-        # Catch when someone has put in a prefix address, raise an exception
-        except ValueError:
-            raise OnboardException(
-                reason="fail-general", message=f"ERROR appears a prefix was entered: {self.hostname}"
-            )
-        # An AddrFormatError exception means that there is not an IP address in the field, and should continue on
-        except AddrFormatError:
-            try:
-                # Do a lookup of name to get the IP address to connect to
-                checked_ip = socket.gethostbyname(self.hostname)
-                self.hostname = checked_ip
-                return True
-            except socket.gaierror:
-                # DNS Lookup has failed, Raise an exception for unable to complete DNS lookup
-                raise OnboardException(
-                    reason="fail-dns", message=f"ERROR failed to complete DNS lookup: {self.hostname}"
-                )
-
     def check_reachability(self):
         """Ensure that the device at the mgmt-ipaddr provided is reachable.
 

netbox_onboarding/onboard.py

@@ -87,20 +87,20 @@ class OnboardingManager:
 
     def __init__(self, ot, username, password, secret):
         """Inits class."""
-        self.username = username
-        self.password = password
-        self.secret = secret
-
         # Create instance of Onboarding Task Manager class:
         otm = OnboardingTaskManager(ot)
 
+        self.username = username or settings.NAPALM_USERNAME
+        self.password = password or settings.NAPALM_PASSWORD
+        self.secret = secret or otm.optional_args.get("secret", None) or settings.NAPALM_ARGS.get("secret", None)
+
         netdev = NetdevKeeper(
             hostname=otm.ip_address,
             port=otm.port,
             timeout=otm.timeout,
-            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),
+            username=self.username,
+            password=self.password,
+            secret=self.secret,
             napalm_driver=otm.napalm_driver,
             optional_args=otm.optional_args or settings.NAPALM_ARGS,
         )
@@ -129,6 +129,7 @@ def __init__(self, ot, username, password, secret):
         }
 
         onboarding_cls = netdev_dict["onboarding_class"]()
+        onboarding_cls.credentials = {"username": self.username, "password": self.password, "secret": self.secret}
         onboarding_cls.run(onboarding_kwargs=onboarding_kwargs)
 
         self.created_device = onboarding_cls.created_device

netbox_onboarding/onboarding/onboarding.py

@@ -21,6 +21,7 @@ class Onboarding:
     def __init__(self):
         """Init the class."""
         self.created_device = None
+        self.credentials = None
 
     def run(self, onboarding_kwargs):
         """Implement run method."""