support to skip device type updates

Author: mzbroch

README.md

@@ -66,6 +66,8 @@ The plugin behavior can be controlled with the following list of settings
 - `default_device_role_color` string (default FF0000), color assigned to the device role if it needs to be created.
 - `default_management_interface` string (default "PLACEHOLDER"), name of the management interface that will be created, if one can't be identified on the device.
 - `default_management_prefix_length` integer ( default 0), length of the prefix that will be used for the management IP address, if the IP can't be found.
+- `skip_device_type_on_update` boolean (default False), If True, an existing NetBox device will not get its device type updated. If False, device type will be updated with one discovered on a device.
+- `skip_manufacturer_on_update` boolean (default False), If True, an existing NetBox device will not get its manufacturer updated. If False, manufacturer will be updated with one discovered on a device.
 - `platform_map` (dictionary), mapping of an **auto-detected** Netmiko platform to the **NetBox slug** name of your Platform. The dictionary should be in the format:
     ```python
     {

netbox_onboarding/__init__.py

@@ -39,6 +39,8 @@ class OnboardingConfig(PluginConfig):
         "default_management_prefix_length": 0,
         "default_device_status": "active",
         "create_management_interface_if_missing": True,
+        "skip_device_type_on_update": False,
+        "skip_manufacturer_on_update": False,
         "platform_map": {},
         "onboarding_extensions_map": {"ios": "netbox_onboarding.onboarding_extensions.ios",},
     }

netbox_onboarding/netbox_keeper.py

@@ -97,9 +97,30 @@ def __init__(  # pylint: disable=R0913,R0914
         self.nb_platform = None
 
         self.device = None
+        self.onboarded_device = None
         self.nb_mgmt_ifname = None
         self.nb_primary_ip = None
 
+    def ensure_onboarded_device(self):
+        """Lookup if the device already exists in the NetBox.
+
+        Lookup is performed by querying for the IP address of the onboarded device.
+        If the device with a given IP is already in NetBox, its attributes including name could be updated
+        """
+        try:
+            if self.netdev_mgmt_ip_address:
+                self.onboarded_device = Device.objects.get(primary_ip4__address__net_host=self.netdev_mgmt_ip_address)
+        except Device.DoesNotExist:
+            logger.info(
+                "Could not find existing NetBox device for requested primary IP address (%s)",
+                self.netdev_mgmt_ip_address,
+            )
+        except Device.MultipleObjectsReturned:
+            raise OnboardException(
+                reason="fail-general",
+                message=f"ERROR multiple devices using same IP in NetBox: {self.netdev_mgmt_ip_address}",
+            )
+
     def ensure_device_site(self):
         """Ensure device's site."""
         try:
@@ -108,9 +129,17 @@ def ensure_device_site(self):
             raise OnboardException(reason="fail-config", message=f"Site not found: {self.netdev_nb_site_slug}")
 
     def ensure_device_manufacturer(
-        self, create_manufacturer=PLUGIN_SETTINGS["create_manufacturer_if_missing"],
+        self,
+        create_manufacturer=PLUGIN_SETTINGS["create_manufacturer_if_missing"],
+        skip_manufacturer_on_update=PLUGIN_SETTINGS["skip_manufacturer_on_update"],
     ):
         """Ensure device's manufacturer."""
+        # Support to skip manufacturer updates for existing devices
+        if self.onboarded_device and skip_manufacturer_on_update:
+            self.nb_manufacturer = self.onboarded_device.device_type.manufacturer
+
+            return
+
         # First ensure that the vendor, as extracted from the network device exists
         # in NetBox.  We need the ID for this vendor when ensuring the DeviceType
         # instance.
@@ -128,13 +157,15 @@ def ensure_device_manufacturer(
                 )
 
     def ensure_device_type(
-        self, create_device_type=PLUGIN_SETTINGS["create_device_type_if_missing"],
+        self,
+        create_device_type=PLUGIN_SETTINGS["create_device_type_if_missing"],
+        skip_device_type_on_update=PLUGIN_SETTINGS["skip_device_type_on_update"],
     ):
         """Ensure the Device Type (slug) exists in NetBox associated to the netdev "model" and "vendor" (manufacturer).
 
         Args:
-          #create_manufacturer (bool) :Flag to indicate if we need to create the manufacturer, if not already present
           create_device_type (bool): Flag to indicate if we need to create the device_type, if not already present
+          skip_device_type_on_update (bool): Flag to indicate if we skip device type updates for existing devices
         Raises:
           OnboardException('fail-config'):
             When the device vendor value does not exist as a Manufacturer in
@@ -145,6 +176,12 @@ def ensure_device_type(
             manufacturer.  This should *not* happen, but guard-rail checking
             regardless in case two vendors have the same model name.
         """
+        # Support to skip device type updates for existing devices
+        if self.onboarded_device and skip_device_type_on_update:
+            self.nb_device_type = self.onboarded_device.device_type
+
+            return
+
         # Now see if the device type (slug) already exists,
         #  if so check to make sure that it is not assigned as a different manufacturer
         # if it doesn't exist, create it if the flag 'create_device_type_if_missing' is defined
@@ -268,38 +305,16 @@ def ensure_device_instance(self, default_status=PLUGIN_SETTINGS["default_device_
         Args:
           default_status (str) : status assigned to a new device by default.
         """
-        # Lookup if the device already exists in the NetBox
-        # First update and creation lookup is by checking the IP address
-        # of the onboarded device.
-        #
-        # If the device with a given IP is already in NetBox,
-        # any attributes including name could be updated
-        onboarded_device = None
-
-        try:
-            if self.netdev_mgmt_ip_address:
-                onboarded_device = Device.objects.get(primary_ip4__address__net_host=self.netdev_mgmt_ip_address)
-        except Device.DoesNotExist:
-            logger.info(
-                "Could not find existing NetBox device for requested primary IP address (%s)",
-                self.netdev_mgmt_ip_address,
-            )
-        except Device.MultipleObjectsReturned:
-            raise OnboardException(
-                reason="fail-general",
-                message=f"ERROR multiple devices using same IP in NetBox: {self.netdev_mgmt_ip_address}",
-            )
-
-        if onboarded_device:
+        if self.onboarded_device:
             # Construct lookup arguments if onboarded device already exists in NetBox
 
             logger.info(
                 "Found existing NetBox device (%s) for requested primary IP address (%s)",
-                onboarded_device.name,
+                self.onboarded_device.name,
                 self.netdev_mgmt_ip_address,
             )
             lookup_args = {
-                "pk": onboarded_device.pk,
+                "pk": self.onboarded_device.pk,
                 "defaults": dict(
                     name=self.netdev_hostname,
                     device_type=self.nb_device_type,
@@ -362,6 +377,7 @@ def ensure_primary_ip(self):
 
     def ensure_device(self):
         """Ensure that the device represented by the DevNetKeeper exists in the NetBox system."""
+        self.ensure_onboarded_device()
         self.ensure_device_site()
         self.ensure_device_manufacturer()
         self.ensure_device_type()