Merge branch 'ltm-2.4' into u/smk4664-fix-vrfs

Author: smk4664

changes/484.added

@@ -0,0 +1 @@
+Added support for assigning a tenant to devices created by the SSOTSyncDevices job.

docs/images/sync_devices_inputs.png

@@ -21,7 +21,7 @@ To properly onboard a device, a user needs to provide, at a minimum:
 !!! note
     For DNS Name Resolution to work, the Celery instance of Nautobot must be able to resolve the name of the device to IP address.
 
-If `Platform`, `Device Type` and/or `Role` are not provided, the plugin will try to identify this information automatically and, based on the settings, it can create them in Nautobot as needed.
+If `Platform`, `Device Type` and/or `Role` are not provided, the plugin will try to identify this information automatically and, based on the settings, it can create them in Nautobot as needed. Optionally, a Tenant can be selected as part of the job inputs. When provided, the tenant will be assigned to newly onboarded devices during the sync process.
 
 !!! note
     The SSoT jobs use nornir-netmiko to run the show commands defined in the command mappers.

docs/user/app_use_cases.md

@@ -14,7 +14,7 @@ To properly onboard a device, a user needs to provide, at a minimum:
 !!! note
     For DNS Name Resolution to work, the instance of Nautobot must be able to resolve the name of the device to IP address.
 
-If other attributes (`Platform`, `Device Type`, `Role`) are provided in the onboarding job, the app will use provided value for the onboarded device.
+If other attributes (`Platform`, `Device Type`, `Role`) are provided in the onboarding job, the app will use provided value for the onboarded device. Optionally, a Tenant can be selected as part of the job inputs. When provided, the tenant will be assigned to newly onboarded devices during the sync process.
 
 If `Platform`, `Device Type` and/or `Role` are not provided, the plugin will try to identify this information automatically and, based on the settings, it can create them in Nautobot as needed.
 

docs/user/app_use_cases_original.md

@@ -126,6 +126,7 @@ def load_devices(self):
                 primary_ip4__status__name=(device.primary_ip4.status.name if device.primary_ip4 else ""),
                 role__name=device.role.name,
                 status__name=device.status.name,
+                tenant__name=device.tenant.name if device.tenant else None,
                 secrets_group__name=(device.secrets_group.name if device.secrets_group else ""),
                 interfaces=interfaces,
                 mask_length=(device.primary_ip4.mask_length if device.primary_ip4 else None),
@@ -302,6 +303,7 @@ def load_devices(self):
                 primary_ip4__status = job_form_attrs["ip_address_status"]
                 device_role = job_form_attrs["device_role"]
                 device_status = job_form_attrs["device_status"]
+                device_tenant = job_form_attrs["device_tenant"]
                 secrets_group = job_form_attrs["secrets_group"]
 
                 onboarding_device = self.device(
@@ -314,6 +316,7 @@ def load_devices(self):
                     primary_ip4__status__name=primary_ip4__status.name,
                     role__name=device_role.name,
                     status__name=device_status.name,
+                    tenant__name=device_tenant.name if device_tenant else None,
                     secrets_group__name=secrets_group.name,
                     interfaces=[self.device_data[ip_address]["mgmt_interface"]],
                     mask_length=int(self.device_data[ip_address]["mask_length"]),

nautobot_device_onboarding/diffsync/adapters/sync_devices_adapters.py

@@ -8,6 +8,7 @@
 from nautobot.dcim.models import Device, DeviceType, Interface, Manufacturer, Platform
 from nautobot.extras.models import Role, SecretsGroup, Status
 from nautobot.ipam.models import IPAddressToInterface
+from nautobot.tenancy.models import Tenant
 from nautobot_ssot.contrib import NautobotModel
 
 from nautobot_device_onboarding.utils import diffsync_utils
@@ -31,6 +32,7 @@ class SyncDevicesDevice(DiffSyncModel):
         "role__name",
         "secrets_group__name",
         "status__name",
+        "tenant__name",
         "interfaces",
     )
 
