BFDSession

Represents the Bidirectional Forwarding Detection session that can be configured on an uplink/BR connection.

Overview

BFDDestinationIP string filterable   orderable  
BFDDestinationIPType enum (IPV4 | IPV6) filterable   orderable  
BFDDestinationIPv6 string filterable   orderable  
BFDMultiplier integer
BFDTimer integer
creationDate string read only   autogenerated   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
multiHopEnabled boolean filterable   orderable  
owner string autogenerated  

API Resource

/bfdsessions/id
delete get put

Parents

/brconnections/id/bfdsessions
get post put
/uplinkconnections/id/bfdsessions
get post put

Children

/bfdsessions/id/permissions
delete get post put
/bfdsessions/id/metadatas
get post
/bfdsessions/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

BFDDestinationIP string filterable   orderable  
Discussion

Destination IP Address used for Bidirectional Forwarding Detection.

Charateristics

Format: free
Max length: 64
SDK attribute: BFDDestinationIP

BFDDestinationIPType enum filterable   orderable  
Discussion

Destination IP Type of Bidirectional Forwarding Detection

Charateristics

Allowed values: IPV4, IPV6
Default value: IPV4
SDK attribute: BFDDestinationIPType

BFDDestinationIPv6 string filterable   orderable  
Discussion

Destination IPv6 Address used for Bidirectional Forwarding Detection. Required if BFD Destination IP Type is IPV6

Charateristics

Format: free
SDK attribute: BFDDestinationIPv6

BFDMultiplier integer
Discussion

Multiplier used for Bidirectional Forwarding Detection Timer.

Charateristics

Default value: 3
Min value: 2
Max value: 20
SDK attribute: BFDMultiplier

BFDTimer integer
Discussion

Timer for Bidirectional Forwarding Detection in milliseconds.

Charateristics

Default value: 500
Min value: 10
Max value: 100000
SDK attribute: BFDTimer

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

multiHopEnabled boolean filterable   orderable  
Discussion

Boolean flag to indicate whether the BFD Session has single hop or multi hop capability.

Charateristics

Default value: false
SDK attribute: multiHopEnabled

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner