Merge pull request #38 from networktocode/dga-issue-35

Add default color for device_role

Author: dgarros

README.md

@@ -33,7 +33,10 @@ The plugin behavior can be controlled with the following list of settings
 - `create_device_type_if_missing` boolean (default True), If True, a new device type object will be created if the model discovered by Napalm do not match an existing device type.
 - `create_manufacturer_if_missing` boolean (default True), If True, a new manufacturer object will be created if the manufacturer discovered by Napalm is do not match an existing manufacturer, this option is only valid if `create_device_type_if_missing` is True as well.
 - `create_device_role_if_missing` boolean (default True), If True, a new device role object will be created if the device role provided was not provided as part of the onboarding and if the `default_device_role` do not already exist. 
-- `default_device_role` string  (default "network")
+- `default_device_role` string (default "network")
+- `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.
 
 ## Usage
 ### Preparation

netbox_onboarding/__init__.py

@@ -33,6 +33,7 @@ class OnboardingConfig(PluginConfig):
         "create_device_type_if_missing": True,
         "create_device_role_if_missing": True,
         "default_device_role": "network",
+        "default_device_role_color": "FF0000",
         "default_management_interface": "PLACEHOLDER",
         "default_management_prefix_length": 0,
     }

netbox_onboarding/onboard.py

@@ -386,12 +386,14 @@ def ensure_device_role(
         self,
         create_device_role=PLUGIN_SETTINGS["create_device_role_if_missing"],
         default_device_role=PLUGIN_SETTINGS["default_device_role"],
+        default_device_role_color=PLUGIN_SETTINGS["default_device_role_color"],
     ):
         """Ensure that the device role is defined / exist in NetBox or create it if it doesn't exist.
 
         Args:
           create_device_role (bool) :Flag to indicate if we need to create the device_role, if not already present
           default_device_role (str): Default value for the device_role, if we need to create it
+          default_device_role_color (str): Default color to assign to the device_role, if we need to create it
         Raises:
           OnboardException('fail-config'):
             When the device role value does not exist
@@ -408,7 +410,12 @@ def ensure_device_role(
                     reason="fail-config", message=f"ERROR device role not found: {default_device_role}"
                 )
 
-            device_role = DeviceRole.objects.create(name=default_device_role, slug=slugify(default_device_role))
+            device_role = DeviceRole.objects.create(
+                name=default_device_role,
+                slug=slugify(default_device_role),
+                color=default_device_role_color,
+                vm_role=False,
+            )
             device_role.save()
 
         self.netdev.ot.role = device_role