@@ -46,6 +48,7 @@ class SyncDevicesDevice(DiffSyncModel):
     role__name: Optional[str] = None
     secrets_group__name: Optional[str] = None
     status__name: Optional[str] = None
+    tenant__name: Optional[str] = None
 
     interfaces: Optional[list] = None
 
@@ -85,6 +88,7 @@ def _get_or_create_device(cls, adapter, ids, attrs):
             device = Device(
                 location=location,
                 status=job_form_attrs["device_status"],
+                tenant=job_form_attrs["device_tenant"],
                 role=job_form_attrs["device_role"],
                 device_type=DeviceType.objects.get(model=attrs["device_type__model"]),
                 name=ids["name"],
@@ -228,6 +232,8 @@ def update(self, attrs):
             device.role = Role.objects.get(name=attrs.get("role__name"))
         if attrs.get("status__name"):
             device.status = Status.objects.get(name=attrs.get("status__name"))
+        if attrs.get("tenant__name"):
+            device.tenant = Tenant.objects.get(name=attrs.get("tenant__name"))
         if attrs.get("secrets_group__name"):
             device.secrets_group = SecretsGroup.objects.get(name=attrs.get("secrets_group__name"))
 

nautobot_device_onboarding/diffsync/models/sync_devices_models.py

@@ -36,6 +36,7 @@
     Status,
 )
 from nautobot.ipam.models import Namespace
+from nautobot.tenancy.models import Tenant
 from nautobot_plugin_nornir.constants import NORNIR_SETTINGS
 from nautobot_ssot.jobs.base import DataSource
 from nornir import InitNornir
@@ -337,6 +338,11 @@ class Meta:
         required=False,
         description="Device platform. Define ONLY to override auto-recognition of platform.",
     )
+    device_tenant = ObjectVar(
+        model=Tenant,
+        required=False,
+        description="Tenant to be applied to all synced devices.",
+    )
 
     template_name = "nautobot_device_onboarding/ssot_sync_devices.html"
 
@@ -398,6 +404,13 @@ def _process_csv_data(self, csv_file):
                 device_status = Status.objects.get(
                     name=row["device_status_name"].strip(),
                 )
