nautobot 2.0.0a3__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/ipam/models.py

@@ -7,7 +7,6 @@ from django.core.exceptions import ValidationError, MultipleObjectsReturned
 from django.core.validators import MaxValueValidator, MinValueValidator
 from django.db import models
 from django.db.models import Q
-from django.urls import reverse
 from django.utils.functional import cached_property, classproperty
 
 from nautobot.core.models import BaseManager, BaseModel
@@ -15,11 +14,11 @@ from nautobot.core.models.fields import AutoSlugField, JSONArrayField
 from nautobot.core.models.generics import OrganizationalModel, PrimaryModel
 from nautobot.core.models.utils import array_to_string
 from nautobot.core.utils.data import UtilizationData
-from nautobot.dcim.models import Device, Interface
-from nautobot.extras.models import RoleModelMixin, Status, StatusModel
+from nautobot.dcim.models import Interface
+from nautobot.extras.models import RoleField, Status, StatusField
 from nautobot.extras.utils import extras_features
 from nautobot.ipam import choices
-from nautobot.virtualization.models import VirtualMachine, VMInterface
+from nautobot.virtualization.models import VMInterface
 from .constants import (
     SERVICE_PORT_MAX,
     SERVICE_PORT_MIN,
@@ -67,15 +66,17 @@ class Namespace(PrimaryModel):
         null=True,
     )
 
+    @property
+    def ip_addresses(self):
+        """Return all IPAddresses associated to this Namespace through their parent Prefix."""
+        return IPAddress.objects.filter(parent__namespace=self).distinct()
+
     class Meta:
         ordering = ("name",)
 
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("ipam:namespace", args=[self.pk])
-
 
 def get_default_namespace():
     """Return the Global namespace for use in default value for foreign keys."""
@@ -120,6 +121,12 @@ class VRF(PrimaryModel):
         through="ipam.VRFDeviceAssignment",
         through_fields=("vrf", "device"),
     )
