netbox-routing-plugin 1.0.0__py3-none-any.whl

netbox_routing_plugin/__init__.py

@@ -0,0 +1,29 @@
+from netbox.plugins import PluginConfig
+from importlib.metadata import metadata
+
+plugin = metadata('netbox-routing-plugin')
+
+
+class NetboxRouting(PluginConfig):
+    # The distribution is published as netbox-routing-plugin, but the app
+    # label, URLs and migrations stay under the module name.
+    name = 'netbox_routing_plugin'
+    verbose_name = 'Netbox Routing Protocols'
+    description = plugin.get('Summary')
+    version = plugin.get('Version')
+    author = plugin.get('Author')
+    author_email = plugin.get('Author-email')
+    base_url = 'routing'
+    min_version = '4.7.0'
+    required_settings = []
+    caching_config = {}
+    default_settings = {}
+    graphql_schema = 'graphql.schema.schema'
+
+    def ready(self):
+        super().ready()
+
+        from netbox_routing_plugin import signals  # noqa: F401
+
+
+config = NetboxRouting

netbox_routing_plugin/api/_serializers/bgp.py

@@ -0,0 +1,408 @@
+from rest_framework import serializers
+
+from dcim.api.serializers_.devices import DeviceSerializer
+from ipam.api.serializers_.asns import ASNSerializer
+from dcim.api.serializers_.device_components import InterfaceSerializer
+from ipam.api.serializers_.ip import IPAddressSerializer, PrefixSerializer
+from ipam.api.serializers_.vrfs import VRFSerializer
+from ipam.models import ASN
+from netbox.api.fields import SerializedPKRelatedField
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_routing_plugin.api._serializers.objects import (
+    PrefixListSerializer,
+    RoutePolicySerializer,
+)
+from netbox_routing_plugin.models import (
+    EIGRPAddressFamily,
+    ISISInstance,
+    OSPFInstance,
+)
+from netbox_routing_plugin.models.bgp import *
+
+__all__ = (
+    'BGPInstanceSerializer',
+    'BGPAddressFamilySerializer',
+    'BGPPeerGroupSerializer',
+    'BGPListenRangeSerializer',
+    'BGPRedistributionSerializer',
+    'BGPOriginatedNetworkSerializer',
+    'BGPAggregateSerializer',
+    'BGPPeerSerializer',
+    'BGPPeerAddressFamilySerializer',
+    'BFDProfileSerializer',
+)
+
+_COMMON = (
+    'description',
+    'comments',
+    'tags',
+    'custom_fields',
+    'created',
+    'last_updated',
+)
+_SESSION = (
+    'remote_as',
+    'local_as',
+    'enabled',
+    'bfd',
+    'ebgp_multihop',
+    'ttl_security_hops',
+    'passive',
+    'as_override',
+    'soft_reconfiguration_inbound',
+    'graceful_shutdown',
+    'import_policy',
+    'export_policy',
+    'passphrase',
+    'passphrase_md5',
+    'show_md5',
+    'route_reflector_client',
+    'extended_nexthop',
+    'keepalive',
+    'hold_time',
+)
+
+
+class BGPInstanceSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:bgpinstance-detail'
+    )
+    device = DeviceSerializer(nested=True)
+    vrf = VRFSerializer(nested=True, required=False, allow_null=True)
+    asn = ASNSerializer(nested=True)
+    confederation_identifier = ASNSerializer(
+        nested=True, required=False, allow_null=True
+    )
+    confederation_peers = SerializedPKRelatedField(
+        queryset=ASN.objects.all(),
+        serializer=ASNSerializer,
+        nested=True,
+        required=False,
+        many=True,
+    )
+    import_policy = RoutePolicySerializer(nested=True, required=False, allow_null=True)
+    export_policy = RoutePolicySerializer(nested=True, required=False, allow_null=True)
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = BGPInstance
+        fields = (
+            'url',
+            'id',
+            'display',
+            'name',
+            'device',
+            'vrf',
+            'asn',
+            'router_id',
+            'asdot',
+            'cluster_id',
+            'confederation_identifier',
+            'confederation_peers',
+            'graceful_restart',
+            'graceful_restart_time',
+            'graceful_restart_stale_time',
+            'graceful_restart_helper_only',
+            'import_policy',
+            'export_policy',
+            'tenant',
+            *_COMMON,
+        )
+        brief_fields = ('url', 'id', 'display', 'name', 'device', 'vrf', 'asn')
+
+    def validate(self, data):
+        data = super().validate(data)
+        instance = self.instance
+        peers = data.get(
+            'confederation_peers',
+            instance.confederation_peers.all() if instance else [],
+        )
+        errors = BGPInstance.confederation_errors(
+            data.get('asn', instance.asn if instance else None),
+            data.get(
+                'confederation_identifier',
+                instance.confederation_identifier if instance else None,
+            ),
+            peers,
+        )
+        if errors:
+            raise serializers.ValidationError(errors)
+        return data
+
+
+class BGPAddressFamilySerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:bgpaddressfamily-detail'
+    )
+    instance = BGPInstanceSerializer(nested=True)
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = BGPAddressFamily
+        fields = (
+            'url',
+            'id',
+            'display',
+            'instance',
+            'address_family',
+            'maximum_paths',
+            'default_metric',
+            'default_originate',
+            'auto_summary',
+            'distance_ebgp',
+            'distance_ibgp',
+            'additional_paths_send',
+            'additional_paths_receive',
+            'additional_paths_install',
+            'long_lived_stale_time',
+            'tenant',
+            *_COMMON,
+        )
+        brief_fields = ('url', 'id', 'display', 'instance', 'address_family')
+
+
+class BGPPeerGroupSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:bgppeergroup-detail'
+    )
+    instance = BGPInstanceSerializer(nested=True)
+    remote_as = ASNSerializer(nested=True, required=False, allow_null=True)
+    local_as = ASNSerializer(nested=True, required=False, allow_null=True)
+    bfd = serializers.PrimaryKeyRelatedField(
+        queryset=BFDProfile.objects.all(), required=False, allow_null=True
+    )
+    passphrase_md5 = serializers.CharField(
+        source='md5_digest', read_only=True, allow_null=True
+    )
+    import_policy = RoutePolicySerializer(nested=True, required=False, allow_null=True)
+    export_policy = RoutePolicySerializer(nested=True, required=False, allow_null=True)
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = BGPPeerGroup
+        fields = (
+            'url',
+            'id',
+            'display',
+            'name',
+            'instance',
+            'listen_limit',
+            *_SESSION,
+            'tenant',
+            *_COMMON,
+        )
+        brief_fields = ('url', 'id', 'display', 'name', 'instance')
+
+
+class BGPListenRangeSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:bgplistenrange-detail'
+    )
+    peer_group = BGPPeerGroupSerializer(nested=True)
+    prefix = PrefixSerializer(nested=True)
+
+    class Meta:
+        model = BGPListenRange
+        fields = ('url', 'id', 'display', 'peer_group', 'prefix', *_COMMON)
+        brief_fields = ('url', 'id', 'display', 'peer_group', 'prefix')
+
+
+class BGPRedistributionSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:bgpredistribution-detail'
+    )
+    address_family = BGPAddressFamilySerializer(nested=True)
+    # the sources are the OSPF, IS-IS and EIGRP serializers' modules, which import this one
+    ospf_source = serializers.PrimaryKeyRelatedField(
+        queryset=OSPFInstance.objects.all(), required=False, allow_null=True
+    )
+    isis_source = serializers.PrimaryKeyRelatedField(
+        queryset=ISISInstance.objects.all(), required=False, allow_null=True
+    )
+    eigrp_source = serializers.PrimaryKeyRelatedField(
+        queryset=EIGRPAddressFamily.objects.all(), required=False, allow_null=True
+    )
+    route_policy = RoutePolicySerializer(nested=True, required=False, allow_null=True)
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = BGPRedistribution
+        fields = (
+            'url',
+            'id',
+            'display',
+            'address_family',
+            'protocol',
+            'ospf_source',
+            'isis_source',
+            'eigrp_source',
+            'metric',
+            'route_policy',
+            'ospf_match',
+            'tenant',
+            *_COMMON,
+        )
+        brief_fields = ('url', 'id', 'display', 'address_family', 'protocol')
+
+
+class BGPOriginatedNetworkSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:bgporiginatednetwork-detail'
+    )
+    address_family = BGPAddressFamilySerializer(nested=True)
+    prefix = PrefixSerializer(nested=True)
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = BGPOriginatedNetwork
+        fields = (
+            'url',
+            'id',
+            'display',
+            'address_family',
+            'prefix',
+            'tenant',
+            *_COMMON,
+        )
+        brief_fields = ('url', 'id', 'display', 'address_family', 'prefix')
+
+
+class BGPAggregateSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:bgpaggregate-detail'
+    )
+    address_family = BGPAddressFamilySerializer(nested=True)
+    prefix = PrefixSerializer(nested=True)
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = BGPAggregate
+        fields = (
+            'url',
+            'id',
+            'display',
+            'address_family',
+            'prefix',
+            'summary_only',
+            'as_set',
+            'tenant',
+            *_COMMON,
+        )
+        brief_fields = ('url', 'id', 'display', 'address_family', 'prefix')
+
+
+class BGPPeerSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:bgppeer-detail'
+    )
+    instance = BGPInstanceSerializer(nested=True)
+    peer = IPAddressSerializer(nested=True, required=False, allow_null=True)
+    interface = InterfaceSerializer(nested=True, required=False, allow_null=True)
+    source = IPAddressSerializer(nested=True, required=False, allow_null=True)
+    peer_group = BGPPeerGroupSerializer(nested=True, required=False, allow_null=True)
+    remote_as = ASNSerializer(nested=True, required=False, allow_null=True)
+    local_as = ASNSerializer(nested=True, required=False, allow_null=True)
+    bfd = serializers.PrimaryKeyRelatedField(
+        queryset=BFDProfile.objects.all(), required=False, allow_null=True
+    )
+    passphrase_md5 = serializers.CharField(
+        source='md5_digest', read_only=True, allow_null=True
+    )
+    import_policy = RoutePolicySerializer(nested=True, required=False, allow_null=True)
+    export_policy = RoutePolicySerializer(nested=True, required=False, allow_null=True)
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = BGPPeer
+        fields = (
+            'url',
+            'id',
+            'display',
+            'name',
+            'instance',
+            'peer',
+            'interface',
+            'source',
+            'peer_group',
+            'status',
+            *_SESSION,
+            'tenant',
+            *_COMMON,
+        )
+        brief_fields = ('url', 'id', 'display', 'name', 'instance', 'peer')
+
+
+class BGPPeerAddressFamilySerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:bgppeeraddressfamily-detail'
+    )
+    peer = BGPPeerSerializer(nested=True, required=False, allow_null=True)
+    peer_group = BGPPeerGroupSerializer(nested=True, required=False, allow_null=True)
+    address_family = BGPAddressFamilySerializer(nested=True)
+    prefixlist_in = PrefixListSerializer(nested=True, required=False, allow_null=True)
+    prefixlist_out = PrefixListSerializer(nested=True, required=False, allow_null=True)
+    import_policy = RoutePolicySerializer(nested=True, required=False, allow_null=True)
+    export_policy = RoutePolicySerializer(nested=True, required=False, allow_null=True)
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = BGPPeerAddressFamily
+        fields = (
+            'url',
+            'id',
+            'display',
+            'peer',
+            'peer_group',
+            'address_family',
+            'enabled',
+            'prefixlist_in',
+            'prefixlist_out',
+            'import_policy',
+            'export_policy',
+            'send_community',
+            'next_hop_self',
+            'remove_private_as',
+            'allowas_in',
+            'maximum_prefix',
+            'maximum_prefix_warning',
+            'maximum_prefix_action',
+            'maximum_prefix_restart',
+            'tenant',
+            *_COMMON,
+        )
+        brief_fields = ('url', 'id', 'display', 'peer', 'peer_group', 'address_family')
+
+
+class BFDProfileSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:bfdprofile-detail'
+    )
+    tenant = TenantSerializer(nested=True, required=False)
+
+    class Meta:
+        model = BFDProfile
+        fields = (
+            'url',
+            'id',
+            'display',
+            'description',
+            'comments',
+            'name',
+            'min_rx_int',
+            'min_tx_int',
+            'multiplier',
+            'mode',
+            'min_echo_rx_int',
+            'authentication',
+            'authentication_key_id',
+            'passphrase',
+            'tenant',
+        )
+        brief_fields = (
+            'url',
+            'id',
+            'display',
+            'name',
+        )

