Standardize model types based on function

netbox/ipam/models/vrfs.py

@@ -0,0 +1,139 @@
+from django.db import models
+from django.urls import reverse
+from taggit.managers import TaggableManager
+
+from extras.models import TaggedItem
+from extras.utils import extras_features
+from ipam.constants import *
+from netbox.models import PrimaryModel
+from utilities.querysets import RestrictedQuerySet
+
+
+__all__ = (
+    'RouteTarget',
+    'VRF',
+)
+
+
+@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks')
+class VRF(PrimaryModel):
+    """
+    A virtual routing and forwarding (VRF) table represents a discrete layer three forwarding domain (e.g. a routing
+    table). Prefixes and IPAddresses can optionally be assigned to VRFs. (Prefixes and IPAddresses not assigned to a VRF
+    are said to exist in the "global" table.)
+    """
+    name = models.CharField(
+        max_length=100
+    )
+    rd = models.CharField(
+        max_length=VRF_RD_MAX_LENGTH,
+        unique=True,
+        blank=True,
+        null=True,
+        verbose_name='Route distinguisher',
+        help_text='Unique route distinguisher (as defined in RFC 4364)'
+    )
+    tenant = models.ForeignKey(
+        to='tenancy.Tenant',
+        on_delete=models.PROTECT,
+        related_name='vrfs',
+        blank=True,
+        null=True
+    )
+    enforce_unique = models.BooleanField(
+        default=True,
+        verbose_name='Enforce unique space',
+        help_text='Prevent duplicate prefixes/IP addresses within this VRF'
+    )
+    description = models.CharField(
+        max_length=200,
+        blank=True
+    )
+    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
+    )
+    tags = TaggableManager(through=TaggedItem)
+
+    objects = RestrictedQuerySet.as_manager()
+
+    csv_headers = ['name', 'rd', 'tenant', 'enforce_unique', 'description']
+    clone_fields = [
+        'tenant', 'enforce_unique', 'description',
+    ]
+
+    class Meta:
+        ordering = ('name', 'rd', 'pk')  # (name, rd) may be non-unique
+        verbose_name = 'VRF'
+        verbose_name_plural = 'VRFs'
+
+    def __str__(self):
+        return self.display_name 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.enforce_unique,
+            self.description,
+        )
+
+    @property
+    def display_name(self):
+        if self.rd:
+            return f'{self.name} ({self.rd})'
+        return self.name
+
+
+@extras_features('custom_fields', 'custom_links', 'export_templates', 'webhooks')
+class RouteTarget(PrimaryModel):
+    """
+    A BGP extended community used to control the redistribution of routes among VRFs, as defined in RFC 4364.
+    """
+    name = models.CharField(
+        max_length=VRF_RD_MAX_LENGTH,  # Same format options as VRF RD (RFC 4360 section 4)
+        unique=True,
+        help_text='Route target value (formatted in accordance with RFC 4360)'
+    )
+    description = models.CharField(
+        max_length=200,
+        blank=True
+    )
+    tenant = models.ForeignKey(
+        to='tenancy.Tenant',
+        on_delete=models.PROTECT,
+        related_name='route_targets',
+        blank=True,
+        null=True
+    )
+    tags = TaggableManager(through=TaggedItem)
+
+    objects = RestrictedQuerySet.as_manager()
+
+    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,
+        )