Skip to content

Service binding port

Service Binding Port.

A service binding port is used to logically attach an edge port to a customer service using a VLAN.

BFDSettingsInactive

Bases: ProductBlockModel

Settings for BFD, see BFDSettings.

Source code in gso/products/product_blocks/service_binding_port.py 
21
22
23
24
25
26
27
28
29
class BFDSettingsInactive(
    ProductBlockModel, lifecycle=[SubscriptionLifecycle.INITIAL], product_block_name="BFDSettings"
):
    """Settings for BFD, see `BFDSettings`."""

    bfd_enabled: bool = False
    bfd_interval_rx: int | None = None
    bfd_interval_tx: int | None = None
    bfd_multiplier: int | None = None

BFDSettingsProvisioning

Bases: BFDSettingsInactive

Settings for BFD, see BFDSettings.

Source code in gso/products/product_blocks/service_binding_port.py 
32
33
34
35
36
37
38
class BFDSettingsProvisioning(BFDSettingsInactive, lifecycle=[SubscriptionLifecycle.PROVISIONING]):
    """Settings for BFD, see `BFDSettings`."""

    bfd_enabled: bool
    bfd_interval_rx: int | None = None
    bfd_interval_tx: int | None = None
    bfd_multiplier: int | None

BFDSettings

Bases: BFDSettingsProvisioning

A set of settings for BFD.

Attributes:

Name Type Description
bfd_enabled bool

Whether BFD is enabled.
bfd_interval_rx int | None

The BFD interval RX, if enabled.
bfd_interval_tx int | None

The BFD interval TX, if enabled.
bfd_multiplier int | None

The BFD multiplier, if enabled.
Source code in gso/products/product_blocks/service_binding_port.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class BFDSettings(BFDSettingsProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
    """A set of settings for BFD.

    Attributes:
        bfd_enabled: Whether BFD is enabled.
        bfd_interval_rx: The BFD interval RX, if enabled.
        bfd_interval_tx: The BFD interval TX, if enabled.
        bfd_multiplier: The BFD multiplier, if enabled.
    """

    bfd_enabled: bool
    bfd_interval_rx: int | None
    bfd_interval_tx: int | None
    bfd_multiplier: int | None

ServiceBindingPortInactive

Bases: ProductBlockModel

A Service Binding Port that's currently inactive. See ServiceBindingPort.

Source code in gso/products/product_blocks/service_binding_port.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
class ServiceBindingPortInactive(
    ProductBlockModel, lifecycle=[SubscriptionLifecycle.INITIAL], product_block_name="ServiceBindingPort"
):
    """A Service Binding Port that's currently inactive. See `ServiceBindingPort`."""

    is_tagged: bool | None = None
    vlan_id: VLAN_ID | None = None
    sbp_type: SBPType | None = None
    ipv4_address: IPv4AddressType | None = None
    ipv4_mask: IPv4Netmask | None = None
    ipv6_address: IPv6AddressType | None = None
    ipv6_mask: IPv6Netmask | None = None
    custom_firewall_filters: bool | None = None
    gs_id: str | None = None
    bgp_session_list: list[BGPSessionInactive] = Field(default_factory=list)
    edge_port: EdgePortBlockInactive | None = None
    v4_bfd_settings: BFDSettingsInactive
    v6_bfd_settings: BFDSettingsInactive

ServiceBindingPortProvisioning

Bases: ServiceBindingPortInactive

A Service Binding Port that's currently being provisioned. See ServiceBindingPort.

Source code in gso/products/product_blocks/service_binding_port.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
class ServiceBindingPortProvisioning(ServiceBindingPortInactive, lifecycle=[SubscriptionLifecycle.PROVISIONING]):
    """A Service Binding Port that's currently being provisioned. See `ServiceBindingPort`."""

    is_tagged: bool
    vlan_id: VLAN_ID | None = None
    sbp_type: SBPType
    ipv4_address: IPv4AddressType | None = None
    ipv4_mask: IPv4Netmask | None = None
    ipv6_address: IPv6AddressType | None = None
    ipv6_mask: IPv6Netmask | None = None
    custom_firewall_filters: bool
    gs_id: str
    bgp_session_list: list[BGPSessionProvisioning]  # type: ignore[assignment]
    edge_port: EdgePortBlockProvisioning
    v4_bfd_settings: BFDSettingsProvisioning
    v6_bfd_settings: BFDSettingsProvisioning

ServiceBindingPort

Bases: ServiceBindingPortProvisioning

A service binding port that is actively used in the network.

Attributes:

Name Type Description
is_tagged bool

Whether this VLAN is tagged or not.
vlan_id VLAN_ID | None

The VLAN ID.
sbp_type SBPType

Is this service binding port layer 2 or 3?
ipv4_address IPv4AddressType | None

If layer 3, IPv4 resources.
ipv4_mask IPv4Netmask | None

IPv4 subnet mask.
ipv6_address IPv6AddressType | None

If layer 3, IPv6 resources.
ipv6_mask IPv6Netmask | None

IPv6 subnet mask.
custom_firewall_filters bool

Any custom firewall filters that the partner may require.
gs_id str

The GÉANT service ID of this binding port.
bgp_session_list list[BGPSession]

The BGP sessions associated with this service binding port.
edge_port EdgePortBlock

The Edge Port on which this SBP resides.
v4_bfd_settings BFDSettings

BFD settings for IPv4.
v6_bfd_settings BFDSettings

BFD settings for IPv6.
Source code in gso/products/product_blocks/service_binding_port.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
class ServiceBindingPort(ServiceBindingPortProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
    """A service binding port that is actively used in the network.

    Attributes:
        is_tagged: Whether this VLAN is tagged or not.
        vlan_id: The VLAN ID.
        sbp_type: Is this service binding port layer 2 or 3?
        ipv4_address: If layer 3, IPv4 resources.
        ipv4_mask: IPv4 subnet mask.
        ipv6_address: If layer 3, IPv6 resources.
        ipv6_mask: IPv6 subnet mask.
        custom_firewall_filters: Any custom firewall filters that the partner may require.
        gs_id: The GÉANT service ID of this binding port.
        bgp_session_list: The BGP sessions associated with this service binding port.
        edge_port: The Edge Port on which this SBP resides.
        v4_bfd_settings: BFD settings for IPv4.
        v6_bfd_settings: BFD settings for IPv6.
    """

    is_tagged: bool
    vlan_id: VLAN_ID | None = None
    sbp_type: SBPType
    ipv4_address: IPv4AddressType | None = None
    ipv4_mask: IPv4Netmask | None = None
    ipv6_address: IPv6AddressType | None = None
    ipv6_mask: IPv6Netmask | None = None
    custom_firewall_filters: bool
    gs_id: str
    bgp_session_list: list[BGPSession]  # type: ignore[assignment]
    edge_port: EdgePortBlock
    v4_bfd_settings: BFDSettings
    v6_bfd_settings: BFDSettings