BgpRouterConfig Object

Description:

Defines the characteristics of an emulated router that acts as a BGP speaker.

Writable Attributes
Read-Only Attributes

Parents: EmulatedDevice

Children: BgpCapabilityConfig, BgpCustomCapability, BgpCustomPdu, BgpEvpnAdRouteConfig, BgpEvpnEthernetSegmentRouteConfig, BgpEvpnInclusiveMcastRouteConfig, BgpEvpnIpPrefixRouteConfig, BgpEvpnJoinSynchRouteConfig, BgpEvpnLeaveSynchRouteConfig, BgpEvpnMacAdvRouteConfig, BgpEvpnSelectiveMcastEthernetTagRouteConfig, BgpFlowSpecConfig, BgpIpv4MvpnGeneralADRouteConfig, BgpIpv4MvpnJoinRouteConfig, BgpIpv4RouteConfig, BgpIpv4VplsConfig, BgpIpv6FlowSpecConfig, BgpIpv6MvpnGeneralADRouteConfig, BgpIpv6MvpnJoinRouteConfig, BgpIpv6RouteConfig, BgpIpv6VplsConfig, BgpLsNodeConfig, BgpLsScaleBackboneConfig, BgpMembershipConfig, BgpMvpnType1RouteConfig, BgpNlriCapabilityConfig, BgpSessionDetails, BgpSrTePolicyConfig, BgpTableRouteConfig, BgpVplsAdConfig

Automatically-created children: Bgp4ByteAsNumModifier, Bgp4ByteDutAsNumModifier, BgpAsNumModifier, BgpAuthenticationParams, BgpDutAsNumModifier, BgpDutIpv4AddrModifier, BgpDutIpv6AddrModifier

Result children (automatically created): BgpEvpnResults, BgpMvpnResults, BgpRouteResultsPerAfiSafi, BgpRouterResults

Relations:

Side name (Type)	Relative	Description
ViewControlPlaneMplsBindingResult (ControlPlaneBindingResult)	ViewControlPlaneMplsBindingResult	Result parameter objects of the BGP router.
ConvergenceConfig (PrimaryPathProtocolConfig)	ConvergenceConfig, ConvergenceConfig	Primary Path Protocol Config Relation
(ResolvesInterface)	Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf	Use this to link the traffic binding interfaces and traffic binding resolver.
ResultChild (ResultChild)	BgpEvpnResults, BgpMvpnResults, BgpRouteResultsPerAfiSafi, BgpRouterResults	Use this to connect a results object to an object.
TimeComparisonPair (TimeComparisonPairSrcProtocol)	TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair	TimeComparisonPairSrcProtocol.

BgpRouterConfig Writable Attributes

Attribute

Description

AddPathMode

Add Path Mode

Type: enum

Default: SEND_AND_RECEIVE_ADD_PATH

Possible Values:

Value	Description
NONE	None (0)
RECEIVE_ADD_PATH	Receive Add Path (1)
SEND_ADD_PATH	Send Add Path (2)
SEND_AND_RECEIVE_ADD_PATH	Send and Received Add Path (3)

Afi

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead use the BgpCapabilityConfig object SubAfi attribute.

Address family identifier.

Type: u16

Default: 0

Range: 0 - 65535

AsNum

Autonomous system number for the emulated BGP router. Since this is the tester AS number, the number is arbitrary and you can enter any number that has been configured on the DUT as a BGP neighbor.

Type: u16

Default: 1

Range: 0 - 65535

AsNum4Byte

4-byte autonomous system number for the emulated BGP router. To use this, Enable4ByteAsNum must be set to TRUE. Since this is the tester AS, this number is arbitrary and you can enter any number that has been configured on the DUT as a BGP neighbor.

Type: string

Default: 1.1

BgpSessionIpAddress

BGP Session IP Address.

Type: enum

Default: INTERFACE_IP

Possible Values:

Value	Description
INTERFACE_IP	Bgp Session IpAddress INTERFACE_IP
ROUTER_ID	Bgp Session IpAddress ROUTER_ID">

CustomizedAfi

Whether the Afi/Safi capability list are selected by user or created in default.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Afi/Safi is customized.
FALSE	Afi/Safi is created in default according to current route type.

DutAsNum

Autonomous system number configured for the DUT.

Type: u16

Default: 1001

Range: 0 - 65535

DutAsNum4Byte

4-byte autonomous system number configured for the DUT. To use this, Enable4ByteDutAsNum must be set to TRUE.

Type: string

Default: 1.1001

DutIpv4Addr

IPv4 address of the BGP peer for the session.

Type: ip

Default: null

DutIpv4AddrCollectionType

Type List or Increment

Type: enum

Default: INCREMENT

Possible Values:

Value	Description
INCREMENT	Option To Select Increment
LIST	Option To Select List

DutIpv4AddrList

IPv4 address List of the BGP peer for the session

Type: ip

Default: 192.0.1.0

DutIpv6Addr

IPv6 address of the BGP peer for the session.

Type: ipv6

Default: null

Enable4ByteAsNum

Whether to enable a 4-byte autonomous system number for the emulated BGP router.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable 4-byte autonomous system number for the emulated router. Use AsNum4Byte to set this.
FALSE	Disable 4-byte autonomous system number for the emulated router.

Enable4ByteDutAsNum

Whether to enable the ability of the emulated BGP router to handle a DUT with a 4-byte autonomous system number.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable handling of 4-byte autonomous system number for the DUT. Use DutAsNum4Byte to set this.
FALSE	Disable handling of 4-byte autonomous system number for the DUT.

EnableAddPath

Enable Add Path Capability

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Add Path Capability Enabled
FALSE	Add Path Capability Disabled

EnableBfd

Enable or disable BFD (Bidirectional Forwarding Detection) for this router. You must also create a BfdRouterConfig object under the parent Router object.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable BFD.
FALSE	Disable BFD.

EnableEorMarker

Ensure marker packet is not sent when EOR flag is disabled

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enable EOR flag.
FALSE	Disable EOR flag.

EnableMplsBypass

Enable MPLS Bypass

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable MPLS Bypass
FALSE	Disable MPLS Bypass

EnablePackRoutes

Whether to enable the use of the minimum number of UPDATE messages to send the configured route blocks.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use the minimum number of UPDATE messages when sending configured route blocks.
FALSE	Send one route block per UPDATE message.

EnableRefreshRoutes

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Whether to enable refresh routes.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable refresh routes. Spirent TestCenter will send out and respond to BGP route refresh messages.
FALSE	Disable refresh routes.

EnableRouteTargetFilter

Enable Route Target Filter for VXLAN

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Router Target Filter for VXLAN
FALSE	Disable Router Target Filter for VXLAN

EnableSr

Enable BGP SR.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	BGP SR is enabled.
FALSE	BGP SR is disabled.

FlapDownTime

Time Duration in secs till which device has to stay in down state during flapping

Type: u16

Default: 5

Range: 5 - 21600

FlapLoopCount

Number of times flap should be performed

Type: u16

Default: 1

Range: 1 - 256

FlapUpTime

Time Duration in secs till which device has to stay in up state during flapping

Type: u16

Default: 5

Range: 5 - 21600

GracefulRestart

Enable or disable graceful restart on the emulated BGP router. If enabled, it causes an emulated router's peer to retain the router's advertised routes in the peer's route database when the session is closed. If disabled, it causes an emulated router's peer to remove the router's advertised routes from its route database when the session is closed.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable graceful restart.
FALSE	Disable graceful restart.

HoldTimeInterval

BGP Hold Time value to use when negotiating with peers. If the router does not receive KEEPALIVE or UPDATE or NOTIFICATION messages within the Hold Time field of the OPEN message, then the BGP connection to the peer will be closed.

Type: u16

Default: 90

Range: 3 - 65535

Initiate

Whether the emulated BGP router will initiate a session (including retry attempts), or listen for the peer to initiate a session.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Emulated router initiates the session.
FALSE	Emulated router listens for the peer to initiate the session.

IpVersion

IP version to be used for the BGP session.

Type: enum

Default: IPV4

Possible Values:

Value	Description
IPV4	IP version 4.
IPV6	IP version 6.
IPV4V6	IP version is dual stack.

KeepAliveInterval

Number of seconds between transmissions of KEEPALIVE messages by the emulated router to the DUT (in the absence of sending any other BGP packets).

Type: u16

Default: 30

Range: 1 - 65535

MinLabel

Minimum label value used. Establishes the starting point for the range for labels advertised by the session.

Type: u32

Default: 16

Range: 0 - 1048575

PeerAs

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Use DutAsNum instead.