+                if row.get("device_tenant_name"):
+                    query = f"device_tenant: {row.get('device_tenant_name')}"
+                    device_tenant = Tenant.objects.get(
+                        name=row["device_tenant_name"].strip(),
+                    )
+                else:
+                    device_tenant = None
                 query = f"interface_status: {row.get('interface_status_name')}"
                 interface_status = Status.objects.get(
                     name=row["interface_status_name"].strip(),
@@ -437,6 +450,7 @@ def _process_csv_data(self, csv_file):
                     "update_devices_without_primary_ip": update_devices_without_primary_ip,
                     "device_role": device_role,
                     "device_status": device_status,
+                    "device_tenant": device_tenant,
                     "interface_status": interface_status,
                     "ip_address_status": ip_address_status,
                     "secrets_group": secrets_group,
@@ -495,6 +509,7 @@ def run(  # pylint: disable=too-many-positional-arguments
         ip_addresses=None,
         device_role=None,
         device_status=None,
+        device_tenant=None,
         interface_status=None,
         ip_address_status=None,
         secrets_group=None,
@@ -541,6 +556,7 @@ def run(  # pylint: disable=too-many-positional-arguments
                 "namespace": namespace,
                 "device_role": device_role,
                 "device_status": device_status,
+                "device_tenant": device_tenant,
                 "interface_status": interface_status,
                 "ip_address_status": ip_address_status,
                 "set_mgmt_only": set_mgmt_only,

nautobot_device_onboarding/jobs.py

@@ -3,7 +3,7 @@
 
 {% block job_form %}
 
-{% render_form job_form excluded_fields="['location', 'namespace', 'ip_addresses', 'device_role', 'device_status', 'interface_status', 'ip_address_status', 'port', 'timeout', 'secrets_group', 'platform', 'set_mgmt_only', 'update_devices_without_primary_ip', 'csv_file']" %}
+{% render_form job_form excluded_fields="['location', 'namespace', 'ip_addresses', 'device_role', 'device_status', 'interface_status', 'ip_address_status', 'port', 'timeout', 'secrets_group', 'platform', 'device_tenant', 'set_mgmt_only', 'update_devices_without_primary_ip', 'csv_file']" %}
 
     {% with csv_tab_active=form.initial.csv_input %}
     <ul class="nav nav-tabs" role="tablist">
@@ -29,6 +29,7 @@
             {% render_field job_form.ip_address_status %}
             {% render_field job_form.secrets_group %}
             {% render_field job_form.platform %}
+            {% render_field job_form.device_tenant %}
         </div>
         <div id="job_csv_input" class="tab-pane{% if csv_tab_active %} active{% endif %}">
             {% render_field job_form.csv_file %}

nautobot_device_onboarding/templates/nautobot_device_onboarding/ssot_sync_devices.html

@@ -1,4 +1,4 @@
-ip_address_host,location_parent_name,location_name,namespace,port,timeout,set_mgmt_only,update_devices_without_primary_ip,device_role_name,device_status_name,interface_status_name,ip_address_status_name,secrets_group_name,platform_name
-10.1.1.10,Site A Parent,Site A,Global,22,30,TRUE,TRUE,Network,Active,Active,Active,test secrets group,cisco_ios
-10.1.1.11,Site B Parent,Site B,Global,22,30,FALSE,FALSE,Network,Active,Active,Active,test secrets group,cisco_ios
-10.1.1.12,,Site A Parent,Global,22,30,FALSE,FALSE,Network,Active,Active,Active,test secrets group,cisco_ios
+ip_address_host,location_parent_name,location_name,namespace,port,timeout,set_mgmt_only,update_devices_without_primary_ip,device_role_name,device_status_name,interface_status_name,ip_address_status_name,secrets_group_name,platform_name,device_tenant_name
+10.1.1.10,Site A Parent,Site A,Global,22,30,TRUE,TRUE,Network,Active,Active,Active,test secrets group,cisco_ios,Device Tenant 1
+10.1.1.11,Site B Parent,Site B,Global,22,30,FALSE,FALSE,Network,Active,Active,Active,test secrets group,cisco_ios,
+10.1.1.12,,Site A Parent,Global,22,30,FALSE,FALSE,Network,Active,Active,Active,test secrets group,cisco_ios,

nautobot_device_onboarding/tests/fixtures/onboarding_csv_fixture.csv

@@ -51,6 +51,7 @@ def test_sync_devices__success(self, device_data):
             "update_devices_without_primary_ip": True,
             "device_role": self.testing_objects["device_role"].pk,
             "device_status": self.testing_objects["status"].pk,
+            "device_tenant": self.testing_objects["device_tenant_1"].pk,
             "interface_status": self.testing_objects["status"].pk,
             "ip_address_status": self.testing_objects["status"].pk,
             "secrets_group": self.testing_objects["secrets_group"].pk,
@@ -100,6 +101,7 @@ def test_process_csv_data(self):
         self.assertEqual(processed_csv_data["10.1.1.10"]["update_devices_without_primary_ip"], True)
         self.assertEqual(processed_csv_data["10.1.1.10"]["device_role"], self.testing_objects["device_role"])
         self.assertEqual(processed_csv_data["10.1.1.10"]["device_status"], self.testing_objects["status"])
+        self.assertEqual(processed_csv_data["10.1.1.10"]["device_tenant"], self.testing_objects["device_tenant_1"])
         self.assertEqual(processed_csv_data["10.1.1.10"]["interface_status"], self.testing_objects["status"])
         self.assertEqual(processed_csv_data["10.1.1.10"]["ip_address_status"], self.testing_objects["status"])
         self.assertEqual(processed_csv_data["10.1.1.10"]["secrets_group"], self.testing_objects["secrets_group"])