BGP Group#
Virtual Networks → BGBGP Groups
The BGPGroup enables centralized management of BGP peer configurations. This resource allows setting a description, common BGP settings, and peer-specific configurations, simplifying the consistent application of policies across multiple peers. It also includes transport settings, such as local TCP address configuration, passive mode, and TCP MSS.
A BGPGroup resource defines BGP protocol parameters that are inherited by the BGPPeer resources that reference this group. The parameters set on the BGPPeer level override the group-level parameters.
To set up BGP groups for use in the default VRF, use
DefaultBGPGroupresource.
Dependencies#
The BGP Group is not instantiated on the targeted network elements before a BGPPeer referencing it is created.
Although every group-level parameter can be overridden individually on the BGPPeer level, a BGPGroup must be created and referenced by the peer.
Referenced resources#
The following resources are referenced in the specification of the BGPGroup:
Policy#
The BGPPeer resources that the RouteReflector creates towards each selected RouteReflectorClient inherit import/export policies from the assigned BGPGroup. This behavior can be overridden by specifying policies in the RouteReflector. Click here for more information on BGP import/export policies.
KeyChain#
To secure the connection between two BGP peers, a secret authentication key can be configured in a keychain. This ensures that only BGP speakers with the password can establish a connection. Multiple keys can be defined in a Keychain to enable automatic key rollover.
Examples#
Custom Resource Definition#
To browse the Custom Resource Definition go to crd.eda.dev.
BGPGroup
SPEC
The BGPGroup enables centralized management of BGP peer configurations. This resource allows setting a description, common BGP settings, and peer-specific configurations, simplifying the consistent application of policies across multiple peers. It also includes transport settings, such as local TCP address configuration, passive mode, and TCP MSS.
-
AS Path Options
-
The maximum number of times the global AS number or a local AS number of the BGP instance can appear in any received AS_PATH before it is considered a loop and considered invalid.
default: 0range: 0 to 255 -
Options for removing private AS numbers (2-byte and 4-byte) from the advertised AS path towards all peers.
-
If set to true then do not delete or replace a private AS number that is the same as the peer AS number.
default: false -
If set to true then only delete or replace private AS numbers that appear before the first occurrence of a non-private ASN in the sequence of most recent ASNs in the AS path.
default: false -
The method by which private AS numbers are removed from the advertised AS_PATH attribute.
default: "Disabled"enum: "Disabled", "Replace", "Delete"
-
-
-
Enable or disable Bi-forward Forwarding Detection (BFD) with fast failover.
-
When set to true, all configured and dynamic BGP peers are considered RR clients.
-
Enables route reflect client and sets the cluster ID.
-
Configures the group name on the device.
-
Sets the description on the BGP group.
-
Reference to a Policy CR that will be used to filter routes advertised to peers.
-
Enables Graceful Restart on the peer and sets the stale route time in seconds.
range: 1 to 3600 -
Reference to a Policy CR that will be used to filter routes received from peers.
-
Parameters relating to the IPv4 unicast AFI/SAFI.
-
Enables advertisement of IPv4 Unicast routes with IPv6 next-hops to peers.
-
Enables the IPv4 unicast AFISAFI.
-
Configures the maximum number of IPv4 unicast prefixes that can be received from a BGP peer.
-
Configuration of the maximum number of prefixes that can be accepted from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting only accepted routes.
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be accepted before a warning is logged.
range: 1 to 100
-
-
Configuration of the maximum number of prefixes that can be received from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting all routes (accepted and rejected by import policies).
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be received before a warning is logged.
range: 1 to 100
-
-
-
Enables the advertisement of the RFC 5549 capability to receive IPv4 routes with IPv6 next-hops.
-
-
Parameters relating to the IPv6 unicast AFI/SAFI.
-
Enables the IPv6 unicast AFISAFI
-
Enables advertisement of IPv6 Unicast routes with IPv4 next-hops to peers.
-
Configuration of the maximum number of prefixes that can be accepted from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting only accepted routes.
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be accepted before a warning is logged.
range: 1 to 100
-
-
Configuration of the maximum number of prefixes that can be received from a BGP peer.
-
Defines the action to take when the maximum number of prefixes is exceeded. Session is reset if set to false, otherwise only a warning is logged.
-
Maximum number of prefixes allowed to be received from the neighbor, counting all routes (accepted and rejected by import policies).
format: int32range: 1 to 4294967295 -
A percentage of the maximum number of prefixes that can be received before a warning is logged.
range: 1 to 100
-
-
-
-
Reference to a Keychain resource that will be used for authentication with the BGP peer.
-
The local autonomous system number advertised to peers.
-
Local Autonomous System number.
range: 1 to 4294967295 -
When set to true, the global ASN value is prepended to the AS path in outbound routes towards each BGP peer.
-
When set to true, the local AS value is prepended to the AS path of inbound routes from each EBGP peer.
-
-
Local Preference attribute added to received routes from the BGP peers, also sets local preference for generated routes.
range: 0 to 4294967295 -
Enable multihop for eBGP peers and sets the maximum number of hops allowed.
range: 1 to 255 -
When set to true, the next-hop in all IPv4-unicast, IPv6-unicast and EVPN BGP routes advertised to the peer is set to the local-address.
-
When false, all large (12 byte) BGP communities from all outbound routes advertised to the peer are stripped.
-
When false, all standard (4 byte) communities from all outbound routes advertised to the peer are stripped.
-
Options for controlling the generation of default routes towards BGP peers.
-
Enables the sending of a synthetically generated default IPv4 or IPV6 route to each peer.
-
Reference to a Policy that should be applied to the advertised default routes, in order to set their attributes to non-default values.
-
-
Timer configurations
-
The time interval in seconds between successive attempts to establish a session with a peer.
range: 1 to 65535 -
The hold-time interval in seconds that the router proposes to the peer in its OPEN message.
range: 0 to 65535 -
The interval in seconds between successive keepalive messages sent to the peer.
range: 0 to 21845 -
The value assigned to the MinRouteAdvertisementIntervalTimer of RFC 4271, for both EBGP and IBGP sessions, in seconds.
range: 1 to 255
-
STATUS
BGPGroupStatus defines the observed state of BGPGroup
-
Indicates the health score of the BGP group.
-
Indicates the reason for the health score.
-
The time when the state of the resource last changed.
-
Number of configured BGP peers within the BGP Group.
format: int32 -
Number of configured BGP peers which have an Operational State of down within the BGP Group.
format: int32 -
Number of configured BGP peers within the BGP Group which cannot be reached by npp.
format: int32 -
Operational state of the BGP group.
enum: "Up", "Down", "Degraded", "Unknown"