network vlan¶
Configure VLAN
vlan Specification¶
Type Collection Object Key(s) vlan-num Collection Name vlan-list Collection URI /axapi/v3/network/vlan Element Name vlan Element URI /axapi/v3/network/vlan/{vlan-num} Element Attributes vlan_attributes Statistics Data URI /axapi/v3/network/vlan/{vlan-num}/stats Schema vlan schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/network/vlan | ||
Create List | POST | /axapi/v3/network/vlan | ||
Get Object | GET | /axapi/v3/network/vlan/{vlan-num} | ||
Get List | GET | /axapi/v3/network/vlan | ||
Modify Object | POST | /axapi/v3/network/vlan/{vlan-num} | ||
Replace Object | PUT | /axapi/v3/network/vlan/{vlan-num} | ||
Replace List | PUT | /axapi/v3/network/vlan | ||
Delete Object | DELETE | /axapi/v3/network/vlan/{vlan-num} | ||
vlan-list¶
vlan-list is JSON List of vlan attributes
vlan-list : [
]
vlan attributes¶
name
Description VLAN name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
sampling-enable
Type: Listtagged-eth-list
Type: Listtagged-trunk-list
Type: Listuntagged-eth-list
Type: Listuntagged-lif
Description Logical tunnel interface (Logical tunnel interface number)
Type: number
Range: 1-128
untagged-trunk-list
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
ve
Description ve number
Type: number
Range: 2-4094
vlan-num
Description VLAN number
Type: number
Range: 2-4094
untagged-trunk-list¶
Specification Type list Block object keys untagged-trunk-end
Description Trunk Group
Type: number
untagged-trunk-start
Description Trunk groups
Type: number
untagged-eth-list¶
Specification Type list Block object keys untagged-ethernet-end
Description Ethernet port
Type: number
Format: interface
untagged-ethernet-start
Description Ethernet port (Interface number)
Type: number
Format: interface
Refernce Object: /axapi/v3/interface/ethernet
tagged-eth-list¶
Specification Type list Block object keys tagged-ethernet-end
Description Ethernet port
Type: number
Format: interface
tagged-ethernet-start
Description Ethernet port (Interface number)
Type: number
Format: interface
sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘broadcast_count’: Broadcast counter; ‘multicast_count’: Multicast counter; ‘ip_multicast_count’: IP Multicast counter; ‘unknown_unicast_count’: Unknown Unicast counter; ‘mac_movement_count’: Mac Movement counter;
Type: string
Supported Values: all, broadcast_count, multicast_count, ip_multicast_count, unknown_unicast_count, mac_movement_count
tagged-trunk-list¶
Specification Type list Block object keys tagged-trunk-end
Description Trunk Group
Type: number
tagged-trunk-start
Description Trunk groups
Type: number
stats data¶
| Counter | Size | Description | |
|---|---|---|---|
| multicast_count | 4 | Multicast counter | |
| ip_multicast_count | 4 | IP Multicast counter | |
| unknown_unicast_count | 4 | Unknown Unicast counter | |
| broadcast_count | 4 | Broadcast counter | |
| mac_movement_count | 4 | Mac Movement counter |