vrrp-a vrid¶

Specify VRRP-A vrid

vrid Specification¶

Parameter Value

Type Collection

Object Key(s) vrid-val

Collection Name vrid-list

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

Element Name vrid

Element URI /axapi/v3/vrrp-a/vrid/{vrid-val}

Element Attributes vrid_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/vrrp-a/vrid/{vrid-val}/stats

Operational Data URI /axapi/v3/vrrp-a/vrid/{vrid-val}/oper

Schema vrid schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/vrrp-a/vrid	vrid attributes
POST /axapi/v3/vrrp-a/vrid/ Payload: { "vrid": { "vrid-val": 0, "user-tag": "a" } }
Create List	POST	/axapi/v3/vrrp-a/vrid	vrid attributes
Get Object	GET	/axapi/v3/vrrp-a/vrid/{vrid-val}	vrid attributes
GET /axapi/v3/vrrp-a/vrid/0 Reponse: { "vrid": { "vrid-val": 0, "preempt-mode": { "threshold": 0, "disable": 0 }, "uuid": "db1a893c-6612-11d9-9a27-692335d4f00d", "user-tag": "a", "blade-parameters": { "priority": 150, "uuid": "db1a8b8a-6612-11d9-9a27-692335d4f00d", "a10-url": "/axapi/v3/vrrp-a/vrid/0/blade-parameters" }, "a10-url": "/axapi/v3/vrrp-a/vrid/0" } }
Get List	GET	/axapi/v3/vrrp-a/vrid	vrid-list
Modify Object	POST	/axapi/v3/vrrp-a/vrid/{vrid-val}	vrid attributes
Replace Object	PUT	/axapi/v3/vrrp-a/vrid/{vrid-val}	vrid attributes
PUT /axapi/v3/vrrp-a/vrid/0 Payload: { "vrid": { "vrid-val": 0, "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/vrrp-a/vrid	vrid-list
Delete Object	DELETE	/axapi/v3/vrrp-a/vrid/{vrid-val}	vrid attributes
DELETE /axapi/v3/vrrp-a/vrid/0 Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

vrid-list¶

vrid-list is JSON List of vrid attributes

vrid-list : [

{ vrid attributes },

{ vrid attributes },

…

]

vrid attributes¶

blade-parameters

Description: blade-parameters is a JSON Block. Please see below for blade-parameters

Type: Object

Reference Object: /axapi/v3/vrrp-a/vrid/{vrid-val}/blade-parameters

floating-ip

Description: floating-ip is a JSON Block. Please see below for floating-ip

Type: Object

follow

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

Type: Object

pair-follow

Description: pair-follow is a JSON Block. Please see below for pair-follow

Type: Object

preempt-mode

Description: preempt-mode is a JSON Block. Please see below for preempt-mode

Type: Object

sampling-enable

Type: List

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-val

Description Specify ha VRRP-A vrid

Type: number

Range: 0-31

Default: 0

pair-follow¶

Specification Value

Type object

pair-follow

Description Follow other VRRP-A vrid

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

vrid-lead

Description Define a VRRP-A VRID leader

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

blade-parameters¶

Specification Value

Type object

fail-over-policy-template

Description Apply a fail over policy template (VRRP-A fail over policy template name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/vrrp-a/fail-over-policy-template

priority

Description VRRP-A priorty (Priority, default is 150)

Type: number

Range: 1-255

Default: 150

tracking-options

Description: tracking-options is a JSON Block. Please see below for blade-parameters_tracking-options

Type: Object

Reference Object: /axapi/v3/vrrp-a/vrid/{vrid-val}/blade-parameters/tracking-options

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

blade-parameters_tracking-options¶

Specification Value

Type object

bgp

Description: bgp is a JSON Block. Please see below for blade-parameters_tracking-options_bgp

Type: Object

gateway

Description: gateway is a JSON Block. Please see below for blade-parameters_tracking-options_gateway

Type: Object

Reference Object: /axapi/v3/vrrp-a/vrid/{vrid-val}/blade-parameters/tracking-options/gateway

interface

Type: List

route

Description: route is a JSON Block. Please see below for blade-parameters_tracking-options_route

Type: Object

trunk-cfg

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vlan-cfg

Type: List

blade-parameters_tracking-options_vlan-cfg¶

Specification Value

Type list

Block object keys

priority-cost

Description The amount the priority will decrease

Type: number

Range: 1-255

timeout

Description

Type: number

Range: 2-600

vlan

Description VLAN tracking (VLAN id)

Type: number

Range: 1-4094

blade-parameters_tracking-options_route¶

Specification Value

Type object

ip-destination-cfg

Type: List

ipv6-destination-cfg

Type: List

blade-parameters_tracking-options_route_ipv6-destination-cfg¶

Specification Value

Type list

Block object keys

distance

Description Route’s administrative distance (default: match any)

Type: number

Range: 1-255

gatewayv6

Description Match the route’s gateway (next-hop) (default: match any)

Type: string

Format: ipv6-address

ipv6-destination

Description IPv6 Destination Prefix

Type: string

Format: ipv6-address-plen

priority-cost

Description The amount the priority will decrease if the route is missing (The amount the priority will decrease if the route is not present)

Type: number

Range: 1-255

protocol

Description ‘any’: Match any routing protocol (default); ‘static’: Match only static routes (added by user); ‘dynamic’: Match routes added by dynamic routing protocols (e.g. OSPF);

Type: string

Supported Values: any, static, dynamic

Default: any

blade-parameters_tracking-options_route_ip-destination-cfg¶

Specification Value

Type list

Block object keys

distance

Description Route’s administrative distance (default: match any)

Type: number

Range: 1-255

gateway

Description Match the route’s gateway (next-hop) (default: match any)

Type: string

Format: ipv4-address

ip-destination

Description Destination prefix

Type: string

Format: ipv4-address

mask

Description Destination prefix mask

Type: string

Format: ipv4-netmask

priority-cost

Description The amount the priority will decrease if the route is missing (The amount the priority will decrease if the route is not present)

Type: number

Range: 1-255

protocol

Description ‘any’: Match any routing protocol (default); ‘static’: Match only static routes (added by user); ‘dynamic’: Match routes added by dynamic routing protocols (e.g. OSPF);

Type: string

Supported Values: any, static, dynamic

Default: any

blade-parameters_tracking-options_bgp¶

Specification Value

Type object

bgp-ipv4-address-cfg

Type: List

bgp-ipv6-address-cfg

Type: List

blade-parameters_tracking-options_bgp_bgp-ipv4-address-cfg¶

Specification Value

Type list

Block object keys

bgp-ipv4-address

Description bgp IP Address

Type: string

Format: ipv4-address

priority-cost

Description The amount the priority will decrease

Type: number

Range: 1-255

blade-parameters_tracking-options_bgp_bgp-ipv6-address-cfg¶

Specification Value

Type list

Block object keys

bgp-ipv6-address

Description IPV6 address

Type: string

Format: ipv6-address

priority-cost

Description The amount the priority will decrease

Type: number

Range: 1-255

blade-parameters_tracking-options_interface¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet Interface (Ethernet interface number)

Type: number

Format: interface

priority-cost

Description The amount the priority will decrease

Type: number

Range: 1-255

blade-parameters_tracking-options_gateway¶

Specification Value

Type object

ipv4-gateway-list

Type: List

Reference Object: /axapi/v3/vrrp-a/vrid/{vrid-val}/blade-parameters/tracking-options/gateway/ipv4-gateway/{ip-address}

ipv6-gateway-list

Type: List

Reference Object: /axapi/v3/vrrp-a/vrid/{vrid-val}/blade-parameters/tracking-options/gateway/ipv6-gateway/{ipv6-address}

blade-parameters_tracking-options_gateway_ipv4-gateway-list¶

Specification Value

Type list

Block object keys

ip-address

Description IP Address

Type: string

Format: ipv4-address

priority-cost

Description The amount the priority will decrease

Type: number

Range: 1-255

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

blade-parameters_tracking-options_gateway_ipv6-gateway-list¶

Specification Value

Type list

Block object keys

ipv6-address

Description IPV6 address

Type: string

Format: ipv6-address

priority-cost

Description The amount the priority will decrease

Type: number

Range: 1-255

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

blade-parameters_tracking-options_trunk-cfg¶

Specification Value

Type list

Block object keys

per-port-pri

Description per port priority

Type: number

Range: 0-255

Default: 0

priority-cost

Description The amount the priority will decrease

Type: number

Range: 1-255

trunk

Description trunk tracking (Trunk Number)

Type: number

Range: 1-4096

floating-ip¶

Specification Value

Type object

ip-address-cfg

Type: List

ip-address-part-cfg

Type: List

ipv6-address-cfg

Type: List

ipv6-address-part-cfg

Type: List

floating-ip_ipv6-address-part-cfg¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet (for link-local address only)

Type: number

Format: interface

ipv6-address-partition

Description IPV6 address

Type: string

Format: ipv6-address

trunk

Description Trunk interface (for link-local address only)

Type: number

Range: 1-4096

ve

Description VE interface (for link-local address only)

Type: number

Range: 2-4094

Reference Object: /axapi/v3/network/vlan

floating-ip_ip-address-cfg¶

Specification Value

Type list

Block object keys

ip-address

Description IP Address

Type: string

Format: ipv4-address

floating-ip_ip-address-part-cfg¶

Specification Value

Type list

Block object keys

ip-address-partition

Description IP Address

Type: string

Format: ipv4-address

floating-ip_ipv6-address-cfg¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet (for link-local address only)

Type: number

Format: interface

ipv6-address

Description IPV6 address

Type: string

Format: ipv6-address

trunk

Description Trunk interface (for link-local address only)

Type: number

Range: 1-4096

Reference Object: /axapi/v3/interface/trunk

ve

Description VE interface (for link-local address only)

Type: number

Range: 2-4094

Reference Object: /axapi/v3/network/vlan

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘associated_vip_count’: Number of vips associated to vrid; ‘associated_vport_count’: Number of vports associated to vrid; ‘associated_natpool_count’: Number of nat pools associated to vrid;

Type: string

Supported Values: all, associated_vip_count, associated_vport_count, associated_natpool_count

preempt-mode¶

Specification Value

Type object

disable

Description disable preemption

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

threshold

Description preemption threshold (preemption threshhold (0-255), default 0)

Type: number

Range: 0-255

Default: 0

follow¶

Specification Value

Type object

vrid-lead

Description Define a VRRP-A VRID leader

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters