vrrp-a vrid-lead¶

Define a vrid-lead

vrid-lead Specification¶

Parameter Value

Type Collection

Object Key(s) vrid-lead-str

Collection Name vrid-lead-list

Collection URI /axapi/v3/vrrp-a/vrid-lead

Element Name vrid-lead

Element URI /axapi/v3/vrrp-a/vrid-lead/{vrid-lead-str}

Element Attributes vrid-lead_attributes

Partition Visibility shared

Schema vrid-lead schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/vrrp-a/vrid-lead	vrid-lead attributes
POST /axapi/v3/vrrp-a/vrid-lead/ Payload: { "vrid-lead": { "vrid-lead-str": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/vrrp-a/vrid-lead	vrid-lead attributes
Get Object	GET	/axapi/v3/vrrp-a/vrid-lead/{vrid-lead-str}	vrid-lead attributes
GET /axapi/v3/vrrp-a/vrid-lead/a Reponse: { "vrid-lead": { "vrid-lead-str": "a", "partition": { "partition": 0 }, "uuid": "f8d14410-514a-11ee-9809-cd859f483682", "user-tag": "a", "a10-url": "/axapi/v3/vrrp-a/vrid-lead/a" } }
Get List	GET	/axapi/v3/vrrp-a/vrid-lead	vrid-lead-list
Modify Object	POST	/axapi/v3/vrrp-a/vrid-lead/{vrid-lead-str}	vrid-lead attributes
Replace Object	PUT	/axapi/v3/vrrp-a/vrid-lead/{vrid-lead-str}	vrid-lead attributes
PUT /axapi/v3/vrrp-a/vrid-lead/a Payload: { "vrid-lead": { "vrid-lead-str": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/vrrp-a/vrid-lead	vrid-lead-list
Delete Object	DELETE	/axapi/v3/vrrp-a/vrid-lead/{vrid-lead-str}	vrid-lead attributes
DELETE /axapi/v3/vrrp-a/vrid-lead/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

vrid-lead-list¶

vrid-lead-list is JSON List of vrid-lead attributes

vrid-lead-list : [

{ vrid-lead attributes },

{ vrid-lead attributes },

…

]

vrid-lead attributes¶

partition

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

Type: Object

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

vrid-lead-str

Description VRRP-A VRID leader name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Default: default-vrid-lead

partition¶

Specification Value

Type object

name-cfg

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

Type: Object

partition

Description Partition name

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

shared-cfg

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

Type: Object

partition_shared-cfg¶

Specification Value

Type object

shared

Description Shared partition

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: shared and name are mutually exclusive

vrid

Description VRRP-A id

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

vrid-value

Description Specify ha VRRP-A vrid

Type: number

Range: 0-31

partition_name-cfg¶

Specification Value

Type object

name

Description Partition name

Type: string

Maximum Length: 14 characters

Maximum Length: 1 characters

Mutual Exclusion: name and shared are mutually exclusive

Reference Object: /axapi/v3/partition

vrid

Description VRRP-A id

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

vrid-value

Description Specify ha VRRP-A vrid

Type: number

Range: 0-7