Add an Interface Description to the Configuration

You can include a text description of each physical interface in the configuration file. Any descriptive text you include is displayed in the output of the show interfaces commands, and is also exposed in the ifAlias MIB object. It has no impact on the interface's configuration. To add a text description, include the description statement at the [edit interfaces interface-name] hierarchy level:

[edit interfaces interface-name]

description text; 

The description can be a single line of text. If the text contains spaces, enclose it in quotation marks.

For information about describing logical units, see Add a Logical Unit Description to the Configuration.

Example: Add an Interface Description to the Configuration

Add a description to a SONET interface:

[edit interfaces so-1/1/0]

user@host# set description "BB: phl01 P12/0/0 - local wire" 

[edit interfaces so-1/1/0]

user@host# commit

[edit interfaces so-1/1/0]

user@host# exit configuration-mode

cli> show interfaces so-1/1/0 

so-1/1/0 {

    physical-interface index 9 snmp-ifindex 10;

    enabled physical-link up;

    description "BB: phl01 P12/0/0 - local wire";

    encapsulation cisco-hdlc;

...