netbox/netbox/ipam/models/vrfs.py

from django.db import models
from django.utils.translation import gettext_lazy as _

from ipam.constants import *
from netbox.models import PrimaryModel

__all__ = (
    'VRF',
    'RouteTarget',
)


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(
        verbose_name=_('name'),
        max_length=100,
        db_collation="natural_sort"
    )
    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')
    )
    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
    )

    clone_fields = (
        'tenant', 'enforce_unique', 'description',
    )

    class Meta:
        ordering = ('name', 'rd', 'pk')  # (name, rd) may be non-unique
        indexes = (
            models.Index(fields=('name', 'rd', 'id')),  # Default ordering
        )
        verbose_name = _('VRF')
        verbose_name_plural = _('VRFs')

    def __str__(self):
        if self.rd:
            return f'{self.name} ({self.rd})'
        return self.name


class RouteTarget(PrimaryModel):
    """
    A BGP extended community used to control the redistribution of routes among VRFs, as defined in RFC 4364.
    """
    name = models.CharField(
        verbose_name=_('name'),
        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)'),
        db_collation="natural_sort"
    )
    tenant = models.ForeignKey(
        to='tenancy.Tenant',
        on_delete=models.PROTECT,
        related_name='route_targets',
        blank=True,
        null=True
    )

    class Meta:
        ordering = ['name']
        verbose_name = _('route target')
        verbose_name_plural = _('route targets')

    def __str__(self):
        return self.name