BFD Objects

This page contains descriptions of BFD objects in the FlexSwitch object models.

Attention

Attributes without default values listed are required in API calls.

Configuration Objects

BfdGlobal

config/BfdGlobal

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id where BFD is globally enabled or disabled DEFAULT: default
Enable bool Global BFD state in this VRF DEFAULT: true

BfdSession

config/BfdSession

Attribute Data Type Description Permitted Values
IpAddr [Key] string BFD neighbor IP address
UpdateSrc string Source address to overwrite instead of outgoing interface address DEFAULT: ""
ParamName string Name of the session parameters object to be applied on this session DEFAULT: default
Interface string Name of the interface this session has to be established on DEFAULT: None
PerLink bool Run BFD sessions on individual link of a LAG if the neighbor is reachable through LAG DEFAULT: false
Owner string Module requesting BFD session configuration DEFAULT: user

BfdSessionParam

config/BfdSessionParam

Attribute Data Type Description Permitted Values
Name [Key] string Session parameters
LocalMultiplier uint32 Detection multiplier DEFAULT: 3
DesiredMinTxInterval uint32 Desired minimum tx interval in ms DEFAULT: 1000
RequiredMinRxInterval uint32 Required minimum rx interval in ms DEFAULT: 1000
RequiredMinEchoRxInterval uint32 Required minimum echo rx interval in ms DEFAULT: 0
DemandEnabled bool Enable or disable demand mode DEFAULT: false
AuthenticationEnabled bool Enable authentication DEFAULT: false
AuthType string Authentication type SELECTION: metmd5/keyedmd5/
metsha1/keyedsha1/simple
DEFAULT: simple
AuthKeyId uint32 Authentication key id DEFAULT: 1
AuthData string Authentication password DEFAULT: snaproute

State Objects

BfdGlobalState

state/BfdGlobal

Attribute Data Type Description Permitted Values
Vrf [Key] string VRF id for which global BFD state is requested
Enable bool Global BFD state in this VRF
NumTotalSessions uint32 Total number of BFD sessions
NumUpSessions uint32 Number of BFD sessions in up state
NumDownSessions uint32 Number of BFD sessions in down state
NumAdminDownSessions uint32 Number of BFD sessions in admin down state

BfdSessionState

state/BfdSession

Attribute Data Type Description Permitted Values
IpAddr [Key] string Neighbor IP address
SessionId int32 Session index
ParamName string Session parameters config
IntfRef string Interface on which this session is running
InterfaceSpecific bool This session is tied to an interface
PerLinkSession bool This is a perlink session on LAG
LocalMacAddr string My MAC address
RemoteMacAddr string Neighbor MAC address
RegisteredProtocols string Registered owners
SessionState string My state
RemoteSessionState string Neighbor state
LocalDiscriminator uint32 My discriminator
RemoteDiscriminator uint32 Neighbor discriminator
LocalDiagType string My diagnostic
DesiredMinTxInterval string My desired minimum tx interval
RequiredMinRxInterval string My required minimum rx interval
RemoteMinRxInterval string Neighbor minimum rx interval
DetectionMultiplier uint32 My detection multiplier
RemoteDetectionMultiplier uint32 Neighbor detection multiplier
DemandMode bool My demand mode
RemoteDemandMode bool Neighbor demand mode
AuthSeqKnown bool Authentication sequence known
AuthType string My Authentication type
ReceivedAuthSeq uint32 Received authentication sequence number
SentAuthSeq uint32 Sent authentication sequence number
NumTxPackets uint32 Number of control packets sent
NumRxPackets uint32 Number of control packets received
ToDownCount uint32 Number of times this session have moved to down state
ToUpCount uint32 Number of times this session have moved to up state
UpDuration string Duration of this session in up state

BfdSessionParamState

state/BfdSessionParam

Attribute Data Type Description Permitted Values
Name [Key] string Session parameters
NumSessions int32 Number of sessions using these params
LocalMultiplier int32 Detection multiplier
DesiredMinTxInterval string Desired minimum tx interval
RequiredMinRxInterval string Required minimum rx interval
RequiredMinEchoRxInterval string Required minimum echo rx interval
DemandEnabled bool Demand mode enabled
AuthenticationEnabled bool Authentication enabled
AuthenticationType string Authentication type
AuthenticationKeyId int32 Authentication key id
AuthenticationData string Authentication password