network vlan¶

Configure VLAN

vlan Specification¶

Parameter Value

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

Partition Visibility None

Statistics Data URI /axapi/v3/network/vlan/{vlan-num}/stats

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

tagged-eth-list

Type: List

tagged-trunk-list

Type: List

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 Value

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 Value

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 Value

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

tagged-trunk-list¶

Specification Value

Type list

Block object keys

tagged-trunk-end

Description Trunk Group

Type: number

tagged-trunk-start

Description Trunk groups

Type: number