Description - H3C S6812 Series Command Reference Manual

Usage guidelines
CAUTION:
The default command might interrupt ongoing network services. Make sure you are fully aware of
the impact of this command when you use it on a live network.
This command might fail to restore the default settings for some commands for reasons such as
command dependencies or system restrictions. Use the display this command in interface view to
identify these commands, and then use their undo forms or follow the command reference to restore
their default settings. If your restoration attempt still fails, follow the error message instructions to
resolve the problem.
Examples
# Restore the default settings for VLAN-interface 1.
<Sysname> system-view
[Sysname] interface vlan-interface 1
[Sysname-Vlan-interface1] default

description

Use description to configure the description of a VLAN or VLAN interface.
Use undo description to restore the default.
Syntax
description text
undo description
Default
For a VLAN, the description is VLAN vlan-id. The vlan-id argument specifies the VLAN ID in a
four-digit format. If the VLAN ID has fewer than four digits, leading zeros are added. For example, the
default description of VLAN 100 is VLAN 0100.
For a VLAN interface, the description is the name of the interface. For example, Vlan-interface1
Interface.
Views
VLAN view
VLAN interface view
Predefined user roles
network-admin
Parameters
text: Specifies a description, a case-sensitive string of 1 to 255 characters.
Usage guidelines
To manage VLANs and VLAN interfaces efficiently, configure descriptions for them based on their
functions or connections.
Examples
# Configure the description of VLAN 2 as sales-private.
<Sysname> system-view
[Sysname] vlan 2
[Sysname-vlan2] description sales-private
2