vrrp-a fail-over-policy-template¶
Define a VRRP-A failover policy template
fail-over-policy-template Specification¶
Parameter
Value
Type
Collection
Object Key(s)
name
Collection Name
Collection URI
/axapi/v3/vrrp-a/fail-over-policy-template
Element Name
fail-over-policy-template
Element URI
/axapi/v3/vrrp-a/fail-over-policy-template/{name}
Element Attributes
fail-over-policy-template_attributes
Partition Visibility
shared
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/vrrp-a/fail-over-policy-template | ||
Create List | POST | /axapi/v3/vrrp-a/fail-over-policy-template | ||
Get Object | GET | /axapi/v3/vrrp-a/fail-over-policy-template/{name} | ||
Get List | GET | /axapi/v3/vrrp-a/fail-over-policy-template | ||
Modify Object | POST | /axapi/v3/vrrp-a/fail-over-policy-template/{name} | ||
Replace Object | PUT | /axapi/v3/vrrp-a/fail-over-policy-template/{name} | ||
Replace List | PUT | /axapi/v3/vrrp-a/fail-over-policy-template | ||
Delete Object | DELETE | /axapi/v3/vrrp-a/fail-over-policy-template/{name} | ||
fail-over-policy-template-list¶
fail-over-policy-template-list is JSON List of fail-over-policy-template attributes
fail-over-policy-template-list : [
fail-over-policy-template attributes¶
bgp
Description: bgp is a JSON Block. Please see below for bgp
Type: Object
gateway
Description: gateway is a JSON Block. Please see below for gateway
Type: Object
interface
Type: List
name
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 route
Type: Object
trunk-cfg
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
vlan-cfg
Type: List
interface¶
Specification
Value
Type
list
Block object keys
ethernet
Description Ethernet Interface (Ethernet interface number)
Type: number
Format: interface
weight
Description The failover event weight
Type: number
Range: 1-255
gateway¶
Specification
Value
Type
object
gw-ipv4-address-cfg
Type: List
gw-ipv6-address-cfg
Type: 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
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
bgp¶
Specification
Value
Type
object
bgp-ipv4-address-cfg
Type: List
bgp-ipv6-address-cfg
Type: 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
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
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
route¶
Specification
Value
Type
object
ip-destination-cfg
Type: List
ipv6-destination-cfg
Type: 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
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
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