nautobot 2.3.15b1__py3-none-any.whl → 2.4.0__py3-none-any.whl

nautobot/dcim/models/devices.py

@@ -9,16 +9,17 @@ from django.db import models
 from django.db.models import F, ProtectedError, Q
 from django.urls import reverse
 from django.utils.functional import cached_property, classproperty
-from django.utils.html import format_html
+from django.utils.html import format_html, format_html_join
 import yaml
 
 from nautobot.core.constants import CHARFIELD_MAX_LENGTH
 from nautobot.core.models import BaseManager, RestrictedQuerySet
-from nautobot.core.models.fields import NaturalOrderingField
+from nautobot.core.models.fields import JSONArrayField, NaturalOrderingField
 from nautobot.core.models.generics import BaseModel, OrganizationalModel, PrimaryModel
 from nautobot.core.models.tree_queries import TreeModel
 from nautobot.core.utils.config import get_settings_or_config
 from nautobot.dcim.choices import (
+    ControllerCapabilitiesChoices,
     DeviceFaceChoices,
     DeviceRedundancyGroupFailoverStrategyChoices,
     SoftwareImageFileHashingAlgorithmChoices,
@@ -50,9 +51,11 @@ __all__ = (
     "DeviceFamily",
     "DeviceRedundancyGroup",
     "DeviceType",
+    "InterfaceVDCAssignment",
     "Manufacturer",
     "Platform",
     "VirtualChassis",
+    "VirtualDeviceContext",
 )
 
 
@@ -821,6 +824,7 @@ class Device(PrimaryModel, ConfigContextModel):
 
         # If any software image file is specified, validate that
         # each of the software image files belongs to the device's device type or is a default image
+        # TODO: this is incorrect as we cannot validate a ManyToMany during clean() - nautobot/nautobot#6344
         for image_file in self.software_image_files.all():
             if not image_file.default_image and self.device_type not in image_file.device_types.all():
                 raise ValidationError(
@@ -1365,6 +1369,12 @@ class Controller(PrimaryModel):
         null=True,
     )
     role = RoleField(blank=True, null=True)
+    capabilities = JSONArrayField(
+        base_field=models.CharField(choices=ControllerCapabilitiesChoices),
+        blank=True,
+        null=True,
+        help_text="List of capabilities supported by the controller, these capabilities are used to enhance views in Nautobot.",
+    )
     tenant = models.ForeignKey(
         to="tenancy.Tenant",
         on_delete=models.PROTECT,
@@ -1416,6 +1426,11 @@ class Controller(PrimaryModel):
                     {"location": f'Devices may not associate to locations of type "{self.location.location_type}".'}
                 )
 
+    def get_capabilities_display(self):
+        if not self.capabilities:
+            return format_html('<span class="text-muted">&mdash;</span>')
+        return format_html_join(" ", '<span class="label label-default">{}</span>', ((v,) for v in self.capabilities))
+
 
 @extras_features(
     "custom_links",
@@ -1435,6 +1450,7 @@ class ControllerManagedDeviceGroup(TreeModel, PrimaryModel):
         unique=True,
         help_text="Name of the controller device group",
     )
+    description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
     weight = models.PositiveIntegerField(
         default=1000,
         help_text="Weight of the controller device group, used to sort the groups within its parent group",
@@ -1447,6 +1463,33 @@ class ControllerManagedDeviceGroup(TreeModel, PrimaryModel):
         null=False,
         help_text="Controller that manages the devices in this group",
     )
+    radio_profiles = models.ManyToManyField(
+        to="wireless.RadioProfile",
+        related_name="controller_managed_device_groups",
+        through="wireless.ControllerManagedDeviceGroupRadioProfileAssignment",
+        through_fields=("controller_managed_device_group", "radio_profile"),
+        blank=True,
+    )
+    wireless_networks = models.ManyToManyField(
+        to="wireless.WirelessNetwork",
+        related_name="controller_managed_device_groups",
+        through="wireless.ControllerManagedDeviceGroupWirelessNetworkAssignment",
+        through_fields=("controller_managed_device_group", "wireless_network"),
+        blank=True,
+    )
+    capabilities = JSONArrayField(
+        base_field=models.CharField(choices=ControllerCapabilitiesChoices),
+        blank=True,
+        null=True,
+        help_text="List of capabilities supported by the controller device group, these capabilities are used to enhance views in Nautobot.",
+    )
+    tenant = models.ForeignKey(
+        to="tenancy.Tenant",
+        on_delete=models.PROTECT,
+        related_name="controller_managed_device_groups",
+        blank=True,
+        null=True,
+    )
 
     class Meta:
         ordering = ("weight",)
@@ -1466,11 +1509,16 @@ class ControllerManagedDeviceGroup(TreeModel, PrimaryModel):
         if self.controller == self._original_controller and self.parent == self._original_parent:
             return
 
-        if self.parent and self.controller and self.controller != self.parent.controller:
+        if self.parent and self.controller and self.controller != self.parent.controller:  # pylint: disable=no-member
             raise ValidationError(
                 {"controller": "Controller device group must have the same controller as the parent group."}
             )
 
+    def get_capabilities_display(self):
+        if not self.capabilities:
+            return format_html('<span class="text-muted">&mdash;</span>')
+        return format_html_join(" ", '<span class="label label-default">{}</span>', ((v,) for v in self.capabilities))
+
 
 #
 # Modules
@@ -1839,3 +1887,133 @@ class Module(PrimaryModel):
         Return the set of child Modules installed in ModuleBays within this Module.
         """
         return Module.objects.filter(parent_module_bay__parent_module=self)
+
+
+#
+# Virtual Device Contexts
+#
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+    "statuses",
+    "webhooks",
+)
+class VirtualDeviceContext(PrimaryModel):
+    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH)
+    device = models.ForeignKey("dcim.Device", on_delete=models.CASCADE, related_name="virtual_device_contexts")
+    identifier = models.PositiveSmallIntegerField(
+        help_text="Unique identifier provided by the platform being virtualized (Example: Nexus VDC Identifier)",
+        blank=True,
+        null=True,
+    )
+    status = StatusField(blank=False, null=False)
+    role = RoleField(blank=True, null=True)
+    primary_ip4 = models.ForeignKey(
+        to="ipam.IPAddress",
+        on_delete=models.SET_NULL,
+        related_name="ip4_vdcs",
+        blank=True,
+        null=True,
+        verbose_name="Primary IPv4",
+    )
+    primary_ip6 = models.ForeignKey(
+        to="ipam.IPAddress",
+        on_delete=models.SET_NULL,
+        related_name="ip6_vdcs",
+        blank=True,
+        null=True,
+        verbose_name="Primary IPv6",
+    )
+    tenant = models.ForeignKey(
+        "tenancy.Tenant", on_delete=models.CASCADE, related_name="virtual_device_contexts", blank=True, null=True
+    )
+    interfaces = models.ManyToManyField(
+        blank=True,
+        related_name="virtual_device_contexts",
+        to="dcim.Interface",
+        through="dcim.InterfaceVDCAssignment",
+    )
+    description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
+
+    class Meta:
+        ordering = ("name",)
+        unique_together = (("device", "identifier"), ("device", "name"))
+
+    def __str__(self):
+        return self.name
+
+    @property
+    def primary_ip(self):
+        if get_settings_or_config("PREFER_IPV4") and self.primary_ip4:
+            return self.primary_ip4
+        elif self.primary_ip6:
+            return self.primary_ip6
+        elif self.primary_ip4:
+            return self.primary_ip4
+        else:
+            return None
+
+    def validate_primary_ips(self):
+        for field in ["primary_ip4", "primary_ip6"]:
+            ip = getattr(self, field)
+            if ip is not None:
+                if field == "primary_ip4" and ip.ip_version != 4:
+                    raise ValidationError({f"{field}": f"{ip} is not an IPv4 address."})
+                if field == "primary_ip6" and ip.ip_version != 6:
+                    raise ValidationError({f"{field}": f"{ip} is not an IPv6 address."})
+                if not ip.interfaces.filter(device=self.device).exists():
+                    raise ValidationError(
+                        {f"{field}": f"{ip} is not part of an interface that belongs to this VDC's device."}
+                    )
+                # Note: The validation for primary IPs `validate_primary_ips` is commented out due to the order in which Django processes form validation with
+                # Many-to-Many (M2M) fields. During form saving, Django creates the instance first before assigning the M2M fields (in this case, interfaces).
+                # As a result, the primary_ips fields could fail validation at this point because the interfaces are not yet linked to the instance,
+                # leading to validation errors.
+                # interfaces = self.interfaces.all()
+                # if IPAddressToInterface.objects.filter(ip_address=ip, interface__in=interfaces).exists():
+                #     pass
+                # elif (
+                #     ip.nat_inside is None
+                #     or not IPAddressToInterface.objects.filter(
+                #         ip_address=ip.nat_inside, interface__in=interfaces
+                #     ).exists()
+                # ):
+                #     raise ValidationError(
+                #         {f"{field}": f"The specified IP address ({ip}) is not assigned to this Virtual Device Context."}
+                #     )
+
+    def clean(self):
+        super().clean()
+        self.validate_primary_ips()
+
+        # Validate that device is not being modified
+        if self.present_in_database:
+            vdc = VirtualDeviceContext.objects.get(id=self.id)
+            if vdc.device != self.device:
+                raise ValidationError({"device": "Virtual Device Context's device cannot be changed once created"})
+
+
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+)
+class InterfaceVDCAssignment(BaseModel):
+    virtual_device_context = models.ForeignKey(
+        VirtualDeviceContext, on_delete=models.CASCADE, related_name="interface_assignments"
+    )
+    interface = models.ForeignKey(
+        Interface, on_delete=models.CASCADE, related_name="virtual_device_context_assignments"
+    )
+
+    class Meta:
+        unique_together = ["virtual_device_context", "interface"]
+        ordering = ["virtual_device_context", "interface"]
+
+    def __str__(self):
+        return f"{self.virtual_device_context}: {self.interface}"

nautobot/dcim/models/locations.py

@@ -283,7 +283,7 @@ class Location(TreeModel, PrimaryModel):
             # We shouldn't have a parent, *unless* our own location type is permitted to be nested.
             if self.parent is not None:
                 if self.location_type.nestable:
-                    if self.parent.location_type != self.location_type:
+                    if self.parent.location_type != self.location_type:  # pylint: disable=no-member
                         raise ValidationError(
                             {
                                 "parent": f"A Location of type {self.location_type} may only have "
@@ -304,7 +304,7 @@ class Location(TreeModel, PrimaryModel):
 
             # Is the parent location of a correct type?
             if self.location_type.nestable:
-                if self.parent.location_type not in (self.location_type, self.location_type.parent):
+                if self.parent.location_type not in (self.location_type, self.location_type.parent):  # pylint: disable=no-member
                     raise ValidationError(
                         {
                             "parent": f"A Location of type {self.location_type} can only have a Location "
@@ -312,7 +312,7 @@ class Location(TreeModel, PrimaryModel):
                         }
                     )
             else:
-                if self.parent.location_type != self.location_type.parent:
+                if self.parent.location_type != self.location_type.parent:  # pylint: disable=no-member
                     raise ValidationError(
                         {
                             "parent": f"A Location of type {self.location_type} can only have a Location "

nautobot/dcim/models/power.py

@@ -73,11 +73,11 @@ class PowerPanel(PrimaryModel):
         if self.rack_group:
             if (
                 self.location is not None
-                and self.rack_group.location is not None
-                and self.rack_group.location not in self.location.ancestors(include_self=True)
+                and self.rack_group.location is not None  # pylint: disable=no-member
+                and self.rack_group.location not in self.location.ancestors(include_self=True)  # pylint: disable=no-member
             ):
                 raise ValidationError(
-                    {
+                    {  # pylint: disable=no-member  # false positive on rack_group.location
                         "rack_group": f'Rack group "{self.rack_group}" belongs to a location '
                         f'("{self.rack_group.location}") that does not contain "{self.location}".'
                     }
@@ -151,9 +151,10 @@ class PowerFeed(PrimaryModel, PathEndpoint, CableTermination):
         super().clean()
 
         # Rack must belong to same Location as PowerPanel
-        if self.rack and self.rack.location != self.power_panel.location:
+        if self.rack and self.rack.location != self.power_panel.location:  # pylint: disable=no-member
             raise ValidationError(
-                f"Rack {self.rack} ({self.rack.location}) and power panel {self.power_panel} ({self.power_panel.location}) are in different locations"
+                f"Rack {self.rack} ({self.rack.location}) and "  # pylint: disable=no-member
+                f"power panel {self.power_panel} ({self.power_panel.location}) are in different locations"
             )
 
         # AC voltage cannot be negative

nautobot/dcim/models/racks.py

@@ -77,11 +77,11 @@ class RackGroup(TreeModel, OrganizationalModel):
         # Parent RackGroup (if any) must belong to the same or ancestor Location
         if (
             self.parent is not None
-            and self.parent.location is not None
-            and self.parent.location not in self.location.ancestors(include_self=True)
+            and self.parent.location is not None  # pylint: disable=no-member
+            and self.parent.location not in self.location.ancestors(include_self=True)  # pylint: disable=no-member
         ):
             raise ValidationError(
-                {
+                {  # pylint: disable=no-member  # false positive on parent.location
                     "location": f'Location "{self.location}" is not descended from '
                     f'parent rack group "{self.parent}" location "{self.parent.location}".'
                 }
@@ -296,7 +296,7 @@ class Rack(PrimaryModel):
             # Determine which devices the user has permission to view
             permitted_device_ids = []
             if user is not None:
-                permitted_device_ids = self.devices.restrict(user, "view").values_list("pk", flat=True)
+                permitted_device_ids = self.devices.restrict(user, "view").values_list("pk", flat=True)  # pylint: disable=no-member
 
             for device in queryset:
                 if expand_devices:
@@ -391,9 +391,9 @@ class Rack(PrimaryModel):
             Defaults to True, showing device full name and hiding truncated.
         """
         if unit_width is None:
-            unit_width = get_settings_or_config("RACK_ELEVATION_DEFAULT_UNIT_WIDTH")
+            unit_width = get_settings_or_config("RACK_ELEVATION_DEFAULT_UNIT_WIDTH", fallback=230)
         if unit_height is None:
-            unit_height = get_settings_or_config("RACK_ELEVATION_DEFAULT_UNIT_HEIGHT")
+            unit_height = get_settings_or_config("RACK_ELEVATION_DEFAULT_UNIT_HEIGHT", fallback=22)
         elevation = RackElevationSVG(
             self, user=user, include_images=include_images, base_url=base_url, display_fullname=display_fullname
         )

nautobot/dcim/navigation.py

@@ -1,7 +1,4 @@
 from nautobot.core.apps import (
-    NavContext,
-    NavGrouping,
-    NavItem,
     NavMenuAddButton,
     NavMenuGroup,
     NavMenuItem,
@@ -188,6 +185,22 @@ menu_items = (
                             ),
                         ),
                     ),
