interface ve bfd¶

Configure BFD (Bidirectional Forwarding Detection)

bfd Specification¶

Parameter Value

Type Configuration Resource

Element Name bfd

Element URI /axapi/v3/interface/ve/{ifnum}/bfd

Element Attributes bfd_attributes

Partition Visibility shared

Schema bfd schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/interface/ve/{ifnum}/bfd	bfd attributes
POST /axapi/v3/interface/ve/2/bfd Payload: { "bfd": { "authentication": { "method": "md5", "key-id": 0, "password": "a" } } }
Get Object	GET	/axapi/v3/interface/ve/{ifnum}/bfd	bfd attributes
GET /axapi/v3/interface/ve/2/bfd Reponse: { "bfd": { "authentication": { "key-id": 0, "method": "md5", "encrypted": "2P9QxKIJTIH01GmYzym9Jl5iVWBmqyw2QOi5HoPikvcoG/XbRW9Pw7byX/kihdhh" }, "echo": 0, "uuid": "62524dec-500d-11ee-ac8d-3b5bd4b1e0b9", "a10-url": "/axapi/v3/interface/ve/2/bfd" } }
Modify Object	POST	/axapi/v3/interface/ve/{ifnum}/bfd	bfd attributes
Replace Object	PUT	/axapi/v3/interface/ve/{ifnum}/bfd	bfd attributes
PUT /axapi/v3/interface/ve/2/bfd Payload: { "bfd": { "authentication": { "method": "meticulous-md5", "key-id": 1, "password": "abcd" } } }
Delete Object	DELETE	/axapi/v3/interface/ve/{ifnum}/bfd	bfd attributes
DELETE /axapi/v3/interface/ve/2/bfd Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

bfd attributes¶

authentication

Description: authentication is a JSON Block. Please see below for authentication

Type: Object

demand

Description Demand mode

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

echo

Description Enable BFD Echo

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

interval-cfg

Description: interval-cfg is a JSON Block. Please see below for interval-cfg

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

authentication¶

Specification Value

Type object

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

key-id

Description Key ID

Type: number

Range: 0-255

method

Description ‘md5’: Keyed MD5; ‘meticulous-md5’: Meticulous Keyed MD5; ‘meticulous-sha1’: Meticulous Keyed SHA1; ‘sha1’: Keyed SHA1; ‘simple’: Simple Password;

Type: string

Supported Values: md5, meticulous-md5, meticulous-sha1, sha1, simple

password

Description Key String

Type: string

Format: password

Maximum Length: 16 characters

Maximum Length: 1 characters

interval-cfg¶

Specification Value

Type object

interval

Description Transmit interval between BFD packets (Milliseconds)

Type: number

Range: 48-1000

min-rx

Description Minimum receive interval capability (Milliseconds)

Type: number

Range: 48-1000

multiplier

Description Multiplier value used to compute holddown (value used to multiply the interval)

Type: number

Range: 3-50