Autonomous system number of the BGP peer router session on the DUT.

Type: u16

Default: 1001

Range: 0 - 65535

PreserveForwardingState

Preserve Forwarding State

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable Preserve Forwarding State
FALSE	Disable Preserve Forwarding State

RestartDelay

Amount of time the restart router command waits before the BGP session is restarted.

Type: u16

Default: 1

Range: 0 - 4095

RestartTime

BGP graceful restart time. The amount of time (in seconds) that the emulated router will wait for its peer to re-establish the session. If the session is not re-established within this time frame, the stale routes will be removed from the route database.

Type: u16

Default: 90

Range: 0 - 4095

RouteRefreshMode

Allows to select the Route Refresh mode

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	Does not enable Route Refresh or Enhanced Route refresh mode
ROUTE_REFRESH	Enables Route Refresh
ENHANCED_ROUTE_REFRESH	Enables Enhanced Route Refresh

SubAfi

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Instead use the BgpCapabilityConfig object SubAfi attribute.

Subsequent address family identifier.

Type: u8

Default: 0

Range: 0 - 255

Synchronization

Enable or disable EoR for this router, you should create any kind of bgp routes.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	After sending all bgp routes, an End of Rib update is sent out.
FALSE	There's no EoR update sent after sending all bgp routes.

Tos

Provides an indication of the quality of service wanted.

Note: This attribute is not available in the Spirent TestCenter GUI application.

Type: u8

Default: 192

Range: 0 - 255

Ttl

Time to live. Specifies the time span of a packet.

Note: This attribute is not available in the Spirent TestCenter GUI application.

Type: u8

Default: 255

Range: 1 - 255

TTLValue

TTL Value

Type: u16

Default: 255

Range: 1 - 255

UseGatewayAsDut

Enable to to use emulated device gateway address as the DUT IPv4/v6 Address.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Emulated device gateway address will be used as DUT address.
FALSE	Configured DUT IPv4/v6 address will be used as DUT address.

ViewRoutes

Whether to enable view routes.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable view routes. The Spirent TestCenter chassis will start to collect routes/LSAs it receives from the peer. Then later if a view routes command is issued, the stored routes can be sent for display.
FALSE	Disable view routes.

BgpRouterConfig Read-Only Attributes

Read-Only Attribute

Description

EiBgp

Whether the BGP speaker is internal or external.

Type: enum

Default: EBGP

Possible Values:

Value	Description
IBGP	Internal BGP speaker type.
EBGP	External BGP speaker type.

FlapState

Indicates current status of BGP flap state.

Type: enum

Default: BGP_FLAP_NONE

Possible Values:

Value	Description
BGP_FLAP_NONE	Not Started
BGP_FLAP_RUNNING	Running
BGP_FLAP_COMPLETE	Completed
BGP_FLAP_STOPPED	Stopped
BGP_FLAP_STATE_ERROR	Error

LearnedLabelCount

Count of number of learned labels.

Type: u32

Default: 0

ResolvedLabelCount

Count of number of resolved labels.

Type: u32

Default: 0

RouterState

Reports the status of the emulated router on the current port.

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	No state.
IDLE	Prior to invoking Open_BgpSession or Start_Router, an emulated router is in the Idle state.
CONNECT	Connecting.
ACTIVE	Active.
OPEN_SENT	Open is sent.
OPEN_CONFIRM	Open is confirmed.
ESTABLISHED	Session is confirmed by the peer. The router state is Established.

UnResolvedLabelCount

Count of number of unresolved labels.

Type: u32

Default: 0

V4RouterState

State of the BGP v4 router.

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	No state.
IDLE	Prior to invoking Open_BgpSession or Start_Router, an emulated router is in the Idle state.
CONNECT	Connecting.
ACTIVE	Active.
OPEN_SENT	Open is sent.
OPEN_CONFIRM	Open is confirmed.
ESTABLISHED	Session is confirmed by the peer. The router state is Established.

V6RouterState

State of the BGP v6 router.

Type: enum

Default: NONE

Possible Values:

Value	Description
NONE	No state.
IDLE	Prior to invoking Open_BgpSession or Start_Router, an emulated router is in the Idle state.
CONNECT	Connecting.
ACTIVE	Active.
OPEN_SENT	Open is sent.
OPEN_CONFIRM	Open is confirmed.
ESTABLISHED	Session is confirmed by the peer. The router state is Established.