configure vlan description

configure {vlan} vlan_name description [vlan-description | none]


Configures a description for the specified VLAN.

Syntax Description

vlan_name Specifies the VLAN name.
vlan-description 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.

Platform Availability

This command is available on ExtremeSwitching 5320, 5420, 5520, and 5720 series switches.