BGP Objects

This page contains descriptions of the BGP Layer 3 configuration objects, as well as their associated data structures in FlexSwitch.

Attention

Attributes without default values listed are required in API calls.

Configuration Objects

The following sections descript the structure of each BGP configuration object.

Note

This object is autocreated when the FlexSwtich is started.

BGPGlobal

config/BGPGlobal

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id for BGP global config DEFAULT: default
ASNum string Local AS for BGP global config. Both AsPlain and AsDot formats are supported. DEFAULT: ""
RouterId string Router id for BGP global config DEFAULT: 0.0.0.0
Disabled bool Enable/Disable BGP globally DEFAULT: false
UseMultiplePaths bool Enable/disable ECMP for BGP DEFAULT: false
EBGPMaxPaths uint32 Max ECMP paths from External BGP neighbors DEFAULT: 0
EBGPAllowMultipleAS bool Enable/diable ECMP paths from multiple ASes DEFAULT: false
IBGPMaxPaths uint32 Max ECMP paths from Internal BGP neighbors DEFAULT: 0"
DefaultMED uint32 Default MED to advertise to External BGP neighbors DEFAULT: 0
Defaultv4Route bool Default IPv4 route originate DEFAULT: false
Defaultv6Route bool Default IPv6 route originate DEFAULT: false
Redistribution SourcePolicyList[] Provide redistribution policies for BGP from different sources DEFAULT: "[]"

BGPv4Neighbor

config/BGPv4Neighbor

Attribute Data Type Description Permitted Values
NeighborAddress [Key] string Address of the BGP neighbor
IntfRef [Key] string Interface of the BGP neighbor
Description string Description of the BGP neighbor DEFAULT: ""
Disabled bool Enable/Disable the BGP neighbor DEFAULT: false
PeerGroup string Peer group of the BGP neighbor DEFAULT: ""
PeerAS string Peer AS of the BGP neighbor DEFAULT: ""
LocalAS string Local AS of the BGP neighbor DEFAULT: ""
UpdateSource string Source IP to connect to the BGP neighbor DEFAULT: ""
NextHopSelf bool Use neighbor source IP as the next hop for IBGP neighbors DEFAULT: false
AuthPassword string Password to connect to the BGP neighbor DEFAULT: ""
RouteReflectorClusterId uint32 Cluster Id of the internal BGP neighbor route reflector client DEFAULT: 0
RouteReflectorClient bool Set/Clear BGP neighbor as a route reflector client DEFAULT: false
MultiHopEnable bool Enable/Disable multi hop for BGP neighbor DEFAULT: false
MultiHopTTL uint8 TTL for multi hop BGP neighbor DEFAULT: 0
ConnectRetryTime uint32 Connect retry time to connect to BGP neighbor after disconnect DEFAULT: 0
HoldTime uint32 Hold time for the BGP neighbor DEFAULT: 0
KeepaliveTime uint32 Keep alive time for the BGP neighbor DEFAULT: 0
AddPathsRx bool Receive additional paths from BGP neighbor DEFAULT: false
AddPathsMaxTx uint8 Max number of additional paths that can be transmitted to BGP neighbor, DEFAULT: 0
BfdEnable bool Enable/Disable BFD for the BGP neighbor DEFAULT: false
BfdSessionParam string Bfd session param name to be applied DEFAULT: default
MaxPrefixes uint32 Maximum number of prefixes that can be received from the BGP neighbor DEFAULT: 0
MaxPrefixesThresholdPct uint8 The percentage of maximum prefixes before we start logging DEFAULT: 80
MaxPrefixesDisconnect bool Disconnect the BGP peer session when we receive the max prefixes from the neighbor DEFAULT: false
MaxPrefixesRestartTimer uint8 Time in seconds to wait before we start BGP peer session when we receive max prefixes DEFAULT: 0
AdjRIBInFilter string Policy that is applied for Adj-RIB-In prefix filtering DEFAULT: ""
AdjRIBOutFilter string Policy that is applied for Adj-RIB-Out prefix filtering DEFAULT: ""

BGPv6Neighbor

config/BGPv6Neighbor

