vrrp-a¶
HA VRRP-A Global Commands
vrrp-a Specification¶
Parameter Value Type Intermediate Resource Element Name vrrp-a Element URI /axapi/v3/vrrp-a Element Attributes vrrp-a_attributes Partition Visibility shared Schema vrrp-a schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/vrrp-a | vrrp-a_attributes |
vrrp-a attributes¶
common
Description: common is a JSON Block. Please see below for common
Type: Object
Reference Object: /axapi/v3/vrrp-a/common
fail-over-policy-template-list
Type: List
Reference Object: /axapi/v3/vrrp-a/fail-over-policy-template/{name}
force-self-standby
Description: force-self-standby is a JSON Block. Please see below for force-self-standby
Type: Object
Reference Object: /axapi/v3/vrrp-a/force-self-standby
force-self-standby-persistent-list
Type: List
Reference Object: /axapi/v3/vrrp-a/force-self-standby-persistent/{vrid}
interface
Description: interface is a JSON Block. Please see below for interface
Type: Object
Reference Object: /axapi/v3/vrrp-a/interface
l2-inline-peer-ip-list
Type: List
Reference Object: /axapi/v3/vrrp-a/l2-inline-peer-ip/{ip-address}
l3-inline-mode-flag
Description: l3-inline-mode-flag is a JSON Block. Please see below for l3-inline-mode-flag
Type: Object
Reference Object: /axapi/v3/vrrp-a/l3-inline-mode-flag
ospf-inline-list
Type: List
Reference Object: /axapi/v3/vrrp-a/ospf-inline/{vlan}
partition-vrid-all-status
Description: partition-vrid-all-status is a JSON Block. Please see below for partition-vrid-all-status
Type: Object
Reference Object: /axapi/v3/vrrp-a/partition-vrid-all-status
partition-vrid-status
Description: partition-vrid-status is a JSON Block. Please see below for partition-vrid-status
Type: Object
Reference Object: /axapi/v3/vrrp-a/partition-vrid-status
peer-group
Description: peer-group is a JSON Block. Please see below for peer-group
Type: Object
Reference Object: /axapi/v3/vrrp-a/peer-group
preferred-session-sync-port
Description: preferred-session-sync-port is a JSON Block. Please see below for preferred-session-sync-port
Type: Object
Reference Object: /axapi/v3/vrrp-a/preferred-session-sync-port
restart-port-list
Description: restart-port-list is a JSON Block. Please see below for restart-port-list
Type: Object
Reference Object: /axapi/v3/vrrp-a/restart-port-list
session-sync
Description: session-sync is a JSON Block. Please see below for session-sync
Type: Object
Reference Object: /axapi/v3/vrrp-a/session-sync
state
Description: state is a JSON Block. Please see below for state
Type: Object
Reference Object: /axapi/v3/vrrp-a/state
state-cpu
Description: state-cpu is a JSON Block. Please see below for state-cpu
Type: Object
Reference Object: /axapi/v3/vrrp-a/state-cpu
vrid-lead-list
Type: List
Reference Object: /axapi/v3/vrrp-a/vrid-lead/{vrid-lead-str}
vrid-list
Type: List
Reference Object: /axapi/v3/vrrp-a/vrid/{vrid-val}
session-sync¶
Specification Value Type object action
Description ‘enable’: enable vrrp-a session sync (default); ‘disable’: disable vrrp-a session sync;
Type: string
Supported Values: enable, disable
Default: enable
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vrid-list¶
Specification Value Type list Block object keys blade-parameters
Description: blade-parameters is a JSON Block. Please see below for vrid-list_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 vrid-list_floating-ip
Type: Object
follow
Description: follow is a JSON Block. Please see below for vrid-list_follow
Type: Object
pair-follow
Description: pair-follow is a JSON Block. Please see below for vrid-list_pair-follow
Type: Object
preempt-mode
Description: preempt-mode is a JSON Block. Please see below for vrid-list_preempt-mode
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-val
Description Specify ha VRRP-A vrid
Type: number
Range: 0-31
Default: 0
vrid-list_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
vrid-list_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 vrid-list_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
vrid-list_blade-parameters_tracking-options¶
Specification Value Type object bgp
Description: bgp is a JSON Block. Please see below for vrid-list_blade-parameters_tracking-options_bgp
Type: Object
gateway
Description: gateway is a JSON Block. Please see below for vrid-list_blade-parameters_tracking-options_gateway
Type: Object
Reference Object: /axapi/v3/vrrp-a/vrid/{vrid-val}/blade-parameters/tracking-options/gateway
interface
Type: Listroute
Description: route is a JSON Block. Please see below for vrid-list_blade-parameters_tracking-options_route
Type: Object
trunk-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vlan-cfg
Type: List
vrid-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
vrid-list_blade-parameters_tracking-options_route¶
Specification Value Type object ip-destination-cfg
Type: Listipv6-destination-cfg
Type: List
vrid-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
vrid-list_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
vrid-list_blade-parameters_tracking-options_bgp¶
Specification Value Type object bgp-ipv4-address-cfg
Type: Listbgp-ipv6-address-cfg
Type: List
vrid-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
vrid-list_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
vrid-list_blade-parameters_tracking-options_interface¶
Specification Value Type list Block object keys ethernet
Description Ethernet Interface (Ethernet interface number)
Type: number
Format: interface
Range: 0-222
priority-cost
Description The amount the priority will decrease
Type: number
Range: 1-255
vrid-list_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}
vrid-list_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
vrid-list_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
vrid-list_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
vrid-list_floating-ip¶
Specification Value Type object ip-address-cfg
Type: Listip-address-part-cfg
Type: Listipv6-address-cfg
Type: Listipv6-address-part-cfg
Type: List
vrid-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
Range: 7-103
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
vrid-list_floating-ip_ip-address-cfg¶
Specification Value Type list Block object keys ip-address
Description IP Address
Type: string
Format: ipv4-address
vrid-list_floating-ip_ip-address-part-cfg¶
Specification Value Type list Block object keys ip-address-partition
Description IP Address
Type: string
Format: ipv4-address
vrid-list_floating-ip_ipv6-address-cfg¶
Specification Value Type list Block object keys ethernet
Description Ethernet (for link-local address only)
Type: number
Format: interface
Range: 7-103
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
vrid-list_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
vrid-list_follow¶
Specification Value Type object vrid-lead
Description Define a VRRP-A VRID leader
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
force-self-standby-persistent-list¶
Specification Value Type list Block object keys uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vrid
Description Specify one VRRP-A vrid to force into standby state
Type: number
Range: 0-31
force-self-standby¶
Specification Value Type object action
Description ‘enable’: enable vrrp-a force-self-standby; ‘disable’: disable vrrp-a force-self-standby;
Type: string
Supported Values: enable, disable
all-partitions
Description force all partitions in standby state
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
vrid
Description Specify one VRRP-A vrid to force into standby state
Type: number
Range: 0-31
l3-inline-mode-flag¶
Specification Value Type object l3-inline-mode
Description Enable Layer 3 Inline Hot Standby Mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
peer-group¶
Specification Value Type object peer
Description: peer is a JSON Block. Please see below for peer-group_peer
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
peer-group_peer¶
Specification Value Type object ip-peer-address-cfg
Type: Listipv6-peer-address-cfg
Type: List
peer-group_peer_ip-peer-address-cfg¶
Specification Value Type list Block object keys ip-peer-address
Description IP Address
Type: string
Format: ipv4-address
peer-group_peer_ipv6-peer-address-cfg¶
Specification Value Type list Block object keys ipv6-peer-address
Description IPV6 address
Type: string
Format: ipv6-address
ospf-inline-list¶
Specification Value Type list Block object keys uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vlan
Description Do not filter OSPF packet on specific vlan (Vlan number)
Type: number
Range: 1-4094
fail-over-policy-template-list¶
Specification Value Type list Block object keys bgp
Description: bgp is a JSON Block. Please see below for fail-over-policy-template-list_bgp
Type: Object
gateway
Description: gateway is a JSON Block. Please see below for fail-over-policy-template-list_gateway
Type: Object
interface
Type: Listname
Description VRRP-A fail over policy template name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
route
Description: route is a JSON Block. Please see below for fail-over-policy-template-list_route
Type: Object
trunk-cfg
Type: Listuser-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
vlan-cfg
Type: List
fail-over-policy-template-list_vlan-cfg¶
Specification Value Type list Block object keys timeout
Description
Type: number
Range: 2-600
vlan
Description VLAN tracking (VLAN id)
Type: number
Range: 1-4094
weight
Description The failover event weight
Type: number
Range: 1-255
fail-over-policy-template-list_route¶
Specification Value Type object ip-destination-cfg
Type: Listipv6-destination-cfg
Type: List
fail-over-policy-template-list_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
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
weight
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
fail-over-policy-template-list_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
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
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
weight
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
fail-over-policy-template-list_bgp¶
Specification Value Type object bgp-ipv4-address-cfg
Type: Listbgp-ipv6-address-cfg
Type: List
fail-over-policy-template-list_bgp_bgp-ipv4-address-cfg¶
Specification Value Type list Block object keys bgp-ipv4-address
Description bgp IP Address
Type: string
Format: ipv4-address
weight
Description The failover event weight
Type: number
Range: 1-255
fail-over-policy-template-list_bgp_bgp-ipv6-address-cfg¶
Specification Value Type list Block object keys bgp-ipv6-address
Description IPV6 address
Type: string
Format: ipv6-address
weight
Description The failover event weight
Type: number
Range: 1-255
fail-over-policy-template-list_interface¶
Specification Value Type list Block object keys ethernet
Description Ethernet Interface (Ethernet interface number)
Type: number
Format: interface
Range: 7-128
weight
Description The failover event weight
Type: number
Range: 1-255
fail-over-policy-template-list_gateway¶
Specification Value Type object gw-ipv4-address-cfg
Type: Listgw-ipv6-address-cfg
Type: List
fail-over-policy-template-list_gateway_gw-ipv4-address-cfg¶
Specification Value Type list Block object keys gw-ipv4-address
Description IP Address
Type: string
Format: ipv4-address
weight
Description The failover event weight
Type: number
Range: 1-255
fail-over-policy-template-list_gateway_gw-ipv6-address-cfg¶
Specification Value Type list Block object keys gw-ipv6-address
Description IPV6 address
Type: string
Format: ipv6-address
weight
Description The failover event weight
Type: number
Range: 1-255
fail-over-policy-template-list_trunk-cfg¶
Specification Value Type list Block object keys per-port-weight
Description Per port failover weight
Type: number
Range: 0-255
Default: 0
trunk
Description trunk tracking (trunk id)
Type: number
Range: 1-4096
weight
Description failover event weight
Type: number
Range: 1-255
vrid-lead-list¶
Specification Value Type list Block object keys partition
Description: partition is a JSON Block. Please see below for vrid-lead-list_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
vrid-lead-list_partition¶
Specification Value Type object name-cfg
Description: name-cfg is a JSON Block. Please see below for vrid-lead-list_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 vrid-lead-list_partition_shared-cfg
Type: Object
vrid-lead-list_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
state¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
partition-vrid-all-status¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
common¶
Specification Value Type object action
Description ‘enable’: enable vrrp-a; ‘disable’: disable vrrp-a;
Type: string
Supported Values: enable, disable
Default: disable
arp-retry
Description Number of additional gratuitous ARPs sent out after HA failover (1-255, default is 4)
Type: number
Range: 1-255
Default: 4
dead-timer
Description VRRP-A dead timer in terms of how many hello messages missed, default is 5 (2-255, default is 5)
Type: number
Range: 2-255
Default: 5
device-id
Description Unique ID for each VRRP-A box (Device-id number)
Type: number
disable-default-vrid
Description Disable default vrid
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-sync-session-seq-number
Description enable monitoring sending and receiving sync packets with sequence number
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
forward-l4-packet-on-standby
Description Enables Layer 2/3 forwarding of Layer 4 traffic on the Standby ACOS device
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
get-ready-time
Description set get ready time after ax starting up (60-1200, in unit of 100millisec, default is 60)
Type: number
Range: 60-1200
Default: 60
hello-interval
Description VRRP-A Hello Interval (1-255, in unit of 100millisec, default is 2)
Type: number
Range: 1-255
Default: 2
hostid-append-to-vrid
Description: hostid-append-to-vrid is a JSON Block. Please see below for common_hostid-append-to-vrid
Type: Object
inline-mode-cfg
Description: inline-mode-cfg is a JSON Block. Please see below for common_inline-mode-cfg
Type: Object
preemption-delay
Description Delay before changing state from Active to Standby (1-255, in unit of 100millisec, default is 60)
Type: number
Range: 1-255
Default: 60
restart-time
Description Time between restarting ports on standby system after transition
Type: number
Range: 1-100
Default: 20
set-id
Description Set-ID for HA configuration (Set id from 1 to 15)
Type: number
Range: 1-15
track-event-delay
Description Delay before changing state after up/down event (Units of 100 milliseconds (default 30))
Type: number
Range: 1-100
Default: 30
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
common_hostid-append-to-vrid¶
Specification Value Type object hostid-append-to-vrid-default
Description hostid append to vrid default
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: hostid-append-to-vrid-default and hostid-append-to-vrid-value are mutually exclusive
hostid-append-to-vrid-value
Description hostid append to vrid num
Type: number
Range: 1-31
Mutual Exclusion: hostid-append-to-vrid-value and hostid-append-to-vrid-default are mutually exclusive
common_inline-mode-cfg¶
Specification Value Type object inline-mode
Description Enable Layer 2 Inline Hot Standby Mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
preferred-port
Description Preferred ethernet Port
Type: number
Format: interface
Range: 0-1
Mutual Exclusion: preferred-port and preferred-trunk are mutually exclusive
preferred-trunk
Description Preferred trunk Port
Type: number
Range: 1-4096
Mutual Exclusion: preferred-trunk and preferred-port are mutually exclusive
interface¶
Specification Value Type object ethernet-list
Type: List
Reference Object: /axapi/v3/vrrp-a/interface/ethernet/{ethernet-val}
trunk-list
Type: List
Reference Object: /axapi/v3/vrrp-a/interface/trunk/{trunk-val}
interface_trunk-list¶
Specification Value Type list Block object keys both
Description both a router and server interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: both, router-interface, and server-interface are mutually exclusive
no-heartbeat
Description do not send out heartbeat packet from this interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: no-heartbeat and vlan are mutually exclusive
router-interface
Description interface to upstream router
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: router-interface, server-interface, and both are mutually exclusive
server-interface
Description interface to real server
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: server-interface, router-interface, and both are mutually exclusive
trunk-val
Description Ethernet Interface
Type: number
Range: 1-4096
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
vlan-cfg
Type: List
interface_trunk-list_vlan-cfg¶
Specification Value Type list Block object keys vlan
Description VLAN ID
Type: number
Range: 2-4094
Mutual Exclusion: vlan and no-heartbeat are mutually exclusive
interface_ethernet-list¶
Specification Value Type list Block object keys both
Description both a router and server interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: both, router-interface, and server-interface are mutually exclusive
ethernet-val
Description Ethernet Interface
Type: number
Format: interface
Range: 7-15
no-heartbeat
Description do not send out heartbeat packet from this interface
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: no-heartbeat and vlan are mutually exclusive
router-interface
Description interface to upstream router
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: router-interface, server-interface, and both are mutually exclusive
server-interface
Description interface to real server
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: server-interface, router-interface, and both are mutually exclusive
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
vlan-cfg
Type: List
interface_ethernet-list_vlan-cfg¶
Specification Value Type list Block object keys vlan
Description VLAN ID
Type: number
Range: 2-4094
Mutual Exclusion: vlan and no-heartbeat are mutually exclusive
restart-port-list¶
Specification Value Type object ethernet-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vrid-list
Type: List
Reference Object: /axapi/v3/vrrp-a/restart-port-list/vrid/{vrid-val}
restart-port-list_vrid-list¶
Specification Value Type list Block object keys ethernet-cfg
Type: Listuser-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
restart-port-list_vrid-list_ethernet-cfg¶
Specification Value Type list Block object keys flap-ethernet-end
Description Ethernet Port
Type: number
Format: interface
flap-ethernet-start
Description Ethernet Port
Type: number
Format: interface
restart-port-list_ethernet-cfg¶
Specification Value Type list Block object keys flap-ethernet-end
Description Ethernet Port
Type: number
Format: interface
flap-ethernet-start
Description Ethernet Port
Type: number
Format: interface
preferred-session-sync-port¶
Specification Value Type object ethernet-list
Type: List
Reference Object: /axapi/v3/vrrp-a/preferred-session-sync-port/ethernet/{pre-eth}
trunk-list
Type: List
Reference Object: /axapi/v3/vrrp-a/preferred-session-sync-port/trunk/{pre-trunk}
preferred-session-sync-port_trunk-list¶
Specification Value Type list Block object keys pre-trunk
Description Trunk Interface number
Type: number
Range: 1-4096
pre-vlan
Description Interface VLAN (VLAN ID)
Type: number
Range: 2-4094
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
preferred-session-sync-port_ethernet-list¶
Specification Value Type list Block object keys pre-eth
Description Ethernet interface number
Type: number
Format: interface
Range: 7-176
pre-vlan
Description Interface VLAN (VLAN ID)
Type: number
Range: 2-4094
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
l2-inline-peer-ip-list¶
Specification Value Type list Block object keys ip-address
Description IP address (IPv4 address)
Type: string
Format: ipv4-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
partition-vrid-status¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
state-cpu¶
Specification Value Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters