description
Syntax
description text
undo description
View
VLAN view, VLAN interface view
Default level
2: System level
Parameters
text: Specifies the description of a VLAN or VLAN interface. The string can include case-sensitive letters, digits, special characters such as tilde (~), exclamation point (!), at sign (@), pound sign (#), dollar sign ($), percent sign (%), caret (^), ampersand sign (&), asterisk (*), left brace({), right brace (}), left parenthesis ((), right parenthesis ()), left bracket ([), right bracket (]), left angle bracket (<), right angle bracket (>), hyphen (-), underscore(_), plus sign (+), equal sign (=), vertical bar (|), back slash (\), colon (:), semi-colon (;), quotation marks ("), apostrophe ('), comma (,), dot (.), and slash (/), spaces, and other Unicode characters and symbols.
For a VLAN, this is a string of 1 to 32 characters.
For a VLAN interface, this is a string of 1 to 80 characters.
When you specify a description, follow these guidelines:
Each Unicode character takes the space of two regular characters.
To use Unicode characters or symbols in an interface description, install the specific input method editor and log in to the device through remote login software that supports the character type.
When the length of a description string reaches or exceeds the maximum line width on the terminal software, the software starts a new line, possibly breaking a Unicode character into two. As a result, garbled characters may be displayed at the end of a line.
Description
Use description to change the description of the VLAN or VLAN interface.
Use undo description to restore the default.
The default description for a VLAN is the VLAN ID. For example, VLAN 0001.
The default description for a VLAN interface is the name of the interface. For example, Vlan-interface 1 Interface.
You can configure a description to describe the function or connection of a VLAN or VLAN interface for easy management.
Related commands: display interface vlan-interface and display vlan.
Examples
# Change the description of VLAN 2 to sales-private.
<Sysname> system-view [Sysname] vlan 2 [Sysname-vlan2] description sales-private
# Change the description of VLAN-interface 2 to linktoPC56.
<Sysname> system-view [Sysname] vlan 2 [Sysname-vlan2] quit [Sysname] interface vlan-interface 2 [Sysname-Vlan-interface2] description linktoPC56