+                    NavMenuItem(
+                        link="dcim:virtualdevicecontext_list",
+                        name="Virtual Device Contexts",
+                        weight=700,
+                        permissions=[
+                            "dcim.view_virtualdevicecontext",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="dcim:virtualdevicecontext_add",
+                                permissions=[
+                                    "dcim.add_virtualdevicecontext",
+                                ],
+                            ),
+                        ),
+                    ),
                 ),
             ),
             NavMenuGroup(
@@ -358,11 +371,19 @@ menu_items = (
                     ),
                     NavMenuItem(
                         link="dcim:controllermanageddevicegroup_list",
-                        name="Managed Device Groups",
+                        name="Device Groups",
                         weight=200,
                         permissions=[
                             "dcim.view_controllermanageddevicegroup",
                         ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="dcim:controllermanageddevicegroup_add",
+                                permissions=[
+                                    "dcim.add_controllermanageddevicegroup",
+                                ],
+                            ),
+                        ),
                     ),
                 ),
             ),
@@ -551,223 +572,3 @@ menu_items = (
         ),
     ),
 )
-
-
-navigation = (
-    NavContext(
-        name="Inventory",
-        groups=(
-            NavGrouping(
-                name="Devices",
-                weight=100,
-                items=(
-                    NavItem(
-                        name="Devices",
-                        link="dcim:device_list",
-                        weight=100,
-                        permissions=["dcim.view_device"],
-                    ),
-                    NavItem(
-                        name="Device Types",
-                        weight=200,
-                        link="dcim:devicetype_list",
-                        permissions=["dcim.view_devicetype"],
-                    ),
-                    NavItem(
-                        link="dcim:platform_list",
-                        name="Platforms",
-                        weight=300,
-                        permissions=[
-                            "dcim.view_platform",
-                        ],
-                    ),
-                    NavItem(
-                        link="dcim:manufacturer_list",
-                        name="Manufacturers",
-                        weight=400,
-                        permissions=[
-                            "dcim.view_manufacturer",
-                        ],
-                    ),
-                    NavItem(
-                        link="dcim:virtualchassis_list",
-                        name="Virtual Chassis",
-                        weight=500,
-                        permissions=[
-                            "dcim.view_virtualchassis",
-                        ],
-                    ),
-                    NavItem(
-                        name="Device Redundancy Groups",
-                        weight=600,
-                        link="dcim:deviceredundancygroup_list",
-                        permissions=["dcim.view_deviceredundancygroup"],
-                    ),
-                    NavGrouping(
-                        name="Connections",
-                        weight=700,
-                        items=(
-                            NavItem(
-                                name="Cables",
-                                weight=100,
-                                link="dcim:cable_list",
-                                permissions=["dcim.view_cable"],
-                            ),
-                            NavItem(
-                                name="Console Connections",
-                                weight=200,
-                                link="dcim:console_connections_list",
-                                permissions=[
-                                    "dcim.view_consoleport",
-                                    "dcim.view_consoleserverport",
-                                ],
-                            ),
-                            NavItem(
-                                name="Power Connections",
-                                weight=300,
-                                link="dcim:power_connections_list",
-                                permissions=[
-                                    "dcim.view_powerport",
-                                    "dcim.view_poweroutlet",
-                                ],
-                            ),
-                            NavItem(
-                                name="Interface Connections",
-                                weight=400,
-                                link="dcim:interface_connections_list",
-                                permissions=["dcim.view_interface"],
-                            ),
-                        ),
-                    ),
-                    NavGrouping(
-                        name="Components",
-                        weight=800,
-                        items=(
-                            NavItem(
-                                name="Interfaces",
-                                weight=100,
-                                link="dcim:interface_list",
-                                permissions=["dcim.view_interface"],
-                            ),
-                            NavItem(
-                                name="Front Ports",
-                                weight=200,
-                                link="dcim:frontport_list",
-                                permissions=["dcim.view_frontport"],
-                            ),
-                            NavItem(
-                                name="Rear Ports",
-                                weight=300,
-                                link="dcim:rearport_list",
-                                permissions=["dcim.view_rearport"],
-                            ),
-                            NavItem(
-                                name="Console Ports",
-                                weight=400,
-                                link="dcim:consoleport_list",
-                                permissions=["dcim.view_consoleport"],
-                            ),
-                            NavItem(
-                                name="Console Server Ports",
-                                weight=500,
-                                link="dcim:consoleserverport_list",
-                                permissions=["dcim.view_consoleserverport"],
-                            ),
-                            NavItem(
-                                name="Power Ports",
-                                weight=600,
-                                link="dcim:powerport_list",
-                                permissions=["dcim.view_powerport"],
-                            ),
-                            NavItem(
-                                name="Power Outlets",
-                                weight=700,
-                                link="dcim:poweroutlet_list",
-                                permissions=["dcim.view_poweroutlet"],
-                            ),
-                            NavItem(
-                                name="Device Bays",
-                                weight=800,
-                                link="dcim:devicebay_list",
-                                permissions=["dcim.view_devicebay"],
-                            ),
-                            NavItem(
-                                name="Inventory Items",
-                                weight=900,
-                                link="dcim:inventoryitem_list",
-                                permissions=["dcim.view_inventoryitem"],
-                            ),
-                        ),
-                    ),
-                    # space reserved for Dynamic Groups item with weight 900
-                    NavItem(
-                        name="Racks",
-                        weight=1000,
-                        link="dcim:rack_list",
-                        permissions=["dcim.view_rack"],
-                    ),
-                    NavItem(
-                        name="Rack Groups",
-                        weight=1100,
-                        link="dcim:rackgroup_list",
-                        permissions=["dcim.view_rackgroup"],
-                    ),
-                    NavItem(
-                        name="Rack Reservations",
-                        weight=1200,
-                        link="dcim:rackreservation_list",
-                        permissions=["dcim.view_rackreservation"],
-                    ),
-                    NavItem(
-                        name="Rack Elevations",
-                        weight=1300,
-                        link="dcim:rack_elevation_list",
-                        permissions=["dcim.view_rack"],
-                    ),
-                ),
-            ),
-            NavGrouping(
-                name="Organization",
-                weight=200,
-                items=(
-                    NavItem(
-                        link="dcim:location_list",
-                        name="Locations",
-                        weight=100,
-                        permissions=[
-                            "dcim.view_location",
-                        ],
-                    ),
-                    NavItem(
-                        link="dcim:locationtype_list",
-                        name="Location Types",
-                        weight=200,
-                        permissions=[
-                            "dcim.view_locationtype",
-                        ],
-                    ),
-                ),
-            ),
-            # space reserved for Tenants at weight 300
-            # space reserved for Circuits at weight 400
-            NavGrouping(
-                name="Power",
-                weight=500,
-                items=(
-                    NavItem(
-                        name="Power Feeds",
-                        link="dcim:powerfeed_list",
-                        weight=100,
-                        permissions=["dcim.view_powerfeed"],
-                    ),
-                    NavItem(
-                        name="Power Panels",
-                        weight=200,
-                        link="dcim:powerpanel_list",
-                        permissions=["dcim.view_powerpanel"],
-                    ),
-                ),
-            ),
-        ),
-    ),
-)

