BfdRouterConfig Object


Description:

Configure Bidirectional Forwarding Detection (BFD) for the router.

Parents: EmulatedDevice

Children: BfdIpv4ControlPlaneIndependentSession, BfdIpv6ControlPlaneIndependentSession, BfdSessionDetails, BfdSrv6EchoSession

Automatically-created children: BfdAuthenticationParams

Result children (automatically created): BfdIpv4SessionResults, BfdIpv6SessionResults, BfdMplsSessionResults, BfdRouterResults, BfdRouterSessionResults

Relations:

Side name
(Type)
Relative Description
BfdStreamBlock
(BfdStreamBlock)

StreamBlock

ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

ResultChild
(ResultChild)

BfdIpv4SessionResults, BfdIpv6SessionResults, BfdMplsSessionResults, BfdRouterResults, BfdRouterSessionResults

Use this to connect a results object to an object.

TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

UsesIf
(UsesIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

BfdRouterConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
DetectMultiplier

Value to multiply the negotiated transmit interval by to calculate the detection time for the transmitting system in Asynchronous mode.

Type: u32

Default: 3

Range: 2 - 255

EchoRxInterval

Minimum interval in milliseconds that the emulated router wants between received BFD Echo packets.

Type: u32

Default: 0

EnableSBfd

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

Enable Seamless BFD.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable Seamless BFD.

FALSE

Disable Seamless BFD.

IntervalTimeUnit

Time unit for all time interval configuration properties.

Type: enum

Default: MSEC

Possible Values:

Value Description
MSEC

Time intervals are in milliseconds (ms).

USEC

Time intervals are in microseconds (us).

RouterRole

Role for the router to take.

Type: enum

Default: ACTIVE

Possible Values:

Value Description
PASSIVE

Take the Passive role. A system taking the Passive role must not begin sending BFD packets for a particular session until it has received a BFD packet for that session.

ACTIVE

Take the Active role. A system taking the Active role must send BFD control packets for a particular session.

RxInterval

Minimum interval in milliseconds that the emulated router wants between received BFD Control packets.

Type: u32

Default: 50

SBfdDetectMultiplier

SBFD Detect Multiplier

Type: u32

Default: 3

Range: 1 - 255

SBfdRxInterval

SBFD Rx Interval

Type: u32

Default: 50

SBfdTxInterval

SBFD Tx Interval

Type: u32

Default: 50

ScaleMode

Performance level of the protocol.

Type: enum

Default: NORMAL

Possible Values:

Value Description
NORMAL

Normal performance, with all results.

GEN_TX_NO_RESULTS

Scale mode: Improve scale performance by transmitting packets using the generator, and reducing results collected.

GEN_TX_RX_RESULTS

Scale mode: Improve scale performance by transmitting packets using the generator, but retain received packet results.

TxInterval

Minimum interval in milliseconds that the emulated router wants between transmitted BFD Control packets.

Type: u32

Default: 50

UsePartialBlockState

Whether to use partial block state.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use partial block state.

FALSE

Do not use partial block state.

BfdRouterConfig Read-Only Attributes

Read-Only Attribute Description
SessionsDownCount

Number of BFD sessions in the Down and AdminDown state.

Type: u16

Default: 0

SessionsUpCount

Number of BFD sessions in the Up state.

Type: u16

Default: 0