Attribute Data Type Description Permitted Values
NeighborAddress [Key] string Address of the BGP neighbor
IntfRef [Key] string Interface of the BGP neighbor
Description string Description of the BGP neighbor DEFAULT: ""
Disabled bool Enable/Disable the BGP neighbor DEFAULT: false
PeerGroup string Peer group of the BGP neighbor" DEFAULT: ""
PeerAS string Peer AS of the BGP neighbor DEFAULT: ""
LocalAS string Local AS of the BGP neighbor DEFAULT: ""
UpdateSource string Source IP to connect to the BGP neighbor DEFAULT: ""
NextHopSelf bool Use neighbor source IP as the next hop for IBGP neighbors DEFAULT: false
RouteReflectorClusterId uint32 Cluster Id of the internal BGP neighbor route reflector client DEFAULT: 0
RouteReflectorClient bool Set/Clear BGP neighbor as a route reflector client DEFAULT: false
MultiHopEnable bool Enable/Disable multi hop for BGP neighbor DEFAULT: false
MultiHopTTL uint8 TTL for multi hop BGP neighbor DEFAULT: 0
ConnectRetryTime uint32 Connect retry time to connect to BGP neighbor after disconnect DEFAULT: 0
HoldTime uint32 Hold time for the BGP neighbor DEFAULT: 0
KeepaliveTime uint32 Keep alive time for the BGP neighbor DEFAULT: 0
AddPathsRx bool Receive additional paths from BGP neighbor" DEFAULT: false
AddPathsMaxTx uint8 Max number of additional paths that can be transmitted to BGP neighbor DEFAULT: 0
BfdEnable bool Enable/Disable BFD for the BGP neighbor DEFAULT: false
BfdSessionParamm string Bfd session param name to be applied DEFAULT: default
MaxPrefixes uint32 DESCRIPTION: "Maximum number of prefixes that can be received from the BGP neighbor", DEFAULT: "0"
MaxPrefixesThresholdPct uint8 The percentage of maximum prefixes before we start logging DEFAULT: 80
MaxPrefixesDisconnect bool Disconnect the BGP peer session when we receive the max prefixes from the neighbor DEFAULT: false
MaxPrefixesRestartTimer uint8 Time in seconds to wait before we start BGP peer session when we receive max prefixes DEFAULT: 0
AdjRIBInFilter string Policy that is applied for Adj-RIB-In prefix filtering DEFAULT: ""
AdjRIBOutFilter string Policy that is applied for Adj-RIB-Out prefix filtering DEFAULT: ""

BGPv4PeerGroup

config/BGPv4PeerGroup

Attribute Data Type Description Permitted Values
PeerAS string Peer AS of the BGP neighbor DEFAULT: ""
LocalAS string Local AS of the BGP neighbor DEFAULT: ""
UpdateSource string Source IP to connect to the BGP neighbor DEFAULT: ""
NextHopSelf bool Use neighbor source IP as the next hop for IBGP neighbors DEFAULT: false
AuthPassword string Password to connect to the BGP neighbor DEFAULT: ""
Description string Description of the BGP neighbor DEFAULT: ""
Name [Key] string Name of the BGP peer group
RouteReflectorClusterId Cluster Id of the internal BGP neighbor route reflector client DEFAULT: 0
RouteReflectorClient bool Set/Clear BGP neighbor as a route reflector client DEFAULT: false
MultiHopEnable bool Enable/Disable multi hop for BGP neighbor DEFAULT: false
MultiHopTTL uint8 TTL for multi hop BGP neighbor DEFAULT: 0
ConnectRetryTime uint32 Connect retry time to connect to BGP neighbor after disconnect DEFAULT: 0
HoldTime uint32 Hold time for the BGP neighbor DEFAULT: 0
KeepaliveTime uint32 Keep alive time for the BGP neighbor DEFAULT: 0
AddPathsRx bool Receive additional paths from BGP neighbor DEFAULT: false
AddPathsMaxTx uint8 Max number of additional paths that can be transmitted to BGP neighbor DEFAULT: 0
MaxPrefixes uint32 Maximum number of prefixes that can be received from the BGP neighbor DEFAULT: 0
MaxPrefixesThresholdPct uint8 The percentage of maximum prefixes before we start logging DEFAULT: 80
MaxPrefixesDisconnect bool Disconnect the BGP peer session when we receive the max prefixes from the neighbor DEFAULT: false
MaxPrefixesRestartTimer uint8 Time to wait before we start BGP peer session when we receive max prefixes DEFAULT: 0
AdjRIBInFilter string Policy that is applied for Adj-RIB-In prefix filtering DEFAULT: ""
AdjRIBOutFilter string Policy that is applied for Adj-RIB-Out prefix filtering DEFAULT: ""

BGPv6PeerGroup

BGPv6PeerGroup

