SLBFDCommon

Service Description

Common IPv4, IPv6 BFD messages.

The following messages are used in both IPv4 and IPv6 BFD operations.

Messages
message	SLBfdRegMsg
	BFD Registration message. More...
message	SLBfdRegMsgRsp
	BFD Registration response message. More...
message	SLBfdGetMsg
	BFD Globals Get message. More...
message	SLBfdGetMsgRsp
	BFD Get Global info response message. More...
message	SLBfdGetStatsMsgRsp
	BFD Get Global Stats response message. More...
message	SLBfdGetNotifMsg
	BFD Get Notifications message. More...
message	SLBfdConfigCommon
	Common bidirectional forwarding detection attributes. More...
message	SLBfdCommonState
	BFD state information. More...

Enumerations
enum	SLBfdType { SL_BFD_RESERVED = 0x0, SL_BFD_SINGLE_HOP = 0x1, SL_BFD_MULTI_HOP = 0x2 }
enum	SLBfdNotifType { SL_BFD_EVENT_TYPE_RESERVED = 0x0, SL_BFD_EVENT_TYPE_ERROR = 0x1, SL_BFD_EVENT_TYPE_SESSION_STATE = 0x2 }
	BFD Event Notification types. More...

---

Message Documentation

message SLBfdRegMsg

BFD Registration message.

Attributes
SLRegOp	Oper = 1
	Registration Operation.

message SLBfdRegMsgRsp

BFD Registration response message.

Attributes
SLErrorStatus	ErrStatus = 1
	Error code.

message SLBfdGetMsg

BFD Globals Get message.

message SLBfdGetMsgRsp

BFD Get Global info response message.

Attributes
SLErrorStatus	ErrStatus = 1
	Error code.
uint32	MaxBfdSessionCfgPerSLBfdMsg = 2
	Max BFD objects within a single BfdMsg message.
uint32	MinBfdTxIntervalSingleHop = 3
	Min BFD Transmit Interval for single hop sessions.
uint32	MinBfdTxIntervalMultiHop = 4
	Min BFD session Transmit Interval for multi hop sessions.
uint32	MinBfdDetectMultiplierSingleHop = 5
	Min BFD detection multiplier for single hop sessions.
uint32	MinBfdDetectMultiplierMultiHop = 6
	Min BFD detection multiplier for multi hop sessions.

message SLBfdGetStatsMsgRsp

BFD Get Global Stats response message.

Attributes
SLErrorStatus	ErrStatus = 1
	Error code.
uint64	SeqNum = 2
	Global BFD event sequence number. More...
uint32	BfdCount = 3
	Num BFD sessions added through the service layer.

Member Data Documentation

uint64 SLBfdGetStatsMsgRsp::SeqNum = 2

Global BFD event sequence number.

This is used to order various events The sequence number is equivalent to a timestamp This field contains the latest global BFD event sequence number

message SLBfdGetNotifMsg

BFD Get Notifications message.

message SLBfdConfigCommon

Common bidirectional forwarding detection attributes.

Attributes
uint32	DesiredTxIntUsec = 1
	Desired Tx interval in micro seconds. More...
uint32	DetectMultiplier = 2
	Detection time = DesiredTxIntUsec * DetectMultiplier Detection time is the period of time without receiving BFD packets after which the session is determined to have failed. More...

Member Data Documentation

uint32 SLBfdConfigCommon::DesiredTxIntUsec = 1

Desired Tx interval in micro seconds.

This is the minimum interval that the local system would like to use when transmitting BFD control packets. The value zero is reserved. This can be changed at anytime.

uint32 SLBfdConfigCommon::DetectMultiplier = 2

Detection time = DesiredTxIntUsec * DetectMultiplier Detection time is the period of time without receiving BFD packets after which the session is determined to have failed.

Note: there may be a different detection time in each direction.

message SLBfdCommonState

BFD state information.

Public Types
enum	SLBfdStateEnum { SL_BFD_SESSION_STATE_UNKNOWN = 0, SL_BFD_SESSION_UP = 1, SL_BFD_SESSION_DOWN = 2, SL_BFD_NEIGHBOR_UNCONFIG = 3 }
	BFD state information. More...
enum	SLBfdDiagStateEnum {   SL_BFD_DIAG_NONE = 0, SL_BFD_DIAG_DETECT_EXPIRED = 1, SL_BFD_DIAG_NBR_DOWN = 2, SL_BFD_DIAG_PATH_DOWN = 3,   SL_BFD_DIAG_FWDING_PLANE_RESET = 4, SL_BFD_DIAG_ADMIN_DOWN = 5, SL_BFD_DIAG_REV_CONC_PATH_DOWN = 6, SL_BFD_DIAG_ECHO_FUNCTION_FAILED = 7,   SL_BFD_DIAG_CONC_PATH_DOWN = 8 }
	BFD diagnostic indicates the reason for the last transition of the local protocol from up to some other state. More...
Attributes
uint64	SeqNum = 1
	Global BFD event sequence number. More...
SLBfdStateEnum	Status = 2
SLBfdDiagStateEnum	Diag = 3

Member Enumeration Documentation

enum SLBfdCommonState::SLBfdDiagStateEnum

BFD diagnostic indicates the reason for the last transition of the local protocol from up to some other state.

Enumerator
SL_BFD_DIAG_NONE	Diag Value – Value Meaning No diagnostic.
SL_BFD_DIAG_DETECT_EXPIRED	Control detection time expired.
SL_BFD_DIAG_NBR_DOWN	Neighbor signaled session down.
SL_BFD_DIAG_PATH_DOWN	Path down.
SL_BFD_DIAG_FWDING_PLANE_RESET	Forwarding plane reset.
SL_BFD_DIAG_ADMIN_DOWN	Administratively down.
SL_BFD_DIAG_REV_CONC_PATH_DOWN	Reverse Concatenated Path Down.
SL_BFD_DIAG_ECHO_FUNCTION_FAILED	Echo Function Failed.
SL_BFD_DIAG_CONC_PATH_DOWN	Concatenated Path Down.

enum SLBfdCommonState::SLBfdStateEnum

BFD state information.

Enumerator
SL_BFD_SESSION_STATE_UNKNOWN	Session never established.
SL_BFD_SESSION_UP	Session state UP.
SL_BFD_SESSION_DOWN	Session state is down.
SL_BFD_NEIGHBOR_UNCONFIG	Neighbor's config was removed.

Member Data Documentation

uint64 SLBfdCommonState::SeqNum = 1

Global BFD event sequence number.

This is used to order various events The sequence number is equivalent to a timestamp

Enumeration Type Documentation

enum SLBfdNotifType

BFD Event Notification types.

Enumerator
SL_BFD_EVENT_TYPE_RESERVED	Reserved. 0x0.
SL_BFD_EVENT_TYPE_ERROR	Error - ErrStatus field elaborates on the error. 0x1.
SL_BFD_EVENT_TYPE_SESSION_STATE	BFD Session state event. 0x2.

enum SLBfdType

Enumerator
SL_BFD_RESERVED	Reserved. 0x0.
SL_BFD_SINGLE_HOP	Single Hop. 0x1.
SL_BFD_MULTI_HOP	Multi Hop. 0x2.