configure vlan description

configure [ vlan [vlan_id | vlan_list] | vman [vman_id | vman_list] | svlan [svlan_id | svlan_list] | cvlan [cvlan_id | cvlan_list ] | bvlan [bvlan_id | bvlan_list] ]description [vlan-desc | none]


Configures a description for the specified VLAN, VMAN, SVLAN, CVLAN, or BVLAN.

Syntax Description

vlan , vman, svlan, cvlan, bvlan Specifies that you are describing a VLAN, VMAN, SVLAN, CVLAN, or BVLAN, respectively.
vlan_id , vman_id, svlan_id, cvlan_id, bvlan_id Specifies a VLAN, VMAN, SVLAN, CVLAN, or BVLAN ID , respectively (between 1–4,094).
vlan_list , vman_list, svlan_list, cvlan_list, bvlan_list Specifies a VLAN, VMAN, SVLAN, CVLAN, or BVLAN list , respectively (between 1–4,094).
vlan-desc Specifies a VLAN description (up to 64 characters) that appears in show vlan commands and can be read from the ifAlias MIB object for the VLAN.
none This keyword removes the configured VLAN description.


By default, the VLAN has no description.

Usage Guidelines

The VLAN description must be in quotes if the string contains any space characters. If a VLAN description is configured for a VLAN that already has a description, the new description replaces the old description.


The following example assigns the description "Campus A" to VLAN vlan1:

configure vlan vlan1 description “Campus A”


This command was first available in ExtremeXOS 12.4.4.

VLAN ID support was added in ExtremeXOS 16.2.

Platform Availability

This command is available on all platforms.