system health-check¶

Layer-2 path health monitor

health-check Specification¶

Parameter Value

Type Collection

Object Key(s) l2hm-hc-name

Collection Name health-check-list

Collection URI /axapi/v3/system/health-check

Element Name health-check

Element URI /axapi/v3/system/health-check/{l2hm-hc-name}

Element Attributes health-check_attributes

Partition Visibility shared

Schema health-check schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/system/health-check	health-check attributes
POST /axapi/v3/system/health-check/ Payload: { "health-check": { "l2hm-hc-name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/system/health-check	health-check attributes
Get Object	GET	/axapi/v3/system/health-check/{l2hm-hc-name}	health-check attributes
GET /axapi/v3/system/health-check/a Reponse: { "health-check": { "l2hm-hc-name": "a", "method-l2bfd": 0, "uuid": "aa46f5ea-5129-11ee-9f88-7dde599be8ea", "user-tag": "a", "a10-url": "/axapi/v3/system/health-check/a" } }
Get List	GET	/axapi/v3/system/health-check	health-check-list
Modify Object	POST	/axapi/v3/system/health-check/{l2hm-hc-name}	health-check attributes
Replace Object	PUT	/axapi/v3/system/health-check/{l2hm-hc-name}	health-check attributes
PUT /axapi/v3/system/health-check/a Payload: { "health-check": { "l2hm-hc-name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/system/health-check	health-check-list
Delete Object	DELETE	/axapi/v3/system/health-check/{l2hm-hc-name}	health-check attributes
DELETE /axapi/v3/system/health-check/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

health-check-list¶

health-check-list is JSON List of health-check attributes

health-check-list : [

{ health-check attributes },

{ health-check attributes },

…

]

health-check attributes¶

l2bfd-multiplier

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

Type: number

Range: 3-50

l2bfd-rx-interval

Description Minimum receive interval capability (Milliseconds (default: 800))

Type: number

Range: 48-1000

l2bfd-tx-interval

Description Transmit interval between BFD packets

Type: number

Range: 48-1000

l2hm-hc-name

Description Monitor Name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

method-l2bfd

Description Method is l2bfd

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters