vrrp-a vrid

Specify VRRP-A vrid

vrid Specification

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

Create List

POST

/axapi/v3/vrrp-a/vrid/

vrid Attributes

Get Object

GET

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

vrid Attributes

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

Replace List

PUT

/axapi/v3/vrrp-a/vrid/

vrid-list

Delete Object

DELETE

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

vrid Attributes

Get Oper

GET

/axapi/v3/vrrp-a/vrid/{vrid-val}/oper

operational data

vrid-list

vrid-list is JSON List of vrid Attributes

vrid-list : [

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

preempt-mode

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

Type: Object

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

vrid-val

Description: Specify ha VRRP-A vrid

Type: number

Range: 0-31

Default: 0

Required: Yes

blade-parameters

Specification
Type object

fail-over-policy-template

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

Type: string

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

blade-parameters.tracking-options

Specification
Type object

gateway

Description: gateway is a JSON Block . Please see below for l58_gateway

Type: Object

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

interface

Description: interface is a JSON List . Please see below for l58_interface

Type: List

route

Description: route is a JSON Block . Please see below for l58_route

Type: Object

trunk-cfg

Description: trunk-cfg is a JSON List . Please see below for l58_trunk-cfg

Type: List

uuid

Description: uuid of the object

Type: string

vlan-cfg

Description: vlan-cfg is a JSON List . Please see below for l58_vlan-cfg

Type: List

blade-parameters.tracking-options.vlan-cfg

Specification
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: 2-4094

blade-parameters.tracking-options.route

Specification
Type object

ip-destination-cfg

Description: ip-destination-cfg is a JSON List . Please see below for l58_ip-destination-cfg

Type: List

ipv6-destination-cfg

Description: ipv6-destination-cfg is a JSON List . Please see below for l58_ipv6-destination-cfg

Type: List

blade-parameters.tracking-options.route.ipv6-destination-cfg

Specification
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
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.interface

Specification
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
Type object

ipv4-gateway-list

Description: ipv4-gateway-list is a JSON List . Please see below for l58_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

Description: ipv6-gateway-list is a JSON List . Please see below for l58_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
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

blade-parameters.tracking-options.gateway.ipv6-gateway-list

Specification
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

blade-parameters.tracking-options.trunk-cfg

Specification
Type list
Block object keys

per-port-pri

Description: per port priority

Type: number

Range: 1-255

Default: 1

priority-cost

Description: The amount the priority will decrease

Type: number

Range: 1-255

trunk

Description: trunk tracking (Trunk Number)

Type: number

Range: 1-16

floating-ip

Specification
Type object

ip-address-cfg

Description: ip-address-cfg is a JSON List . Please see below for l58_ip-address-cfg

Type: List

ip-address-part-cfg

Description: ip-address-part-cfg is a JSON List . Please see below for l58_ip-address-part-cfg

Type: List

ipv6-address-cfg

Description: ipv6-address-cfg is a JSON List . Please see below for l58_ipv6-address-cfg

Type: List

ipv6-address-part-cfg

Description: ipv6-address-part-cfg is a JSON List . Please see below for l58_ipv6-address-part-cfg

Type: List

floating-ip.ipv6-address-part-cfg

Specification
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
Type list
Block object keys

ip-address

Description: IP Address

Type: string

Format: ipv4-address

floating-ip.ip-address-part-cfg

Specification
Type list
Block object keys

ip-address-partition

Description: IP Address

Type: string

Format: ipv4-address

floating-ip.ipv6-address-cfg

Specification
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

ve

Description: VE interface (for link-local address only)

Type: number

Range: 2-4094

Reference Object: /axapi/v3/network/vlan

preempt-mode

Specification
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
Type object

vrid-lead

Description: Define a VRRP-A VRID leader

Type: string

operational data

Name Type Description
weight number weight
priority number priority
state enum Output contains one of the following values: - Active, Standby
became_active string became_active
force_standby number force_standby
unit number unit