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
Operational Data URI	/axapi/v3/network/vlan/{vlan-num}/oper
Schema	vlan schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/network/vlan	vlan attributes
Create List	POST	/axapi/v3/network/vlan	vlan attributes
Get Object	GET	/axapi/v3/network/vlan/{vlan-num}	vlan attributes
Get List	GET	/axapi/v3/network/vlan	vlan-list
Modify Object	POST	/axapi/v3/network/vlan/{vlan-num}	vlan attributes
Replace Object	PUT	/axapi/v3/network/vlan/{vlan-num}	vlan attributes
Replace List	PUT	/axapi/v3/network/vlan	vlan-list
Delete Object	DELETE	/axapi/v3/network/vlan/{vlan-num}	vlan attributes

vlan-list

vlan-list is JSON List of vlan attributes

vlan-list : [

{ vlan attributes },

{ vlan attributes },

…

]

vlan attributes

name

Description VLAN name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

sampling-enable

Type: List

shared-vlan

Description Configure VLAN as a shared VLAN

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

tagged-eth-list

Type: List

tagged-trunk-list

Type: List

traffic-distribution-mode

Description ‘sip’: sip; ‘dip’: dip; ‘primary’: primary; ‘blade’: blade; ‘l4-src-port’: l4-src-port; ‘l4-dst-port’: l4-dst-port;

Type: string

Supported Values: sip, dip, primary, blade, l4-src-port, l4-dst-port

untagged-eth-list

Type: List

untagged-lif

Description Logical tunnel interface (Logical tunnel interface name)

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

untagged-trunk-list

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

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

Reference Object: /axapi/v3/interface/ethernet

untagged-ethernet-start

Description Ethernet port (Interface number)

Type: number

Format: interface

Reference 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; ‘shared_vlan_partition_switched_counter’: SVLAN Partition switched counter;

Type: string

Supported Values: all, broadcast_count, multicast_count, ip_multicast_count, unknown_unicast_count, mac_movement_count, shared_vlan_partition_switched_counter

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
	shared_vlan_partition_switched_counter	4	SVLAN Partition switched counter
	unknown_unicast_count	4	Unknown Unicast counter
	broadcast_count	4	Broadcast counter
	mac_movement_count	4	Mac Movement counter
	multicast_count	4	Multicast counter
	ip_multicast_count	4	IP Multicast counter

operational data

	Counter	Size	Description
	span-tree	string	span-tree
	tagg_eth_ports		tagg_eth_ports
	vlan_name	string	vlan_name
	un_tagg_logical_ports		un_tagg_logical_ports
	tagg_logical_ports		tagg_logical_ports
	ve_num	number	ve_num
	is_shared_vlan	string	is_shared_vlan
	un_tagg_eth_ports		un_tagg_eth_ports