BGP Models API Package¶
nautobot_bgp_models.api
¶
REST API module for nautobot_bgp_models plugin.
filter_backends
¶
Filter Backeds in use by BGP models plugin.
IncludeInheritedFilterBackend
¶
Bases: DjangoFilterBackend
Custom filtering backend for use with django-rest-framework and django-filters.
Source code in nautobot_bgp_models/api/filter_backends.py
get_filterset_kwargs(request, queryset, view)
¶
Get the kwargs that should be passed through when constructing a FilterSet corresponding to a given request.
This extends the base DjangoFilterBackend method to explicitly exclude query parameters that we know to be non-filterset parameters.
Source code in nautobot_bgp_models/api/filter_backends.py
nested_serializers
¶
Nested/brief alternate REST API serializers for nautobot_bgp_models models.
NestedAddressFamilySerializer
¶
Bases: WritableNestedSerializer
Nested/brief serializer for AddressFamily.
Source code in nautobot_bgp_models/api/nested_serializers.py
NestedAutonomousSystemSerializer
¶
Bases: WritableNestedSerializer
Nested/brief serializer for AutonomousSystem.
Source code in nautobot_bgp_models/api/nested_serializers.py
NestedBGPRoutingInstanceSerializer
¶
Bases: WritableNestedSerializer
Nested/brief serializer for PeerEndpoint.
Source code in nautobot_bgp_models/api/nested_serializers.py
NestedPeerEndpointAddressFamilySerializer
¶
Bases: WritableNestedSerializer
Nested/brief serializer for PeerEndpointAddressFamily.
Source code in nautobot_bgp_models/api/nested_serializers.py
NestedPeerEndpointSerializer
¶
Bases: WritableNestedSerializer
Nested/brief serializer for PeerEndpoint.
Source code in nautobot_bgp_models/api/nested_serializers.py
NestedPeerGroupAddressFamilySerializer
¶
Bases: WritableNestedSerializer
Nested/brief serializer for PeerGroupAddressFamily.
Source code in nautobot_bgp_models/api/nested_serializers.py
NestedPeerGroupSerializer
¶
Bases: WritableNestedSerializer
Nested/brief serializer for PeerGroup.
Source code in nautobot_bgp_models/api/nested_serializers.py
NestedPeerGroupTemplateSerializer
¶
Bases: WritableNestedSerializer
Nested/brief serializer for PeerGroup.
Source code in nautobot_bgp_models/api/nested_serializers.py
NestedPeeringRoleSerializer
¶
Bases: WritableNestedSerializer
Nested/brief serializer for PeeringRole.
Source code in nautobot_bgp_models/api/nested_serializers.py
NestedPeeringSerializer
¶
Bases: WritableNestedSerializer
Nested/brief serializer for Peering.
Source code in nautobot_bgp_models/api/nested_serializers.py
serializers
¶
REST API serializers for nautobot_bgp_models models.
AddressFamilySerializer
¶
Bases: NautobotModelSerializer
, ExtraAttributesSerializerMixin
REST API serializer for AddressFamily records.
Source code in nautobot_bgp_models/api/serializers.py
AutonomousSystemSerializer
¶
Bases: NautobotModelSerializer
, TaggedModelSerializerMixin
, StatusModelSerializerMixin
REST API serializer for AutonomousSystem records.
Source code in nautobot_bgp_models/api/serializers.py
BGPRoutingInstanceSerializer
¶
Bases: NautobotModelSerializer
, StatusModelSerializerMixin
, ExtraAttributesSerializerMixin
REST API serializer for Peering records.
Source code in nautobot_bgp_models/api/serializers.py
ExtraAttributesSerializerMixin
¶
Bases: Serializer
Common mixin for BGP Extra Attributes.
Source code in nautobot_bgp_models/api/serializers.py
to_representation(instance)
¶
Render the model instance to a Python dict.
If include_inherited
is specified as a request parameter, include object's get_extra_attributes().
Source code in nautobot_bgp_models/api/serializers.py
InheritableFieldsSerializerMixin
¶
Common mixin for Serializers that support an additional include_inherited
query parameter.
Source code in nautobot_bgp_models/api/serializers.py
to_representation(instance)
¶
Render the model instance to a Python dict.
If include_inherited
is specified as a request parameter, include inherited field values as appropriate.
Source code in nautobot_bgp_models/api/serializers.py
PeerEndpointAddressFamilySerializer
¶
Bases: NautobotModelSerializer
, ExtraAttributesSerializerMixin
REST API serializer for PeerEndpointAddressFamily records.
Source code in nautobot_bgp_models/api/serializers.py
PeerEndpointSerializer
¶
Bases: InheritableFieldsSerializerMixin
, TaggedModelSerializerMixin
, NautobotModelSerializer
, ExtraAttributesSerializerMixin
REST API serializer for PeerEndpoint records.
Source code in nautobot_bgp_models/api/serializers.py
create(validated_data)
¶
Create a new PeerEndpoint and update the peer on both sides.
update(instance, validated_data)
¶
When updating an existing PeerEndpoint, ensure peer is properly setup on both side.
Source code in nautobot_bgp_models/api/serializers.py
PeerGroupAddressFamilySerializer
¶
Bases: NautobotModelSerializer
, ExtraAttributesSerializerMixin
REST API serializer for PeerGroupAddressFamily records.
Source code in nautobot_bgp_models/api/serializers.py
PeerGroupSerializer
¶
Bases: InheritableFieldsSerializerMixin
, NautobotModelSerializer
, ExtraAttributesSerializerMixin
REST API serializer for PeerGroup records.
Source code in nautobot_bgp_models/api/serializers.py
validate(data)
¶
Custom validation logic to handle unique-together with a nullable field.
Source code in nautobot_bgp_models/api/serializers.py
PeerGroupTemplateSerializer
¶
Bases: NautobotModelSerializer
, ExtraAttributesSerializerMixin
REST API serializer for PeerGroup records.
Source code in nautobot_bgp_models/api/serializers.py
PeeringRoleSerializer
¶
Bases: NautobotModelSerializer
REST API serializer for PeeringRole records.
Source code in nautobot_bgp_models/api/serializers.py
PeeringSerializer
¶
Bases: NautobotModelSerializer
, StatusModelSerializerMixin
REST API serializer for Peering records.
Source code in nautobot_bgp_models/api/serializers.py
urls
¶
REST API URL registration for nautobot_bgp_models.
views
¶
REST API viewsets for nautobot_bgp_models.
AddressFamilyViewSet
¶
Bases: InheritableFieldsViewSetMixin
, PluginModelViewSet
REST API viewset for AddressFamily records.
Source code in nautobot_bgp_models/api/views.py
AutonomousSystemViewSet
¶
Bases: PluginModelViewSet
, StatusViewSetMixin
REST API viewset for AutonomousSystem records.
Source code in nautobot_bgp_models/api/views.py
BGPRoutingInstanceViewSet
¶
Bases: PluginModelViewSet
, StatusViewSetMixin
REST API viewset for BGPRoutingInstance records.
Source code in nautobot_bgp_models/api/views.py
InheritableFieldsViewSetMixin
¶
Common mixin for ViewSets that support an additional include_inherited
query parameter.
Source code in nautobot_bgp_models/api/views.py
list(request)
¶
PeerEndpointAddressFamilyViewSet
¶
Bases: InheritableFieldsViewSetMixin
, PluginModelViewSet
REST API viewset for PeerEndpointAddressFamily records.
Source code in nautobot_bgp_models/api/views.py
PeerEndpointViewSet
¶
Bases: InheritableFieldsViewSetMixin
, PluginModelViewSet
REST API viewset for PeerEndpoint records.
Source code in nautobot_bgp_models/api/views.py
PeerGroupAddressFamilyViewSet
¶
Bases: InheritableFieldsViewSetMixin
, PluginModelViewSet
REST API viewset for PeerGroupAddressFamily records.
Source code in nautobot_bgp_models/api/views.py
PeerGroupTemplateViewSet
¶
Bases: InheritableFieldsViewSetMixin
, PluginModelViewSet
REST API viewset for PeerGroupTemplate records.
Source code in nautobot_bgp_models/api/views.py
PeerGroupViewSet
¶
Bases: InheritableFieldsViewSetMixin
, PluginModelViewSet
REST API viewset for PeerGroup records.
Source code in nautobot_bgp_models/api/views.py
PeeringRoleViewSet
¶
Bases: PluginModelViewSet
REST API viewset for PeeringRole records.
Source code in nautobot_bgp_models/api/views.py
PeeringViewSet
¶
Bases: PluginModelViewSet
, StatusViewSetMixin
REST API viewset for Peering records.
Source code in nautobot_bgp_models/api/views.py
PluginModelViewSet
¶
Bases: NautobotModelViewSet
Base class for all REST API viewsets in this plugin.
Source code in nautobot_bgp_models/api/views.py
get_serializer_class()
¶
Override the default ModelViewSet implementation as it doesn't handle plugins correctly.