description (interface)
To add a description to an interface configuration, use the description command. To remove the description, use the no form of this command.
description description
no description
Syntax Description
description |
String description of the interface configuration. This string is limited to 80 characters. |
Command Default
No description is added.
Command Modes
Interface configuration mode
Subinterface configuration mode
Virtual Ethernet interface configuration
Command History
Release |
Modification |
---|---|
4.0(0)N1(1a) |
This command was introduced. |
5.0(3)N1(1) |
Support for Layer 3 interfaces and virtual Ethernet interface was added. |
5.1(3)N1(1) |
Support for virtual Ethernet interface was added. |
Usage Guidelines
The description command is meant to provide a reminder in the configuration to describe what certain interfaces are used for. The description appears in the output of the following commands such as show interface and show running-config .
You can use this command on the following interfaces:
- Ethernet interface
- Management interface
- Subinterfaces
- Virtual Ethernet interface
Examples
This example shows how to add a description for an interface:
switch# configure terminal
switch(config)# interface ethernet 1/1
switch(config-if)# description "10G Server Link"
switch(config-if)#
This example shows how to add a description for a virtual Ethernet interface:
switch# configure terminal
switch(config)# interface vethernet 1
switch(config-if)# description "Virtual interface"
switch(config-if)#