network virtual-wire¶
Configure Virtual Wire
virtual-wire Specification¶
Type Collection Object Key(s) virtual-wire-id Collection Name virtual-wire-list Collection URI /axapi/v3/network/virtual-wire Element Name virtual-wire Element URI /axapi/v3/network/virtual-wire/{virtual-wire-id} Element Attributes virtual-wire_attributes Operational Data URI /axapi/v3/network/virtual-wire/{virtual-wire-id}/oper Schema virtual-wire schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/network/virtual-wire | ||
Create List | POST | /axapi/v3/network/virtual-wire | ||
Get Object | GET | /axapi/v3/network/virtual-wire/{virtual-wire-id} | ||
Get List | GET | /axapi/v3/network/virtual-wire | ||
Modify Object | POST | /axapi/v3/network/virtual-wire/{virtual-wire-id} | ||
Replace Object | PUT | /axapi/v3/network/virtual-wire/{virtual-wire-id} | ||
Replace List | PUT | /axapi/v3/network/virtual-wire | ||
Delete Object | DELETE | /axapi/v3/network/virtual-wire/{virtual-wire-id} |
virtual-wire-list¶
virtual-wire-list is JSON List of virtual-wire attributes
virtual-wire-list : [
]
virtual-wire attributes¶
eth1
eth2
group1
Description
Type: number
Range: 1-16
Reference Object: /axapi/v3/network/virtual-wire-ethernet-group
group2
Description
Type: number
Range: 1-16
Reference Object: /axapi/v3/network/virtual-wire-ethernet-group
trunk1
trunk2
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
virtual-wire-id
Description virtual wire id
Type: number
Range: 1-32
operational data¶
Counter | Size | Description | |
---|---|---|---|
endpoints | endpoints | ||
virtual_wire_status | enum | Output contains one of the following values: - Up, Down |