Attribute Data Type Description Permitted Values
PeerAS string Peer AS of the BGP neighbor DEFAULT: ""
LocalAS string Local AS of the BGP neighbor DEFAULT: ""
UpdateSource string Source IP to connect to the BGP neighbor DEFAULT: ""
NextHopSelf bool Use neighbor source IP as the next hop for IBGP neighbors DEFAULT: false
Description string Description of the BGP neighbor DEFAULT: ""
Name [Key] string Name of the BGP peer group
RouteReflectorClusterId uint32 Cluster Id of the internal BGP neighbor route reflector client DEFAULT: 0
RouteReflectorClient bool Set/Clear BGP neighbor as a route reflector client DEFAULT: false
MultiHopEnable bool Enable/Disable multi hop for BGP neighbor DEFAULT: false
MultiHopTTL uint8 TTL for multi hop BGP neighbor DEFAULT: 0
ConnectRetryTime uint32 Connect retry time to connect to BGP neighbor after disconnect DEFAULT: 0
HoldTime uint32 Hold time for the BGP neighbor DEFAULT: 0
KeepaliveTime uint32 Keep alive time for the BGP neighbor DEFAULT: 0
AddPathsRx bool Receive additional paths from BGP neighbor DEFAULT: false
AddPathsMaxTx uint8 Max number of additional paths that can be transmitted to BGP neighbor DEFAULT: 0
MaxPrefixes uint32 Maximum number of prefixes that can be received from the BGP neighbor DEFAULT: 0
MaxPrefixesThresholdPct uint8 The percentage of maximum prefixes before we start logging DEFAULT: 80
MaxPrefixesDisconnect bool Disconnect the BGP peer session when we receive the max prefixes from the neighbor DEFAULT: false
MaxPrefixesRestartTimer uint8 Time to wait before we start BGP peer session when we receive max prefixes DEFAULT: 0
AdjRIBInFilter string Policy that is applied for Adj-RIB-In prefix filtering DEFAULT: ""
AdjRIBOutFilter string Policy that is applied for Adj-RIB-Out prefix filtering DEFAULT: ""

BGPv4Aggregate

config/BGPv4Agregate

Attribute Data Type Description Permitted Values
IpPrefix [Key] string IP Prefix in CIDR format to match
GenerateASSet bool Generate AS set when aggregating routes DEFAULT: false
SendSummaryOnly bool Send summary route only when aggregating routes DEFAULT: false

BGPv6Aggregate

config/BGPv6Aggregate

Attribute Data Type Description Permitted Values
IpPrefix [Key] string IPv6 Prefix in CIDR format to match
GenerateASSet bool Generate AS set when aggregating routes DEFAULT: false
SendSummaryOnly bool Send summary route only when aggregating routes DEFAULT: false

BGPNetworkStatement

config/BGPNetworkStatement

Attribute Data Type Description Permitted Values
IpPrefix [Key] string IP Prefix in CIDR format to match
Policy string Policy that is applied for this network DEFAULT: ""

State Objects

Note

State objects are read-only.

Note

Each configuration object has a corresponding state object. Only those state objects not associated with configuration objects are listed here.

BGPv4RouteState

state/BGPv4Route

Attribute Data Type Description Permitted Values
Network [Key] string Network address of the IPv4 destination
CIDRLen [Key] uint16 CIDR length of the IPv4 destination
Paths []PathInfo

BGPv6RouteState

state/BGPv6Route

Attribute Data Type Description Permitted Values
Network [Key] string Network address of the IPv6 destination
CIDRLen [Key] uint16 CIDR length of the IPv6 destination
Paths PathInfo[]

Structures

AdjRIBPathInfo Structure

Attribute Data Type Description Permitted Values
NextHop string Next hop address for the destination
Metric uint32 MED of the path to the destination
LocalPref uint32 Local preference of the path to the destination
Path string[] AS path to the destination
PathId uint32 Path id of the path
UpdatedTime string Last time the destination was updated
Origin string BGP origin type

SourcePolicyList Structure

Attribute Data Type Description Permitted Values
Sources string Source Protocol(s) which BGP is interested in. Multiple sources can be specified as comma separated strings when the same policy needs to be applied. SELECTION: CONNECTED/STATIC/OSPF
Policy string Policy that needs to be applied for redistribution of the specified sources into BGP

BGPCounters Structure

Attribute Data Type Description Permitted Values
Update uint64 Number of update messages
Notification uint64 Number of notification messages

BGPMessages Structure

Attribute Data Type Description Permitted Values
Sent BGPCounters Tx counters of the BGP neighbor
Received BGPCounters Rx counters of the BGP neighbor

BGPQueues Structure

Attribute Data Type Description Permitted Values
Input uint32 Input queue length of the BGP neighbor
Output uint32 Output queue length of the BGP neighbor

PathInfo Structure

Attribute Data Type Description Permitted Values
NextHop string Next hop address for the destination
Metric uint32 MED of the path to the destination
LocalPref uint32 Local preference of the path to the destination
Path string[] AS path to the destination
PathId uint32 Path id of the path
UpdatedTime string Last time the destination was updated
ValidPath bool Is this path valid I.E. next hop reachable in RIB?
BestPath bool best path based on BGP path selection alogrithm
MultiPath bool Is this path selected as ECMP
AdditionalPath bool Path selected as one of the best additional paths
Origin string BGP origin type
PathType string BGP path type; I.E. external, internal, redistributed, etc.