nautobot 2.4.10__py3-none-any.whl → 2.4.12__py3-none-any.whl

nautobot/dcim/migrations/0070_modulefamily_models.py

@@ -0,0 +1,92 @@
+# Generated by Django 4.2.19 on 2025-03-18 17:22
+
+import uuid
+
+import django.core.serializers.json
+from django.db import migrations, models
+import django.db.models.deletion
+
+import nautobot.core.models.fields
+import nautobot.extras.models.mixins
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0122_add_graphqlquery_owner_content_type"),
+        ("dcim", "0069_softwareimagefile_external_integration"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="modulebay",
+            name="requires_first_party_modules",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="modulebaytemplate",
+            name="requires_first_party_modules",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.CreateModel(
+            name="ModuleFamily",
+            fields=[
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4, editable=False, primary_key=True, serialize=False, unique=True
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "_custom_field_data",
+                    models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder),
+                ),
+                ("name", models.CharField(max_length=255, unique=True)),
+                ("description", models.CharField(blank=True, max_length=255)),
+                ("tags", nautobot.core.models.fields.TagsField(through="extras.TaggedItem", to="extras.Tag")),
+            ],
+            options={
+                "verbose_name_plural": "module families",
+                "ordering": ["name"],
+            },
+            bases=(
+                nautobot.extras.models.mixins.DynamicGroupMixin,
+                nautobot.extras.models.mixins.NotesMixin,
+                models.Model,
+            ),
+        ),
+        migrations.AddField(
+            model_name="modulebay",
+            name="module_family",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="module_bays",
+                to="dcim.modulefamily",
+            ),
+        ),
+        migrations.AddField(
+            model_name="modulebaytemplate",
+            name="module_family",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="module_bay_templates",
+                to="dcim.modulefamily",
+            ),
+        ),
+        migrations.AddField(
+            model_name="moduletype",
+            name="module_family",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="module_types",
+                to="dcim.modulefamily",
+            ),
+        ),
+    ]

nautobot/dcim/models/__init__.py

@@ -38,6 +38,7 @@ from .devices import (
     InterfaceVDCAssignment,
     Manufacturer,
     Module,
+    ModuleFamily,
     ModuleType,
     Platform,
     SoftwareImageFile,
@@ -81,6 +82,7 @@ __all__ = (
     "Module",
     "ModuleBay",
     "ModuleBayTemplate",
+    "ModuleFamily",
     "ModuleType",
     "PathEndpoint",
     "Platform",

nautobot/dcim/models/device_component_templates.py

@@ -481,6 +481,18 @@ class ModuleBayTemplate(ModularComponentTemplateModel):
     )
     label = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True, help_text="Physical label")
     description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
+    module_family = models.ForeignKey(
+        to="dcim.ModuleFamily",
+        on_delete=models.PROTECT,
+        related_name="module_bay_templates",
+        blank=True,
+        null=True,
+        help_text="Module family that can be installed in this bay. Leave blank for no restriction.",
+    )
+    requires_first_party_modules = models.BooleanField(
+        default=False,
+        help_text="This bay will only accept modules from the same manufacturer as the parent device or module",
+    )
 
     natural_key_field_names = ["device_type", "module_type", "name"]
 
@@ -505,6 +517,8 @@ class ModuleBayTemplate(ModularComponentTemplateModel):
             position=self.position,
             label=self.label,
             description=self.description,
+            module_family=self.module_family,
+            requires_first_party_modules=self.requires_first_party_modules,
             _custom_field_data=custom_field_data,
         )
 

nautobot/dcim/models/device_components.py

@@ -1218,6 +1218,18 @@ class ModuleBay(PrimaryModel):
         blank=True,
         null=True,
     )
+    module_family = models.ForeignKey(
+        to="dcim.ModuleFamily",
+        on_delete=models.PROTECT,
+        related_name="module_bays",
+        blank=True,
+        null=True,
+        help_text="Module family that can be installed in this bay",
+    )
+    requires_first_party_modules = models.BooleanField(
+        default=False,
+        help_text="This bay will only accept modules from the same manufacturer as the parent device or module",
+    )
     name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, db_index=True)
     _name = NaturalOrderingField(target_field="name", max_length=CHARFIELD_MAX_LENGTH, blank=True, db_index=True)
     position = models.CharField(
@@ -1228,7 +1240,7 @@ class ModuleBay(PrimaryModel):
     label = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True, help_text="Physical label")
     description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
 
-    clone_fields = ["parent_device", "parent_module"]
+    clone_fields = ["parent_device", "parent_module", "module_family", "requires_first_party_modules"]
 
     # The recursive nature of this model combined with the fact that it can be a child of a
     # device or location makes our natural key implementation unusable, so just use the pk

nautobot/dcim/models/devices.py

@@ -30,6 +30,7 @@ from nautobot.dcim.utils import get_all_network_driver_mappings, get_network_dri
 from nautobot.extras.models import ChangeLoggedModel, ConfigContextModel, RoleField, StatusField
 from nautobot.extras.querysets import ConfigContextModelQuerySet
 from nautobot.extras.utils import extras_features
+from nautobot.wireless.models import ControllerManagedDeviceGroupWirelessNetworkAssignment
 
 from .device_components import (
     ConsolePort,
@@ -1456,6 +1457,15 @@ class Controller(PrimaryModel):
             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))
 
+    @property
+    def wireless_network_assignments(self):
+        """
+        Returns all Controller Managed Device Group Wireless Network Assignment linked to this controller.
+        """
+        return ControllerManagedDeviceGroupWirelessNetworkAssignment.objects.filter(
+            controller_managed_device_group__controller=self
+        )
+
 
 @extras_features(
     "custom_links",
@@ -1550,6 +1560,30 @@ class ControllerManagedDeviceGroup(TreeModel, PrimaryModel):
 #
 
 
+@extras_features(
+    "custom_links",
+    "custom_validators",
+    "export_templates",
+    "graphql",
+    "webhooks",
+)
+class ModuleFamily(PrimaryModel):
+    """
+    A ModuleFamily represents a classification of ModuleTypes.
+    It is used to enforce compatibility between ModuleBays and Modules.
+    """
+
+    name = models.CharField(max_length=CHARFIELD_MAX_LENGTH, unique=True)
+    description = models.CharField(max_length=CHARFIELD_MAX_LENGTH, blank=True)
+
+    class Meta:
+        ordering = ["name"]
+        verbose_name_plural = "module families"
+
+    def __str__(self):
+        return self.name
+
+
 # TODO: 5840 - Translate comments field from devicetype library, Nautobot doesn't use that field for ModuleType
 @extras_features(
     "custom_links",
@@ -1577,6 +1611,13 @@ class ModuleType(PrimaryModel):
     """
 
     manufacturer = models.ForeignKey(to="dcim.Manufacturer", on_delete=models.PROTECT, related_name="module_types")
+    module_family = models.ForeignKey(
+        to="dcim.ModuleFamily",
+        on_delete=models.PROTECT,
+        related_name="module_types",
+        blank=True,
+        null=True,
+    )
     model = models.CharField(max_length=CHARFIELD_MAX_LENGTH)
     part_number = models.CharField(
         max_length=CHARFIELD_MAX_LENGTH, blank=True, help_text="Discrete part number (optional)"
@@ -1585,6 +1626,7 @@ class ModuleType(PrimaryModel):
 
     clone_fields = [
         "manufacturer",
+        "module_family",
     ]
 
     class Meta:
@@ -1810,6 +1852,36 @@ class Module(PrimaryModel):
                     {"location": f'Modules may not associate to locations of type "{self.location.location_type}".'}
                 )
 
+        # Validate module family compatibility
+        if self.parent_module_bay and self.parent_module_bay.module_family:
+            if self.module_type.module_family != self.parent_module_bay.module_family:
+                module_family_name = self.parent_module_bay.module_family.name
+                if self.module_type.module_family is None:
+                    module_type_family = "not assigned to a family"
+                else:
+                    module_type_family = f"in the family {self.module_type.module_family.name}"
+                raise ValidationError(
+                    {
+                        "module_type": f"The selected module bay requires a module type in the family {module_family_name}, "
+                        f"but the selected module type is {module_type_family}."
+                    }
+                )
+
+        # Validate module manufacturer constraint
+        if self.parent_module_bay and self.parent_module_bay.requires_first_party_modules:
+            if self.parent_module_bay.parent_device:
+                parent_mfr = self.parent_module_bay.parent_device.device_type.manufacturer
+            elif self.parent_module_bay.parent_module:
+                parent_mfr = self.parent_module_bay.parent_module.module_type.manufacturer
+            else:
+                parent_mfr = None
+            if parent_mfr and self.module_type.manufacturer != parent_mfr:
+                raise ValidationError(
+                    {
+                        "module_type": "The selected module bay requires a module type from the same manufacturer as the parent device or module"
+                    }
+                )
+
     def save(self, *args, **kwargs):
         is_new = not self.present_in_database
 

nautobot/dcim/navigation.py

@@ -293,6 +293,22 @@ menu_items = (
                             ),
                         ),
                     ),
+                    NavMenuItem(
+                        link="dcim:modulefamily_list",
+                        name="Module Families",
+                        weight=300,
+                        permissions=[
+                            "dcim.view_modulefamily",
+                        ],
+                        buttons=(
+                            NavMenuAddButton(
+                                link="dcim:modulefamily_add",
+                                permissions=[
+                                    "dcim.add_modulefamily",
+                                ],
+                            ),
+                        ),
+                    ),
                 ),
             ),
             NavMenuGroup(

nautobot/dcim/tables/__init__.py

@@ -30,6 +30,7 @@ from .devices import (
     InterfaceTable,
     InventoryItemTable,
     ModuleBayTable,
+    ModuleFamilyTable,
     ModuleModuleBayTable,
     ModuleTable,
     PlatformTable,
@@ -104,6 +105,7 @@ __all__ = (
     "ManufacturerTable",
     "ModuleBayTable",
     "ModuleBayTemplateTable",
+    "ModuleFamilyTable",
     "ModuleModuleBayTable",
     "ModuleTable",
     "ModuleTypeTable",

nautobot/dcim/tables/devices.py

@@ -26,6 +26,7 @@ from nautobot.dcim.models import (
     InventoryItem,
     Module,
     ModuleBay,
+    ModuleFamily,
     Platform,
     PowerOutlet,
     PowerPort,
@@ -86,6 +87,7 @@ __all__ = (
     "InterfaceTable",
     "InventoryItemTable",
     "ModuleBayTable",
+    "ModuleFamilyTable",
     "ModuleModuleBayTable",
     "ModuleTable",
     "PlatformTable",
@@ -179,6 +181,7 @@ class DeviceTable(StatusTableMixin, RoleTableMixin, BaseTable):
     software_version = tables.Column(linkify=True, verbose_name="Software Version")
     secrets_group = tables.Column(linkify=True)
     capabilities = tables.Column(orderable=False, accessor="controller_managed_device_group.capabilities")
+    manufacturer = tables.Column(orderable=False, accessor="device_type.manufacturer")
     tags = TagColumn(url_name="dcim:device_list")
     actions = ButtonsColumn(Device)
 
@@ -211,6 +214,7 @@ class DeviceTable(StatusTableMixin, RoleTableMixin, BaseTable):
             "controller_managed_device_group",
             "secrets_group",
             "capabilities",
+            "manufacturer",
             "tags",
             "actions",
         )
@@ -275,6 +279,7 @@ class ModuleTable(StatusTableMixin, RoleTableMixin, BaseTable):
     )
     location = tables.Column(linkify=True)
     tenant = TenantColumn()
+    module_type__module_family = tables.Column(linkify=True, verbose_name="Family")
     tags = TagColumn(url_name="dcim:module_list")
     actions = ButtonsColumn(Module, prepend_template=MODULE_BUTTONS)
 
@@ -283,6 +288,7 @@ class ModuleTable(StatusTableMixin, RoleTableMixin, BaseTable):
         fields = (
             "pk",
             "module_type",
+            "module_family",
             "parent_module_bay",
             "location",
             "serial",
@@ -296,6 +302,7 @@ class ModuleTable(StatusTableMixin, RoleTableMixin, BaseTable):
         default_columns = (
             "pk",
             "module_type",
+            "module_family",
             "parent_module_bay",
             "location",
             "serial",
@@ -307,6 +314,40 @@ class ModuleTable(StatusTableMixin, RoleTableMixin, BaseTable):
         )
 
 
+class ModuleFamilyTable(BaseTable):
+    pk = ToggleColumn()
+    name = tables.Column(linkify=True)
+    module_type_count = LinkedCountColumn(
+        viewname="dcim:moduletype_list", url_params={"module_family": "pk"}, verbose_name="Module Types"
+    )
+    module_bay_count = LinkedCountColumn(
+        viewname="dcim:modulebay_list", url_params={"module_family": "pk"}, verbose_name="Module Bays"
+    )
+    tags = TagColumn()
+    actions = ButtonsColumn(ModuleFamily)
+
+    class Meta(BaseTable.Meta):
+        model = ModuleFamily
+        fields = (
+            "pk",
+            "name",
+            "description",
+            "module_type_count",
+            "module_bay_count",
+            "tags",
+            "created",
+            "last_updated",
+            "actions",
+        )
+        default_columns = (
+            "name",
+            "description",
+            "module_type_count",
+            "module_bay_count",
+            "actions",
+        )
+
+
 #
 # Device components
 #
@@ -943,6 +984,7 @@ class ModuleBayTable(BaseTable):
     installed_module = tables.Column(linkify=True, verbose_name="Installed Module")
     installed_module__status = ColoredLabelColumn()
     tags = TagColumn(url_name="dcim:devicebay_list")
+    module_family = tables.Column(linkify=True, verbose_name="Family")
 
     class Meta(BaseTable.Meta):
         model = ModuleBay
@@ -953,6 +995,7 @@ class ModuleBayTable(BaseTable):
             "name",
             "position",
             "label",
+            "module_family",
             "description",
             "installed_module",
             "installed_module__status",
@@ -965,6 +1008,7 @@ class ModuleBayTable(BaseTable):
             "name",
             "position",
             "label",
+            "module_family",
             "description",
             "installed_module",
             "installed_module__status",
@@ -1008,8 +1052,10 @@ class DeviceModuleBayTable(ModuleBayTable):
         '"></i> <a href="{{ record.get_absolute_url }}">{{ value }}</a>',
         attrs={"td": {"class": "text-nowrap"}},
     )
+    module_family = tables.Column(linkify=True, verbose_name="Family")
     installed_module = tables.Column(linkify=True, verbose_name="Installed Module")
     installed_module__status = ColoredLabelColumn(verbose_name="Installed Module Status")
+    requires_first_party_modules = BooleanColumn(verbose_name="First-Party Only")
     actions = ButtonsColumn(model=ModuleBay, buttons=("edit", "delete"), prepend_template=MODULEBAY_BUTTONS)
 
     class Meta(ModularDeviceComponentTable.Meta):
@@ -1018,6 +1064,8 @@ class DeviceModuleBayTable(ModuleBayTable):
             "pk",
             "name",
             "position",
+            "module_family",
+            "requires_first_party_modules",
             "installed_module",
             "installed_module__status",
             "label",
@@ -1029,6 +1077,8 @@ class DeviceModuleBayTable(ModuleBayTable):
             "pk",
             "name",
             "position",
+            "module_family",
+            "requires_first_party_modules",
             "installed_module",
             "installed_module__status",
             "actions",

nautobot/dcim/tables/devicetypes.py

@@ -158,6 +158,7 @@ class ModuleTypeTable(BaseTable):
     pk = ToggleColumn()
     manufacturer = tables.Column(linkify=True)
     model = tables.Column(linkify=True, verbose_name="Module Type")
+    module_family = tables.Column(linkify=True, verbose_name="Family")
     module_count = LinkedCountColumn(
         viewname="dcim:module_list",
         url_params={"module_type": "pk"},
@@ -172,6 +173,7 @@ class ModuleTypeTable(BaseTable):
             "model",
             "manufacturer",
             "part_number",
+            "module_family",
             "module_count",
             "tags",
         )
@@ -180,6 +182,7 @@ class ModuleTypeTable(BaseTable):
             "model",
             "manufacturer",
             "part_number",
+            "module_family",
             "module_count",
         )
 
@@ -333,8 +336,39 @@ class ModuleBayTemplateTable(ComponentTemplateTable):
         buttons=("edit", "delete"),
         return_url_extra=r"%3Ftab=modulebays",
     )
+    module_family = tables.Column(verbose_name="Family", linkify=True)
+    requires_first_party_modules = BooleanColumn(verbose_name="Requires First-Party Modules")
 
     class Meta(BaseTable.Meta):
         model = ModuleBayTemplate
-        fields = ("pk", "name", "position", "label", "description", "actions")
+        fields = (
+            "pk",
+            "name",
+            "position",
+            "module_family",
+            "label",
+            "requires_first_party_modules",
+            "description",
+            "actions",
+        )
+        default_columns = (
+            "pk",
+            "name",
+            "position",
+            "module_family",
+            "label",
+            "requires_first_party_modules",
+            "description",
+            "actions",
+        )
+        field_order = (
+            "pk",
+            "name",
+            "position",
+            "module_family",
+            "label",
+            "requires_first_party_modules",
+            "description",
+            "actions",
+        )
         empty_text = "None"

nautobot/dcim/tables/template_code.py

@@ -93,7 +93,9 @@ LINKED_RECORD_COUNT = """
 
 TREE_LINK = """
 {% load helpers %}
+{% if not table.hide_hierarchy_ui %}
 {% tree_hierarchy_ui_representation record.tree_depth|as_range table.hide_hierarchy_ui %}
+{% endif %}
 <a href="{{ record.get_absolute_url }}">{{ record.name }}</a>
 """
 

nautobot/dcim/templates/dcim/controller/base.html

@@ -1,10 +1,2 @@
 {% extends 'generic/object_retrieve.html' %}
-{% load helpers %}
-
-{% block extra_nav_tabs %}
-    {% if 'wireless' in object.capabilities %}
-        <li role="presentation" {% if active_tab == 'wireless-networks' %} class="active"{% endif %}>
-            <a href="{% url 'dcim:controller_wirelessnetworks' pk=object.pk %}">Wireless Networks</a>
-        </li>
-    {% endif %}
-{% endblock extra_nav_tabs %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

nautobot/dcim/templates/dcim/controller_retrieve.html

@@ -1,83 +1,2 @@
-{% extends 'dcim/controller/base.html' %}
-{% load helpers %}
-
-{% block content_left_page %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Controller</strong>
-                </div>
-                <div class="table-responsive">
-                    <table class="table table-hover panel-body attr-table">
-                        <tr>
-                            <td>Name</td>
-                            <td>{{ object.name|placeholder }}</td>
-                        </tr>
-                        <tr>
-                            <td>Status</td>
-                            <td>
-                                {{ object.status|hyperlinked_object_with_color }}
-                            </td>
-                        </tr>
-                        <tr>
-                            <td>Role</td>
-                            <td>{{ object.role|hyperlinked_object_with_color }}</td>
-                        </tr>
-                        <tr>
-                            <td>Capabilities</td>
-                            <td>{{ object.get_capabilities_display }}</td>
-                        </tr>
-                        <tr>
-                            <td>Location</td>
-                            <td>{{ object.location|hyperlinked_object }}</td>
-                        </tr>
-                        <tr>
-                            <td>Platform</td>
-                            <td>{{ object.platform|hyperlinked_object }}</td>
-                        </tr>
-                        {% include 'inc/tenant_table_row.html' %}
-                        <tr>
-                            <td>Description</td>
-                            <td>{{ object.description|placeholder }}</td>
-                        </tr>
-                    </table>
-                </div>
-            </div>
-{% endblock content_left_page %}
-
-{% block content_right_page %}
-            <div class="panel panel-default">
-                <div class="panel-heading">
-                    <strong>Integration</strong>
-                </div>
-                <div class="table-responsive">
-                    <table class="table table-hover panel-body attr-table">
-                        <tr>
-                            <td>External Integration</td>
-                            <td>{{ object.external_integration|hyperlinked_object }}</td>
-                        </tr>
-                        {% if object.controller_device %}
-                            <tr>
-                                <td>Controller Device</td>
-                                <td>{{ object.controller_device|hyperlinked_object }}</td>
-                            </tr>
-                        {% endif %}
-                        {% if object.controller_device_redundancy_group %}
-                            <tr>
-                                <td>Controller Device Redundancy Group</td>
-                                <td>{{ object.controller_device_redundancy_group|hyperlinked_object }}</td>
-                            </tr>
-                        {% endif %}
-                    </table>
-                </div>
-            </div>
-{% endblock content_right_page %}
-
-{% block content_full_width_page %}
-        <div class="panel panel-default">
-            <div class="panel-heading">
-                <strong>Managed Devices</strong>
-            </div>
-            {% include 'responsive_table.html' with table=devices_table %}
-        </div>
-        {% include 'inc/paginator.html' with paginator=devices_table.paginator page=devices_table.page %}
-{% endblock content_full_width_page %}
+{% extends 'generic/object_retrieve.html' %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}

nautobot/dcim/templates/dcim/controller_wirelessnetworks.html

@@ -1,25 +1,2 @@
-{% extends 'dcim/controller/base.html' %}
-{% load helpers %}
-
-{% block content %}
-<form method="post">
-    {% csrf_token %}
-    <div class="panel panel-default">
-        <div class="panel-heading">
-            <strong>Wireless Networks</strong>
-            <div class="pull-right noprint">
-                {% if request.user.is_authenticated %}
-                    {% table_config_button_small wireless_networks_table %}
-                {% endif %}
-            </div>
-        </div>
-        {% include 'responsive_table.html' with table=wireless_networks_table %}
-    </div>
-</form>
-{% table_config_form wireless_networks_table %}
-{% endblock content %}
-
-{% block javascript %}
-    {{ block.super }}
-    <script src="{% versioned_static 'js/tableconfig.js' %}"></script>
-{% endblock javascript %}
+{% extends 'generic/object_retrieve.html' %}
+{% comment %}3.0 TODO: remove this template, which only exists for backward compatibility with 2.4 and earlier{% endcomment %}