netbox_routing_plugin/api/_serializers/community.py

@@ -0,0 +1,141 @@
+from django.core.exceptions import ValidationError as DjangoValidationError
+from rest_framework import serializers
+
+from ipam.api.serializers_.roles import RoleSerializer
+from netbox.api.fields import ChoiceField
+from netbox.api.serializers import PrimaryModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_routing_plugin.choices import (
+    ActionChoices,
+    CommunityStatusChoices,
+    CommunityTypeChoices,
+)
+from netbox_routing_plugin.helpers import community as community_helpers
+from netbox_routing_plugin.models.community import *
+
+__all__ = (
+    'CommunityListSerializer',
+    'CommunitySerializer',
+    'CommunityListEntrySerializer',
+)
+
+
+class CommunitySerializer(PrimaryModelSerializer):
+    """`type` and `well_known` are derived from `community`, which is stored normalised"""
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:community-detail'
+    )
+    status = ChoiceField(choices=CommunityStatusChoices, required=False)
+    type = ChoiceField(choices=CommunityTypeChoices, read_only=True)
+    well_known = serializers.CharField(read_only=True)
+    role = RoleSerializer(nested=True, required=False)
+    tenant = TenantSerializer(nested=True, required=False)
+
+    class Meta:
+        model = Community
+        fields = (
+            'url',
+            'id',
+            'display',
+            'name',
+            'community',
+            'type',
+            'well_known',
+            'role',
+            'status',
+            'tenant',
+            'description',
+            'owner',
+            'comments',
+            'tags',
+            'custom_fields',
+            'created',
+            'last_updated',
+        )
+        brief_fields = ('url', 'id', 'display', 'name', 'community', 'description')
+
+
+class CommunityListSerializer(PrimaryModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:communitylist-detail'
+    )
+    type = ChoiceField(choices=CommunityTypeChoices, required=False)
+    tenant = TenantSerializer(nested=True, required=False)
+
+    class Meta:
+        model = CommunityList
+        fields = (
+            'url',
+            'id',
+            'display',
+            'name',
+            'type',
+            'tenant',
+            'description',
+            'owner',
+            'comments',
+            'tags',
+            'custom_fields',
+            'created',
+            'last_updated',
+        )
+        brief_fields = ('url', 'id', 'display', 'name', 'description')
+
+
+class CommunityListEntrySerializer(PrimaryModelSerializer):
+    """An empty `sequence` takes the next free one of the list"""
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name='plugins-api:netbox_routing_plugin-api:communitylistentry-detail'
+    )
+    community_list = CommunityListSerializer(nested=True)
+    community = CommunitySerializer(nested=True)
+    action = ChoiceField(choices=ActionChoices)
+
+    class Meta:
+        model = CommunityListEntry
+        extra_kwargs = {'sequence': {'required': False, 'allow_null': True}}
+        fields = (
+            'url',
+            'id',
+            'display',
+            'community_list',
+            'sequence',
+            'action',
+            'community',
+            'description',
+            'owner',
+            'comments',
+            'tags',
+            'custom_fields',
+            'created',
+            'last_updated',
+        )
+        brief_fields = (
+            'url',
+            'id',
+            'display',
+            'community_list',
+            'sequence',
+            'action',
+            'community',
+            'description',
+        )
+
+    def validate(self, data):
+        # A new entry without sequence gets the next one of its list. The serializer of a
+        # bulk request is shared by the entries, so they get consecutive numbers.
+        if self.instance is None and data.get('sequence') is None:
+            community_list = data.get('community_list')
+            if community_list is not None:
+                assigned = self.context.setdefault('community_list_sequences', {})
+                try:
+                    sequence = community_helpers.next_sequence(
+                        community_list, assigned.get(community_list.pk, 0)
+                    )
+                except DjangoValidationError as e:
+                    raise serializers.ValidationError({'sequence': e.messages})
+                assigned[community_list.pk] = data['sequence'] = sequence
+        return super().validate(data)