+    virtual_machines = models.ManyToManyField(
+        to="virtualization.VirtualMachine",
+        related_name="vrfs",
+        through="ipam.VRFDeviceAssignment",
+        through_fields=("vrf", "virtual_machine"),
+    )
     prefixes = models.ManyToManyField(
         to="ipam.Prefix",
         related_name="vrfs",
@@ -136,14 +143,13 @@ class VRF(PrimaryModel):
     import_targets = models.ManyToManyField(to="ipam.RouteTarget", related_name="importing_vrfs", blank=True)
     export_targets = models.ManyToManyField(to="ipam.RouteTarget", related_name="exporting_vrfs", blank=True)
 
-    csv_headers = ["name", "rd", "tenant", "description"]
     clone_fields = [
         "tenant",
         "description",
     ]
 
     class Meta:
-        ordering = ("namespace", "name")  # (name, rd) may be non-unique
+        ordering = ("namespace", "name", "rd")  # (name, rd) may be non-unique
         unique_together = [
             ["namespace", "name"],
             ["namespace", "rd"],
@@ -154,17 +160,6 @@ class VRF(PrimaryModel):
     def __str__(self):
         return self.display or super().__str__()
 
-    def get_absolute_url(self):
-        return reverse("ipam:vrf", args=[self.pk])
-
-    def to_csv(self):
-        return (
-            self.name,
-            self.rd,
-            self.tenant.name if self.tenant else None,
-            self.description,
-        )
-
     @property
     def display(self):
         if self.namespace:
@@ -202,6 +197,37 @@ class VRF(PrimaryModel):
         instance = self.devices.through.objects.get(vrf=self, device=device)
         return instance.delete()
 
+    def add_virtual_machine(self, virtual_machine, rd="", name=""):
+        """
+        Add a `virtual_machine` to this VRF, optionally overloading `rd` and `name`.
+
+        If `rd` or `name` are not provided, the values from this VRF will be inherited.
+
+        Args:
+            virtual_machine (VirtualMachine): VirtualMachine instance
+            rd (str): (Optional) RD of the VRF when associated with this VirtualMachine
+            name (str): (Optional) Name of the VRF when associated with this VirtualMachine
+
+        Returns:
+            VRFDeviceAssignment instance
+        """
+        instance = self.virtual_machines.through(vrf=self, virtual_machine=virtual_machine, rd=rd, name=name)
+        instance.validated_save()
+        return instance
+
+    def remove_virtual_machine(self, virtual_machine):
+        """
+        Remove a `virtual_machine` from this VRF.
+
+        Args:
+            virtual_machine (VirtualMachine): VirtualMachine instance
+
+        Returns:
+            tuple (int, dict): Number of objects deleted and a dict with number of deletions.
+        """
+        instance = self.virtual_machines.through.objects.get(vrf=self, virtual_machine=virtual_machine)
+        return instance.delete()
+
     def add_prefix(self, prefix):
         """
         Add a `prefix` to this VRF. Each object must be in the same Namespace.
@@ -232,7 +258,12 @@ class VRF(PrimaryModel):
 
 class VRFDeviceAssignment(BaseModel):
     vrf = models.ForeignKey("ipam.VRF", on_delete=models.CASCADE, related_name="device_assignments")
-    device = models.ForeignKey("dcim.Device", on_delete=models.CASCADE, related_name="vrf_assignments")
+    device = models.ForeignKey(
+        "dcim.Device", null=True, blank=True, on_delete=models.CASCADE, related_name="vrf_assignments"
+    )
+    virtual_machine = models.ForeignKey(
+        "virtualization.VirtualMachine", null=True, blank=True, on_delete=models.CASCADE, related_name="vrf_assignments"
+    )
     rd = models.CharField(
         max_length=VRF_RD_MAX_LENGTH,
         blank=True,
@@ -245,11 +276,14 @@ class VRFDeviceAssignment(BaseModel):
     class Meta:
         unique_together = [
             ["vrf", "device"],
+            ["vrf", "virtual_machine"],
             ["device", "rd", "name"],
+            ["virtual_machine", "rd", "name"],
         ]
 
     def __str__(self):
-        return f"{self.vrf} [{self.device}] (rd: {self.rd}, name: {self.name})"
+        obj = self.device or self.virtual_machine
+        return f"{self.vrf} [{obj}] (rd: {self.rd}, name: {self.name})"
 
     def clean(self):
         super().clean()
@@ -262,6 +296,12 @@ class VRFDeviceAssignment(BaseModel):
         if not self.name:
             self.name = self.vrf.name
 
+        # A VRF must belong to a Device *or* to a VirtualMachine.
+        if all([self.device, self.virtual_machine]):
+            raise ValidationError("A VRF cannot be associated with both a device and a virtual machine.")
+        if not any([self.device, self.virtual_machine]):
+            raise ValidationError("A VRF must be associated with either a device or a virtual machine.")
+
 
 class VRFPrefixAssignment(BaseModel):
     vrf = models.ForeignKey("ipam.VRF", on_delete=models.CASCADE, related_name="+")
@@ -306,24 +346,12 @@ class RouteTarget(PrimaryModel):
         null=True,
     )
 
-    csv_headers = ["name", "description", "tenant"]
-
     class Meta:
         ordering = ["name"]
 
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("ipam:routetarget", args=[self.pk])
-
-    def to_csv(self):
-        return (
-            self.name,
-            self.description,
-            self.tenant.name if self.tenant else None,
-        )
-
 
 @extras_features(
     "custom_validators",
@@ -343,8 +371,6 @@ class RIR(OrganizationalModel):
     )
     description = models.CharField(max_length=200, blank=True)
 
-    csv_headers = ["name", "is_private", "description"]
-
     objects = BaseManager.from_queryset(RIRQuerySet)()
 
     class Meta:
@@ -355,16 +381,6 @@ class RIR(OrganizationalModel):
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("ipam:rir", args=[self.pk])
-
-    def to_csv(self):
-        return (
-            self.name,
-            str(self.is_private),
-            self.description,
-        )
-
 
 @extras_features(
     "custom_links",
@@ -376,7 +392,7 @@ class RIR(OrganizationalModel):
     "statuses",
     "webhooks",
 )
-class Prefix(PrimaryModel, StatusModel, RoleModelMixin):
+class Prefix(PrimaryModel):
     """
     A Prefix represents an IPv4 or IPv6 network, including mask length.
     Prefixes can optionally be assigned to Locations and VRFs.
@@ -397,6 +413,8 @@ class Prefix(PrimaryModel, StatusModel, RoleModelMixin):
         choices=choices.PrefixTypeChoices,
         default=choices.PrefixTypeChoices.TYPE_NETWORK,
     )
+    status = StatusField(blank=False, null=False)
+    role = RoleField(blank=True, null=True)
     parent = models.ForeignKey(
         "self",
         blank=True,
@@ -458,20 +476,6 @@ class Prefix(PrimaryModel, StatusModel, RoleModelMixin):
 
     objects = BaseManager.from_queryset(PrefixQuerySet)()
 
-    csv_headers = [
-        "prefix",
-        "namespace",
-        "type",
-        "tenant",
-        "location",
-        "vlan_group",
-        "vlan",
-        "status",
-        "role",
-        "rir",
-        "date_allocated",
-        "description",
-    ]
     clone_fields = [
         "date_allocated",
         "description",
@@ -540,9 +544,6 @@ class Prefix(PrimaryModel, StatusModel, RoleModelMixin):
             self.prefix_length = prefix.prefixlen
             self.ip_version = prefix.version
 
-    def get_absolute_url(self):
-        return reverse("ipam:prefix", args=[self.pk])
-
     # TODO: this function is completely unused at present - remove?
     def get_duplicates(self):
         return Prefix.objects.net_equals(self.prefix).filter(namespace=self.namespace).exclude(pk=self.pk)
@@ -606,22 +607,6 @@ class Prefix(PrimaryModel, StatusModel, RoleModelMixin):
         # Determine the child IPs and reparent them to this prefix.
         self.reparent_ips()
 
-    def to_csv(self):
-        return (
-            self.prefix,
-            self.namespace.name if self.namespace else None,
-            self.get_type_display(),
-            self.tenant.name if self.tenant else None,
-            self.location.name if self.location else None,
-            self.vlan.vlan_group.name if self.vlan and self.vlan.vlan_group else None,
-            self.vlan.vid if self.vlan else None,
-            self.get_status_display(),
-            self.role.name if self.role else None,
-            self.rir.name if self.rir else None,
-            str(self.date_allocated),
-            self.description,
-        )
-
     @property
     def cidr_str(self):
         if self.network is not None and self.prefix_length is not None:
@@ -660,7 +645,10 @@ class Prefix(PrimaryModel, StatusModel, RoleModelMixin):
     def reparent_ips(self):
         """Determine the list of child IPAddresses and set the parent to self."""
         query = IPAddress.objects.select_for_update().filter(
+            ip_version=self.ip_version,
             parent_id=self.parent_id,
+            host__gte=self.network,
+            host__lte=self.broadcast,
         )
 
         return query.update(parent=self)
@@ -791,10 +779,6 @@ class Prefix(PrimaryModel, StatusModel, RoleModelMixin):
 
         return query
 
-    def get_child_ips(self):
-        """Return all IPAddresses directly contained within this Prefix and Namespace."""
-        return self.ip_addresses.all()
-
     def get_available_prefixes(self):
         """
         Return all available Prefixes within this prefix as an IPSet.
@@ -810,7 +794,7 @@ class Prefix(PrimaryModel, StatusModel, RoleModelMixin):
         Return all available IPs within this prefix as an IPSet.
         """
         prefix = netaddr.IPSet(self.prefix)
-        child_ips = netaddr.IPSet([ip.address.ip for ip in self.get_child_ips()])
+        child_ips = netaddr.IPSet([ip.address.ip for ip in self.ip_addresses.all()])
         available_ips = prefix - child_ips
 
         # IPv6, pool, or IPv4 /31-32 sets are fully usable
@@ -886,7 +870,7 @@ class Prefix(PrimaryModel, StatusModel, RoleModelMixin):
     "statuses",
     "webhooks",
 )
-class IPAddress(PrimaryModel, StatusModel, RoleModelMixin):
+class IPAddress(PrimaryModel):
     """
     An IPAddress represents an individual IPv4 or IPv6 address and its mask. The mask length should match what is
     configured in the real world. (Typically, only loopback interfaces are configured with /32 or /128 masks.) Like
@@ -903,8 +887,9 @@ class IPAddress(PrimaryModel, StatusModel, RoleModelMixin):
         db_index=True,
         help_text="IPv4 or IPv6 host address",
     )
-    broadcast = VarbinaryIPField(null=False, db_index=True, help_text="IPv4 or IPv6 broadcast address")
-    prefix_length = models.IntegerField(null=False, db_index=True, help_text="Length of the Network prefix, in bits.")
+    mask_length = models.IntegerField(null=False, db_index=True, help_text="Length of the network mask, in bits.")
+    status = StatusField(blank=False, null=False)
+    role = RoleField(blank=True, null=True)
     parent = models.ForeignKey(
         "ipam.Prefix",
         blank=True,
@@ -913,7 +898,7 @@ class IPAddress(PrimaryModel, StatusModel, RoleModelMixin):
         on_delete=models.PROTECT,
         help_text="The parent Prefix of this IPAddress.",
     )
-    # ip_version is set internally just like network, broadcast, and prefix_length.
+    # ip_version is set internally just like network, and mask_length.
     ip_version = models.IntegerField(
         choices=choices.IPAddressVersionChoices,
         null=True,
@@ -946,15 +931,6 @@ class IPAddress(PrimaryModel, StatusModel, RoleModelMixin):
     )
     description = models.CharField(max_length=200, blank=True)
 
-    csv_headers = [
-        "address",
-        "tenant",
-        "status",
-        "role",
-        "is_primary",
-        "dns_name",
-        "description",
-    ]
     clone_fields = [
         "tenant",
         "status",
@@ -966,7 +942,7 @@ class IPAddress(PrimaryModel, StatusModel, RoleModelMixin):
     objects = BaseManager.from_queryset(IPAddressQuerySet)()
 
     class Meta:
-        ordering = ("ip_version", "host", "prefix_length")  # address may be non-unique
+        ordering = ("ip_version", "host", "mask_length")  # address may be non-unique
         verbose_name = "IP address"
         verbose_name_plural = "IP addresses"
         unique_together = ["parent", "host"]
@@ -991,22 +967,15 @@ class IPAddress(PrimaryModel, StatusModel, RoleModelMixin):
         if address:
             if isinstance(address, str):
                 address = netaddr.IPNetwork(address)
-            # Note that our "broadcast" field is actually the last IP address in this network.
-            # This is different from the more accurate technical meaning of a network's broadcast address in 2 cases:
-            # 1. For a point-to-point address (IPv4 /31 or IPv6 /127), there are two addresses in the network,
-            #    and neither one is considered a broadcast address. We store the second address as our "broadcast".
-            # 2. For a host prefix (IPv6 /32 or IPv6 /128) there's only one address in the network.
-            #    We store this address as both the host and the "broadcast".
-            # This variance is intentional in both cases as we use the "broadcast" primarily for filtering and grouping
-            # of addresses and prefixes, not for packet forwarding. :-)
-            broadcast = address.broadcast if address.broadcast else address[-1]
             self.host = str(address.ip)
-            self.broadcast = str(broadcast)
-            self.prefix_length = address.prefixlen
+            self.mask_length = address.prefixlen
             self.ip_version = address.version
 
-    def get_absolute_url(self):
-        return reverse("ipam:ipaddress", args=[self.pk])
+    def get_duplicates(self):
+        return IPAddress.objects.filter(vrf=self.vrf, host=self.host).exclude(pk=self.pk)
+
+    # TODO: The current IPAddress model has no appropriate natural key available yet.
+    natural_key_field_names = ["id"]
 
     @classproperty  # https://github.com/PyCQA/pylint-django/issues/240
     def STATUS_SLAAC(cls):  # pylint: disable=no-self-argument
@@ -1022,26 +991,11 @@ class IPAddress(PrimaryModel, StatusModel, RoleModelMixin):
     def clean(self):
         super().clean()
 
-        # TODO: update to work with interface M2M
-        # This attribute will have been set by `IPAddressForm.clean()` to indicate that the
-        # `primary_ip{version}` field on `self.assigned_object.parent` has been nullified but not yet saved.
-        primary_ip_unset_by_form = getattr(self, "_primary_ip_unset_by_form", False)
-
-        # Check for primary IP assignment that doesn't match the assigned device/VM if and only if
-        # "_primary_ip_unset" has not been set by the caller.
-        if self.present_in_database and not primary_ip_unset_by_form:
-            device = Device.objects.filter(Q(primary_ip4=self) | Q(primary_ip6=self)).first()
-            if device:
-                if getattr(self.assigned_object, "device", None) != device:
-                    raise ValidationError(
-                        {"interface": f"IP address is primary for device {device} but not assigned to it!"}
-                    )
-            vm = VirtualMachine.objects.filter(Q(primary_ip4=self) | Q(primary_ip6=self)).first()
-            if vm:
-                if getattr(self.assigned_object, "virtual_machine", None) != vm:
-                    raise ValidationError(
-                        {"vminterface": f"IP address is primary for virtual machine {vm} but not assigned to it!"}
-                    )
+        # Validate that host is not being modified
+        if self.present_in_database:
+            ip_address = IPAddress.objects.get(id=self.id)
+            if ip_address.host != self.host:
+                raise ValidationError({"address": "Host address cannot be changed once created"})
 
         # Validate IP status selection
         if self.status == IPAddress.STATUS_SLAAC and self.ip_version != 6:
@@ -1063,28 +1017,10 @@ class IPAddress(PrimaryModel, StatusModel, RoleModelMixin):
 
         super().save(*args, **kwargs)
 
-    def to_csv(self):
-        # Determine if this IP is primary for a Device
-        is_primary = False
-        if self.address.version == 4 and getattr(self, "primary_ip4_for", False):
-            is_primary = True
-        elif self.address.version == 6 and getattr(self, "primary_ip6_for", False):
-            is_primary = True
-
-        return (
-            self.address,
-            self.tenant.name if self.tenant else None,
-            self.get_status_display(),
-            self.role.name if self.role else None,
-            str(is_primary),
-            self.dns_name,
-            self.description,
-        )
-
     @property
     def address(self):
-        if self.host is not None and self.prefix_length is not None:
-            cidr = f"{self.host}/{self.prefix_length}"
+        if self.host is not None and self.mask_length is not None:
+            cidr = f"{self.host}/{self.mask_length}"
             return netaddr.IPNetwork(cidr)
         return None
 
@@ -1137,16 +1073,6 @@ class IPAddress(PrimaryModel, StatusModel, RoleModelMixin):
         def __str__(self):
             return f"Multiple IPAddress objects specify this object (pk: {self.obj.pk}) as nat_inside. Please refer to nat_outside_list."
 
-    def _set_mask_length(self, value):
-        """
-        Expose the IPNetwork object's prefixlen attribute on the parent model so that it can be manipulated directly,
-        e.g. for bulk editing.
-        """
-        if self.address is not None:
-            self.prefix_length = value
-
-    mask_length = property(fset=_set_mask_length)
-
 
 class IPAddressToInterface(BaseModel):
     ip_address = models.ForeignKey("ipam.IPAddress", on_delete=models.CASCADE, related_name="+")
@@ -1168,19 +1094,11 @@ class IPAddressToInterface(BaseModel):
     is_secondary = models.BooleanField(default=False, help_text="Is secondary address on interface")
     is_standby = models.BooleanField(default=False, help_text="Is standby address on interface")
 
-    def validate_unique(self, exclude=None):
-        """
-        Check uniqueness on combination of `ip_address`, `interface` and `vm_interface` fields
-        and raise ValidationError if check failed.
-        """
-        if IPAddressToInterface.objects.filter(
-            ip_address=self.ip_address,
-            interface=self.interface,
-            vm_interface=self.vm_interface,
-        ).exists():
-            raise ValidationError(
-                "IPAddressToInterface with this ip_address, interface and vm_interface already exists."
-            )
+    class Meta:
+        unique_together = [
+            ["ip_address", "interface"],
+            ["ip_address", "vm_interface"],
+        ]
 
     def clean(self):
         super().clean()
@@ -1222,8 +1140,6 @@ class VLANGroup(OrganizationalModel):
     )
     description = models.CharField(max_length=200, blank=True)
 
-    csv_headers = ["name", "slug", "location", "description"]
-
     class Meta:
         ordering = (
             "location",
@@ -1254,17 +1170,6 @@ class VLANGroup(OrganizationalModel):
     def __str__(self):
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("ipam:vlangroup", args=[self.pk])
-
-    def to_csv(self):
-        return (
-            self.name,
-            self.slug,
-            self.location.name if self.location else None,
-            self.description,
-        )
-
     def get_next_available_vid(self):
         """
         Return the first available VLAN ID (1-4094) in the group.
@@ -1285,7 +1190,7 @@ class VLANGroup(OrganizationalModel):
     "statuses",
     "webhooks",
 )
-class VLAN(PrimaryModel, StatusModel, RoleModelMixin):
+class VLAN(PrimaryModel):
     """
     A VLAN is a distinct layer two forwarding domain identified by a 12-bit integer (1-4094).
     Each VLAN must be assigned to a Location, however VLAN IDs need not be unique within a Location.
@@ -1313,6 +1218,8 @@ class VLAN(PrimaryModel, StatusModel, RoleModelMixin):
         verbose_name="ID", validators=[MinValueValidator(1), MaxValueValidator(4094)]
     )
     name = models.CharField(max_length=255, db_index=True)
+    status = StatusField(blank=False, null=False)
+    role = RoleField(blank=True, null=True)
     tenant = models.ForeignKey(
         to="tenancy.Tenant",
         on_delete=models.PROTECT,
@@ -1322,16 +1229,6 @@ class VLAN(PrimaryModel, StatusModel, RoleModelMixin):
     )
     description = models.CharField(max_length=200, blank=True)
 
-    csv_headers = [
-        "location",
-        "vlan_group",
-        "vid",
-        "name",
-        "tenant",
-        "status",
-        "role",
-        "description",
-    ]
     clone_fields = [
         "location",
         "vlan_group",
@@ -1341,6 +1238,8 @@ class VLAN(PrimaryModel, StatusModel, RoleModelMixin):
         "description",
     ]
 
+    natural_key_field_names = ["vid", "vlan_group"]
+
     class Meta:
         ordering = (
             "location",
@@ -1359,9 +1258,6 @@ class VLAN(PrimaryModel, StatusModel, RoleModelMixin):
     def __str__(self):
         return self.display or super().__str__()
 
-    def get_absolute_url(self):
-        return reverse("ipam:vlan", args=[self.pk])
-
     def clean(self):
         super().clean()
 
@@ -1385,18 +1281,6 @@ class VLAN(PrimaryModel, StatusModel, RoleModelMixin):
                 }
             )
 
-    def to_csv(self):
-        return (
-            self.location.name if self.location else None,
-            self.vlan_group.name if self.vlan_group else None,
-            self.vid,
-            self.name,
-            self.tenant.name if self.tenant else None,
-            self.get_status_display(),
-            self.role.name if self.role else None,
-            self.description,
-        )
-
     @property
     def display(self):
         return f"{self.name} ({self.vid})"
@@ -1457,15 +1341,6 @@ class Service(PrimaryModel):
     )
     description = models.CharField(max_length=200, blank=True)
 
-    csv_headers = [
-        "device",
-        "virtual_machine",
-        "name",
-        "protocol",
-        "ports",
-        "description",
-    ]
-
     class Meta:
         ordering = (
             "protocol",
@@ -1475,13 +1350,12 @@ class Service(PrimaryModel):
     def __str__(self):
         return f"{self.name} ({self.get_protocol_display()}/{self.port_list})"
 
-    def get_absolute_url(self):
-        return reverse("ipam:service", args=[self.pk])
-
     @property
     def parent(self):
         return self.device or self.virtual_machine
 
+    natural_key_field_names = ["name", "device", "virtual_machine"]
+
     def clean(self):
         super().clean()
 
@@ -1491,16 +1365,6 @@ class Service(PrimaryModel):
         if not self.device and not self.virtual_machine:
             raise ValidationError("A service must be associated with either a device or a virtual machine.")
 
-    def to_csv(self):
-        return (
-            self.device.name if self.device else None,
-            self.virtual_machine.name if self.virtual_machine else None,
-            self.name,
-            self.get_protocol_display(),
-            self.ports,
-            self.description,
-        )
-
     @property
     def port_list(self):
         return array_to_string(self.ports)