nautobot/dcim/signals.py

@@ -15,6 +15,7 @@ from .models import (
     Device,
     DeviceRedundancyGroup,
     Interface,
+    InterfaceVDCAssignment,
     PathEndpoint,
     PowerPanel,
     Rack,
@@ -289,6 +290,49 @@ def prevent_adding_tagged_vlans_with_incorrect_mode_or_site(sender, instance, ac
     validate_interface_tagged_vlans(instance, kwargs["model"], kwargs["pk_set"])
 
 
+#
+# VirtualDeviceContext Interfaces
+#
+
+
+@receiver(m2m_changed, sender=InterfaceVDCAssignment)
+@disable_for_loaddata
+def validate_vdcs_interface_relationships(sender, instance, action, **kwargs):
+    if action != "pre_add":
+        return
+
+    pk_set = kwargs.get("pk_set", [])
+    if isinstance(instance, Interface):
+        invalid_vdcs = kwargs["model"].objects.filter(pk__in=pk_set).exclude(device=instance.device)
+        if invalid_vdcs.count():
+            raise ValidationError(
+                {
+                    "virtual_device_contexts": (
+                        f"Virtual Device Context with names {list(invalid_vdcs.values_list('name', flat=True))} must all belong to the "
+                        f"same device as the interface's device."
+                    )
+                }
+            )
+    else:
+        vc_interfaces_ids = instance.device.vc_interfaces.values_list("pk", flat=True)
+        invalid_interfaces = (
+            kwargs["model"]
+            .objects.filter(pk__in=pk_set)
+            .exclude(device=instance.device)
+            .exclude(id__in=vc_interfaces_ids)
+        )
+
+        if invalid_interfaces.count():
+            raise ValidationError(
+                {
+                    "interfaces": (
+                        f"Interfaces with names {list(invalid_interfaces.values_list('name', flat=True))} must all belong to the "
+                        f"same device as the Virtual Device Context's device."
+                    )
+                }
+            )
+
+
 #
 # ControllerManagedDeviceGroup
 #