network virtual-wire-health-check¶
Virtual Wire Health Check Configuration
virtual-wire-health-check Specification¶
Parameter
Value
Type
Collection
Object Key(s)
vlan
Collection Name
Collection URI
/axapi/v3/network/virtual-wire-health-check
Element Name
virtual-wire-health-check
Element URI
/axapi/v3/network/virtual-wire-health-check/{vlan}
Element Attributes
virtual-wire-health-check_attributes
Partition Visibility
shared
Statistics Data URI
/axapi/v3/network/virtual-wire-health-check/{vlan}/stats
Operational Data URI
/axapi/v3/network/virtual-wire-health-check/{vlan}/oper
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/network/virtual-wire-health-check | ||
Create List | POST | /axapi/v3/network/virtual-wire-health-check | ||
Get Object | GET | /axapi/v3/network/virtual-wire-health-check/{vlan} | ||
Get List | GET | /axapi/v3/network/virtual-wire-health-check | ||
Modify Object | POST | /axapi/v3/network/virtual-wire-health-check/{vlan} | ||
Replace Object | PUT | /axapi/v3/network/virtual-wire-health-check/{vlan} | ||
Replace List | PUT | /axapi/v3/network/virtual-wire-health-check | ||
Delete Object | DELETE | /axapi/v3/network/virtual-wire-health-check/{vlan} | ||
virtual-wire-health-check-list¶
virtual-wire-health-check-list is JSON List of virtual-wire-health-check attributes
virtual-wire-health-check-list : [
virtual-wire-health-check attributes¶
active-threshold
Description Threshold(Packet Per Second) for entering active mode
Type: number
Range: 1-1048575
enable
Description Enable the health check
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ethernet
Description Ethernet interface
Type: number
Format: interface
garp-interval
Description Interval (Seconds), default is 3, 0 for interface event only
Type: number
Range: 0-180
interval
Description Interval (Seconds), default is 3
Type: number
Range: 1-180
l3-packet
Description Only count L3 packets
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
method
Description ‘ping’: Ping; ‘garp’: GARP; ‘packet-count’: Packet Count;
Type: string
Supported Values: ping, garp, packet-count
nexthop-ip
Description Nexthop address
Type: string
Format: ipv4-address
nexthop-mac
Description Nexthop mac address
Type: string
Format: mac-address
partition-health-check
Description Health check state stands for the partition
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sampling-enable
Type: List
sby-ethernet
Description Ethernet interface
Type: number
Format: interface
source-ip
Description source ip for ping method
Type: string
Format: ipv4-address
source-mac
Description source mac for ping method
Type: string
Format: mac-address
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
Description VLAN ID, specify 1 for untagged traffic
Type: number
Range: 1-4094
sampling-enable¶
Specification
Value
Type
list
Block object keys
counters1
Description ‘all’: all; ‘act-event’: Active Event Count; ‘sby-event’: Standby Event Count; ‘packet-count’: Packet Count;
Type: string
Supported Values: all, act-event, sby-event, packet-count