nautobot 2.4.21__py3-none-any.whl → 3.0.0a3__py3-none-any.whl

nautobot/ipam/factory.py

@@ -278,9 +278,16 @@ class NamespaceFactory(PrimaryModelFactory):
 
     class Meta:
         model = Namespace
+        exclude = ("has_tenant", "has_description")
 
     name = UniqueFaker("text", max_nb_chars=20)  # could be up to CHARFIELD_MAX_LENGTH but that gets unwieldy fast
 
+    has_tenant = NautobotBoolIterator()
+    tenant = factory.Maybe("has_tenant", random_instance(Tenant))
+
+    has_description = NautobotBoolIterator()
+    description = factory.Maybe("has_description", factory.Faker("text", max_nb_chars=CHARFIELD_MAX_LENGTH), "")
+
 
 class PrefixFactory(PrimaryModelFactory):
     """Create random Prefix objects with randomized data.

nautobot/ipam/filter_mixins.py

@@ -0,0 +1,38 @@
+import uuid
+
+from nautobot.core.filters import NaturalKeyOrPKMultipleChoiceFilter
+from nautobot.ipam import formfields
+from nautobot.ipam.models import Prefix
+
+
+class PrefixFilter(NaturalKeyOrPKMultipleChoiceFilter):
+    """
+    Filter that supports filtering a foreign key to Prefix by either its PK or by a literal `prefix` string.
+    """
+
+    field_class = formfields.PrefixFilterFormField
+
+    def __init__(self, *args, **kwargs):
+        kwargs.setdefault("to_field_name", "pk")
+        kwargs.setdefault("label", "Prefix (ID or prefix string)")
+        kwargs.setdefault("queryset", Prefix.objects.all())
+        super().__init__(*args, **kwargs)
+
+    def get_filter_predicate(self, v):
+        # Null value filtering
+        if v is None:
+            return {f"{self.field_name}__isnull": True}
+
+        # If value is a model instance, stringify it to a pk.
+        if isinstance(v, Prefix):
+            v = v.pk
+
+        # Try to cast the value to a UUID to distinguish between PKs and prefix strings
+        v = str(v)
+        try:
+            uuid.UUID(v)
+            return {self.field_name: v}
+        except (AttributeError, TypeError, ValueError):
+            # It's a prefix string
+            prefixes_queryset = Prefix.objects.net_equals(v)
+            return {f"{self.field_name}__in": prefixes_queryset.values_list("pk", flat=True)}

nautobot/ipam/filters.py

@@ -8,6 +8,7 @@ import netaddr
 
 from nautobot.cloud.models import CloudNetwork
 from nautobot.core.filters import (
+    ModelMultipleChoiceFilter,
     MultiValueCharFilter,
     MultiValueNumberFilter,
     MultiValueUUIDFilter,
@@ -18,12 +19,15 @@ from nautobot.core.filters import (
     SearchFilter,
     TreeNodeMultipleChoiceFilter,
 )
+from nautobot.core.utils.data import is_uuid
 from nautobot.dcim.filters import LocatableModelFilterSetMixin
 from nautobot.dcim.models import Device, Interface, Location, VirtualDeviceContext
 from nautobot.extras.filters import NautobotFilterSet, RoleModelFilterSetMixin, StatusModelFilterSetMixin
-from nautobot.ipam import choices, formfields
-from nautobot.tenancy.filters.mixins import TenancyModelFilterSetMixin
+from nautobot.ipam import choices
+from nautobot.ipam.filter_mixins import PrefixFilter
+from nautobot.tenancy.filter_mixins import TenancyModelFilterSetMixin
 from nautobot.virtualization.models import VirtualMachine, VMInterface
+from nautobot.vpn.models import VPNTunnelEndpoint
 
 from .models import (
     IPAddress,
@@ -56,40 +60,7 @@ __all__ = (
 )
 
 
-class PrefixFilter(NaturalKeyOrPKMultipleChoiceFilter):
-    """
-    Filter that supports filtering a foreign key to Prefix by either its PK or by a literal `prefix` string.
-    """
-
-    field_class = formfields.PrefixFilterFormField
-
-    def __init__(self, *args, **kwargs):
-        kwargs.setdefault("to_field_name", "pk")
-        kwargs.setdefault("label", "Prefix (ID or prefix string)")
-        kwargs.setdefault("queryset", Prefix.objects.all())
-        super().__init__(*args, **kwargs)
-
-    def get_filter_predicate(self, v):
-        # Null value filtering
-        if v is None:
-            return {f"{self.field_name}__isnull": True}
-
-        # If value is a model instance, stringify it to a pk.
-        if isinstance(v, Prefix):
-            v = v.pk
-
-        # Try to cast the value to a UUID to distinguish between PKs and prefix strings
-        v = str(v)
-        try:
-            uuid.UUID(v)
-            return {self.field_name: v}
-        except (AttributeError, TypeError, ValueError):
-            # It's a prefix string
-            prefixes_queryset = Prefix.objects.net_equals(v)
-            return {f"{self.field_name}__in": prefixes_queryset.values_list("pk", flat=True)}
-
-
-class NamespaceFilterSet(NautobotFilterSet):
+class NamespaceFilterSet(NautobotFilterSet, TenancyModelFilterSetMixin):
     q = SearchFilter(
         filter_predicates={
             "name": "icontains",
@@ -112,34 +83,28 @@ class VRFFilterSet(NautobotFilterSet, StatusModelFilterSetMixin, TenancyModelFil
     import_targets = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=RouteTarget.objects.all(),
         to_field_name="name",
-        label="Import target (ID or name)",
     )
     export_targets = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=RouteTarget.objects.all(),
         to_field_name="name",
-        label="Export target (ID or name)",
     )
     device = NaturalKeyOrPKMultipleChoiceFilter(
         field_name="devices",
         queryset=Device.objects.all(),
         to_field_name="name",
-        label="Device (ID or name)",
     )
     virtual_machines = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=VirtualMachine.objects.all(),
         to_field_name="name",
-        label="Virtual Machine (ID or name)",
     )
     prefix = PrefixFilter(field_name="prefixes")
     namespace = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=Namespace.objects.all(),
         to_field_name="name",
-        label="Namespace (name or ID)",
     )
     virtual_device_contexts = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=VirtualDeviceContext.objects.all(),
         to_field_name="name",
-        label="Virtual Device Context (ID or name)",
     )
 
     class Meta:
@@ -161,22 +126,18 @@ class VRFDeviceAssignmentFilterSet(NautobotFilterSet):
     vrf = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=VRF.objects.all(),
         to_field_name="name",
-        label="VRF (ID or name)",
     )
     device = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=Device.objects.all(),
         to_field_name="name",
-        label="Device (ID or name)",
     )
     virtual_machine = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=VirtualMachine.objects.all(),
         to_field_name="name",
-        label="Virtual Machine (ID or name)",
     )
     virtual_device_context = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=VirtualDeviceContext.objects.all(),
         to_field_name="name",
-        label="Virtual Device Context (ID or name)",
     )
 
     class Meta:
@@ -195,7 +156,6 @@ class VRFPrefixAssignmentFilterSet(NautobotFilterSet):
     vrf = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=VRF.objects.all(),
         to_field_name="name",
-        label="VRF (ID or name)",
     )
 
     class Meta:
@@ -278,12 +238,14 @@ class PrefixFilterSet(
         to_field_name="rd",
         label="Assigned VRF (ID or RD)",
     )
+    # TODO: change to a multiple-value filter as a breaking change for dynamic groups and permissions definition
     present_in_vrf_id = django_filters.ModelChoiceFilter(
         field_name="vrfs",
         queryset=VRF.objects.all(),
         method="filter_present_in_vrf",
         label="Present in VRF",
     )
+    # TODO: change to a multiple-value filter as a breaking change for dynamic groups and permissions definition
     present_in_vrf = django_filters.ModelChoiceFilter(
         field_name="vrfs__rd",
         queryset=VRF.objects.all(),
@@ -291,9 +253,8 @@ class PrefixFilterSet(
         to_field_name="rd",
         label="Present in VRF (RD)",
     )
-    vlan_id = django_filters.ModelMultipleChoiceFilter(
+    vlan_id = ModelMultipleChoiceFilter(
         queryset=VLAN.objects.all(),
-        label="VLAN (ID)",
     )
     vlan_vid = MultiValueNumberFilter(
         field_name="vlan__vid",
@@ -301,7 +262,6 @@ class PrefixFilterSet(
     )
     rir = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=RIR.objects.all(),
-        label="RIR (name or ID)",
         to_field_name="name",
     )
     has_rir = RelatedMembershipBooleanFilter(
@@ -312,7 +272,6 @@ class PrefixFilterSet(
     namespace = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=Namespace.objects.all(),
         to_field_name="name",
-        label="Namespace (name or ID)",
     )
     ip_version = django_filters.NumberFilter()
     location = TreeNodeMultipleChoiceFilter(
@@ -326,12 +285,15 @@ class PrefixFilterSet(
         prefers_id=True,
         queryset=Location.objects.all(),
         to_field_name="name",
-        label="Locations (name or ID)",
     )
     cloud_networks = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=CloudNetwork.objects.all(),
         to_field_name="name",
-        label="Cloud Network (name or ID)",
+    )
+    vpn_tunnel_endpoints = NaturalKeyOrPKMultipleChoiceFilter(
+        queryset=VPNTunnelEndpoint.objects.all(),
+        to_field_name="pk",
+        label="VPN Tunnel Endpoint ID",
     )
 
     class Meta:
@@ -339,7 +301,14 @@ class PrefixFilterSet(
         fields = ["date_allocated", "id", "prefix_length", "tags"]
 
     def _strip_values(self, values):
-        return [value.strip() for value in values if value.strip()]
+        result = []
+        for value in values:
+            value = value.strip()
+            if is_uuid(value):
+                result.append(Prefix.objects.get(pk=value).prefix)
+            elif value:
+                result.append(value)
+        return result
 
     def filter_prefix(self, queryset, name, value):
         prefixes = self._strip_values(value)
@@ -419,7 +388,7 @@ class IPAddressFilterSet(
     StatusModelFilterSetMixin,
     RoleModelFilterSetMixin,
 ):
-    parent = django_filters.ModelMultipleChoiceFilter(
+    parent = ModelMultipleChoiceFilter(
         queryset=Prefix.objects.all(),
         label="Parent prefix",
     )
@@ -437,12 +406,14 @@ class IPAddressFilterSet(
         to_field_name="rd",
         label="VRF (ID or RD)",
     )
+    # TODO: change to a multiple-value filter as a breaking change for dynamic groups and permissions definition
     present_in_vrf_id = django_filters.ModelChoiceFilter(
         field_name="parent__vrfs",
         queryset=VRF.objects.all(),
         method="filter_present_in_vrf",
         label="VRF (ID)",
     )
+    # TODO: change to a multiple-value filter as a breaking change for dynamic groups and permissions definition
     present_in_vrf = django_filters.ModelChoiceFilter(
         field_name="parent__vrfs__rd",
         queryset=VRF.objects.all(),
@@ -473,25 +444,22 @@ class IPAddressFilterSet(
     interfaces = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=Interface.objects.all(),
         to_field_name="name",
-        label="Interfaces (ID or name)",
     )
     vm_interfaces = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=VMInterface.objects.all(),
         to_field_name="name",
-        label="VM interfaces (ID or name)",
     )
     namespace = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=Namespace.objects.all(),
         field_name="parent__namespace",
         to_field_name="name",
-        label="Namespace (name or ID)",
     )
     has_interface_assignments = RelatedMembershipBooleanFilter(
         field_name="interfaces",
         method="_has_interface_assignments",
         label="Has Interface Assignments",
     )
-    nat_inside = django_filters.ModelMultipleChoiceFilter(
+    nat_inside = ModelMultipleChoiceFilter(
         queryset=IPAddress.objects.all(),
         label="NAT (Inside)",
     )
@@ -519,7 +487,14 @@ class IPAddressFilterSet(
         return queryset.filter(params)
 
     def search_by_prefix(self, queryset, name, value):
-        prefixes = [prefix.strip() for prefix in value if prefix.strip()]
+        prefixes = []
+        for prefix in value:
+            prefix = prefix.strip()
+            if is_uuid(prefix):
+                prefixes.append(Prefix.objects.get(pk=prefix).prefix)
+            elif prefix:
+                prefixes.append(prefix)
+
         return queryset.net_host_contained(*prefixes)
 
     def filter_address(self, queryset, name, value):
@@ -569,15 +544,9 @@ class IPAddressToInterfaceFilterSet(NautobotFilterSet):
     )
     interface = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=Interface.objects.all(),
-        label="Interface (name or ID)",
-    )
-    ip_address = django_filters.ModelMultipleChoiceFilter(
-        queryset=IPAddress.objects.all(),
-        label="IP Address (ID)",
     )
     vm_interface = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=VMInterface.objects.all(),
-        label="VM Interface (name or ID)",
     )
 
     class Meta:
@@ -614,7 +583,6 @@ class VLANFilterSet(
     )
     vlan_group = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=VLANGroup.objects.all(),
-        label="VLAN Group (name or ID)",
     )
     location = TreeNodeMultipleChoiceFilter(
         prefers_id=True,
@@ -627,7 +595,6 @@ class VLANFilterSet(
         prefers_id=True,
         queryset=Location.objects.all(),
         to_field_name="name",
-        label="Locations (name or ID)",
     )
 
     class Meta:
@@ -662,7 +629,6 @@ class VLANLocationAssignmentFilterSet(NautobotFilterSet):
         prefers_id=True,
         queryset=Location.objects.all(),
         to_field_name="name",
-        label="Locations (name or ID)",
     )
 
     class Meta:
@@ -680,12 +646,10 @@ class ServiceFilterSet(NautobotFilterSet):
     device = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=Device.objects.all(),
         to_field_name="name",
-        label="Device (ID or name)",
     )
     virtual_machine = NaturalKeyOrPKMultipleChoiceFilter(
         queryset=VirtualMachine.objects.all(),
         to_field_name="name",
-        label="Virtual machine (ID or name)",
     )
     ports = NumericArrayFilter(field_name="ports", lookup_expr="contains")
 

nautobot/ipam/formfields.py

@@ -67,7 +67,7 @@ class IPNetworkFormField(forms.Field):
 class PrefixFilterFormField(MultiMatchModelMultipleChoiceField):
     @property
     def filter(self):
-        from nautobot.ipam.filters import PrefixFilter  # avoid circular definition
+        from nautobot.ipam.filter_mixins import PrefixFilter  # avoid circular definition
 
         return PrefixFilter
 

nautobot/ipam/forms.py

@@ -72,10 +72,10 @@ IPADDRESS_MASK_LENGTH_CHOICES = add_blank_choice(
 #
 
 
-class NamespaceForm(LocatableModelFormMixin, NautobotModelForm):
+class NamespaceForm(LocatableModelFormMixin, NautobotModelForm, TenancyForm):
     class Meta:
         model = Namespace
-        fields = ["name", "description", "location", "tags"]
+        fields = ["name", "description", "tenant", "location", "tags"]
 
 
 class NamespaceBulkEditForm(
@@ -84,18 +84,21 @@ class NamespaceBulkEditForm(
     NautobotBulkEditForm,
 ):
     pk = forms.ModelMultipleChoiceField(queryset=Namespace.objects.all(), widget=forms.MultipleHiddenInput())
+    tenant = DynamicModelChoiceField(queryset=Tenant.objects.all(), required=False)
     description = forms.CharField(max_length=CHARFIELD_MAX_LENGTH, required=False)
 
     class Meta:
         model = Namespace
         nullable_fields = [
             "description",
+            "tenant",
             "location",
         ]
 
 
-class NamespaceFilterForm(LocatableModelFilterFormMixin, NautobotFilterForm):
+class NamespaceFilterForm(LocatableModelFilterFormMixin, NautobotFilterForm, TenancyFilterForm):
     model = Namespace
+    field_order = ["q", "name", "tenant_group", "tenant"]
     q = forms.CharField(required=False, label="Search")
     name = forms.CharField(required=False)
 

nautobot/ipam/migrations/0030_ipam__namespaces.py

@@ -10,6 +10,17 @@ import nautobot.extras.models.mixins
 import nautobot.ipam.models
 
 
+def create_default_namespace(apps, schema):
+    Namespace = apps.get_model("ipam", "Namespace")
+
+    namespace, _ = Namespace.objects.get_or_create(
+        name="Global", defaults={"description": "Default Global namespace. Created by Nautobot."}
+    )
+
+    # Populate the contextvars cache so that subsequent calls to get_default_namespace_pk() do not error out
+    nautobot.ipam.models.default_namespace_pk.set(namespace.pk)
+
+
 class Migration(migrations.Migration):
     dependencies = [
         ("extras", "0072_rename_model_fields"),
@@ -130,6 +141,8 @@ class Migration(migrations.Migration):
             name="ip_version",
             field=models.IntegerField(db_index=True, editable=False, null=True),
         ),
+        # We shouldn't mix data migrations with schema migrations, but we didn't catch this data dependency until much later
+        migrations.RunPython(create_default_namespace, migrations.RunPython.noop),
         migrations.AddField(
             model_name="prefix",
             name="namespace",

nautobot/ipam/migrations/0031_ipam___data_migrations.py

@@ -17,7 +17,10 @@ def reverse_it(apps, schema_editor):
     Interface = apps.get_model("dcim", "Interface")
     VMInterface = apps.get_model("virtualization", "VMInterface")
 
-    ns_global = Namespace.objects.get(name="Global")
+    # This may be overly defensive, but it doesn't hurt to be safe.
+    ns_global, _ = Namespace.objects.get_or_create(
+        name="Global", defaults={"description": "Default Global namespace. Created by Nautobot."}
+    )
     Prefix.objects.update(namespace=ns_global)
     VRF.objects.update(namespace=ns_global)
     Namespace.objects.exclude(name=ns_global.name).delete()

nautobot/ipam/migrations/0054_namespace_tenant.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.2.23 on 2025-08-30 13:10
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("tenancy", "0009_update_all_charfields_max_length_to_255"),
+        ("ipam", "0053_alter_vrfdeviceassignment_options_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="namespace",
+            name="tenant",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="namespaces",
+                to="tenancy.tenant",
+            ),
+        ),
+    ]

nautobot/ipam/models.py

@@ -1,3 +1,4 @@
+import contextvars
 import logging
 import operator
 from typing import Optional
@@ -48,6 +49,9 @@ __all__ = (
 logger = logging.getLogger(__name__)
 
 
+default_namespace_pk = contextvars.ContextVar("default_namespace_pk", default=None)
+
+
 @extras_features(
     "custom_links",
     "custom_validators",
@@ -68,6 +72,13 @@ class Namespace(PrimaryModel):
         blank=True,
         null=True,
     )
+    tenant = models.ForeignKey(
+        to="tenancy.Tenant",
+        on_delete=models.PROTECT,
+        related_name="namespaces",
+        blank=True,
+        null=True,
+    )
 
     @property
     def ip_addresses(self):
@@ -80,9 +91,17 @@ class Namespace(PrimaryModel):
     def __str__(self):
         return self.name
 
+    def delete(self, *args, **kwargs):
+        if self.name == "Global":
+            default_namespace_pk.set(None)
+        super().delete(*args, **kwargs)
+
 
 def get_default_namespace():
-    """Return the Global namespace."""
+    """Return the Global namespace.
+
+    Because this has no access to historical models, this MUST NOT be called during migrations.
+    """
     obj, _ = Namespace.objects.get_or_create(
         name="Global", defaults={"description": "Default Global namespace. Created by Nautobot."}
     )
@@ -91,7 +110,15 @@ def get_default_namespace():
 
 def get_default_namespace_pk():
     """Return the PK of the Global namespace for use in default value for foreign keys."""
-    return get_default_namespace().pk
+    pk = default_namespace_pk.get()
+    if pk is None:
+        # MUST NEVER HAPPEN DURING MIGRATIONS, because get_default_namespace() doesn't use historical models.
+        # This is accommodated in migration ipam__0030 to directly set default_namespace_pk *from* the historical model
+        # but any other migrations using this function may need to implement similar workarounds.
+        pk = get_default_namespace().pk
+        default_namespace_pk.set(pk)
+
+    return pk
 
 
 @extras_features(

nautobot/ipam/navigation.py

@@ -4,11 +4,13 @@ from nautobot.core.apps import (
     NavMenuItem,
     NavMenuTab,
 )
+from nautobot.core.ui.choices import NavigationIconChoices, NavigationWeightChoices
 
 menu_items = (
     NavMenuTab(
         name="IPAM",
-        weight=300,
+        icon=NavigationIconChoices.IPAM,
+        weight=NavigationWeightChoices.IPAM,
         groups=(
             NavMenuGroup(
                 name="IP Addresses",

nautobot/ipam/querysets.py

@@ -5,9 +5,8 @@ from django.core.validators import validate_ipv46_address
 from django.db.models import ProtectedError, Q
 import netaddr
 
-from nautobot.core.models.querysets import RestrictedQuerySet
+from nautobot.core.models.querysets import LocationToLocationsQuerySetMixin, RestrictedQuerySet
 from nautobot.core.utils.data import merge_dicts_without_collision
-from nautobot.ipam.mixins import LocationToLocationsQuerySetMixin
 
 
 class RIRQuerySet(RestrictedQuerySet):