Skip to content

Bgp peer

BGP Peer types that are used in input forms.

IPv4BGPPeer

Bases: BaseModel

IPv4 BGP Peer model for use in input forms.

Source code in gso/utils/types/bgp_peer.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class IPv4BGPPeer(BaseModel):
    """IPv4 BGP Peer model for use in input forms."""

    peer_address: IPv4AddressType
    authentication_key: str | None = None
    has_custom_policies: bool = False
    bfd_enabled: bool = False
    multipath_enabled: bool = False
    prefix_limit: NonNegativeInt | None = None
    ttl_security: NonNegativeInt | None = None
    is_passive: bool = False
    add_v4_multicast: bool = Field(default=False, exclude=True)
    send_default_route: bool = False

    @computed_field  # type: ignore[prop-decorator]
    @property
    def families(self) -> list[IPFamily]:
        """Convert the add multicast boolean into a list of address families."""
        return [IPFamily.V4UNICAST, IPFamily.V4MULTICAST] if self.add_v4_multicast else [IPFamily.V4UNICAST]

    @computed_field  # type: ignore[prop-decorator]
    @property
    def ip_type(self) -> IPTypes:
        """Return the IP version number of this BGP peer.

        This is not an attribute of the class, as that would make it appear in input forms, which we want to avoid.
        """
        return IPTypes.IPV4

families property

Convert the add multicast boolean into a list of address families.

ip_type property

Return the IP version number of this BGP peer.

This is not an attribute of the class, as that would make it appear in input forms, which we want to avoid.

IPv6BGPPeer

Bases: BaseModel

IPv6 BGP Peer model for use in input forms.

Source code in gso/utils/types/bgp_peer.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
class IPv6BGPPeer(BaseModel):
    """IPv6 BGP Peer model for use in input forms."""

    peer_address: IPv6AddressType
    authentication_key: str | None = None
    has_custom_policies: bool = False
    bfd_enabled: bool = False
    multipath_enabled: bool = False
    prefix_limit: NonNegativeInt | None = None
    ttl_security: NonNegativeInt | None = None
    is_passive: bool = False
    add_v6_multicast: bool = Field(default=False, exclude=True)
    send_default_route: bool = False

    @computed_field  # type: ignore[prop-decorator]
    @property
    def families(self) -> list[IPFamily]:
        """Convert the add multicast boolean into a list of address families."""
        return [IPFamily.V6UNICAST, IPFamily.V6MULTICAST] if self.add_v6_multicast else [IPFamily.V6UNICAST]

    @computed_field  # type: ignore[prop-decorator]
    @property
    def ip_type(self) -> IPTypes:
        """Return the IP version number of this BGP peer.

        This is not an attribute of the class, as that would make it appear in input forms, which we want to avoid.
        """
        return IPTypes.IPV6

families property

Convert the add multicast boolean into a list of address families.

ip_type property

Return the IP version number of this BGP peer.

This is not an attribute of the class, as that would make it appear in input forms, which we want to avoid.

BGPPeerImportModelSimple

Bases: BaseModel

BGP Peer model excluding prefix limit field.

This model is used in import workflows where the IP families are already known and don't have to be calculated from an input form.

Source code in gso/utils/types/bgp_peer.py 
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
class BGPPeerImportModelSimple(BaseModel):
    """BGP Peer model excluding prefix limit field.

    This model is used in import workflows where the IP families are already known and don't have to be calculated
    from an input form.
    """

    peer_address: IPAddress
    authentication_key: str | None
    has_custom_policies: bool = False
    bfd_enabled: bool = False
    multipath_enabled: bool = False
    ttl_security: NonNegativeInt | None = None
    is_passive: bool = False
    families: list[IPFamily]
    is_multi_hop: bool
    rtbh_enabled: bool
    send_default_route: bool = False

BGPPeerImportModelFull

Bases: BGPPeerImportModelSimple

BGP Peer import model including all fields.

Source code in gso/utils/types/bgp_peer.py 
89
90
91
92
class BGPPeerImportModelFull(BGPPeerImportModelSimple):
    """BGP Peer import model including all fields."""

    prefix_limit: NonNegativeInt | None = None