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 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

Get Stats

GET

/axapi/v3/network/vlan/{vlan-num}/stats

stats data

vlan-list

vlan-list is JSON List of vlan Attributes

vlan-list : [

vlan Attributes

name

Description: VLAN name

Type: string

Format: string-rlx

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

tagged-eth-list

Description: tagged-eth-list is a JSON List . Please see below for tagged-eth-list

Type: List

tagged-trunk-list

Description: tagged-trunk-list is a JSON List . Please see below for tagged-trunk-list

Type: List

untagged-eth-list

Description: untagged-eth-list is a JSON List . Please see below for untagged-eth-list

Type: List

untagged-lif

Description: Logical tunnel interface (Logical tunnel interface number)

Type: number

Range: 1-128

untagged-trunk-list

Description: untagged-trunk-list is a JSON List . Please see below for untagged-trunk-list

Type: List

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

ve

Description: ve number

Type: number

Range: 2-4094

vlan-num

Description: VLAN number

Type: number

Range: 2-4094

Required: Yes

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

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;

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