CCNA online course

How to Configure Interface Descriptions in Cisco IOS

Learn how to add, verify, edit, remove, and save Cisco IOS interface descriptions for clearer documentation and troubleshooting.

An interface description is administrative text assigned to a network interface. It identifies the interface's purpose, connected endpoint, location, or service. Descriptions are supported on many Cisco IOS and IOS XE physical and logical interfaces.

Descriptions improve physical and logical documentation. During troubleshooting, a technician can quickly determine whether a port connects to an access point, server, WAN circuit, or another switch. They also help with handoffs, audits, change management, cabling records, and incident response.

Prerequisites and IOS Configuration Modes

Cisco IOS is the operating system used by many Cisco routers and switches. Interface descriptions are configured through several command-line modes.

The description command must be entered in interface configuration mode. The general navigation sequence is:

Router> enable
Router# configure terminal
Router(config)# interface gigabitEthernet 1/0/1
Router(config-if)# description TO-DIST-SW1_Gi1/0/1_UPLINK
Router(config-if)# end
Router#

end returns directly to privileged EXEC mode. You can also use exit to move back one configuration level at a time.

Selecting the Correct Interface

Interface names and numbering vary by device family, hardware module, platform, and IOS release. Use the full name shown by the device when possible. Common interface types include:

To identify available interfaces, use commands such as:

show interfaces description
show ip interface brief

IOS commonly accepts abbreviated interface names, such as int Gi1/0/1, but an abbreviation must uniquely identify one interface. Full names are clearer in procedures and change records.

Configuring an Interface Description

Enter the target interface, then use description followed by meaningful text:

Switch# configure terminal
Switch(config)# interface gigabitEthernet 1/0/1
Switch(config-if)# description TO-DIST-SW1_Gi1/0/1_UPLINK
Switch(config-if)# end

Useful description content can include:

• Remote device name and remote interface
• Circuit identifier or provider reference
• Connection purpose, such as uplink, user access, voice, management, or server
• Location, room, rack, or office
• VLAN or service role
• Asset identifier or owning team, when useful and permitted by policy

A practical convention is to use a consistent order, separators, and abbreviations. For example:

description TO-<REMOTE-DEVICE>_<REMOTE-PORT>_<PURPOSE>

 description TO-DIST-SW1_Gi1/0/1_UPLINK
 description PRINTER_3F-COPYROOM_ASSET-PRN204_VLAN30
 description ISP-ACME_CIRCUIT-ABC123_TO-BRANCH-02_WAN
 description VLAN10_MANAGEMENT_SVI
 description UNUSED_RESERVED

IOS generally treats the remainder of the command line as the description, so spaces may be accepted without quotation marks. Quoting rules, maximum length, accepted characters, and displayed formatting can differ among IOS versions, IOS XE releases, and device families. Avoid unusual control characters and test locally. Use context-sensitive help to confirm what the platform accepts:

Switch(config-if)# description ?

Recommended Description Formats

Descriptions should complement, not replace, network diagrams, IP address management records, asset inventories, cabling databases, and change records. Keep them concise and structured enough to scan in command output. Do not store passwords, secrets, private keys, or security-sensitive operational details in interface descriptions. Avoid excessively long, unstructured notes.

Using Interface Range Configuration

Interface range enters configuration mode for multiple interfaces. It is useful when applying a common convention, such as labeling a group of ports as unused:

Switch# configure terminal
Switch(config)# interface range gigabitEthernet 1/0/10 - 12
Switch(config-if-range)# description UNUSED_RESERVED
Switch(config-if-range)# end

Each interface in the range receives the same text. Do not use a single generic description when each port connects to a different device. Configure distinct descriptions individually when the remote endpoint, location, or purpose differs.

Verifying Interface Descriptions

The primary summary command is:

Switch# show interfaces description

Typical output includes the interface name, administrative status, line protocol status, and description. For example:

Interface              Status         Protocol Description
Gi1/0/1                up             up       TO-DIST-SW1_Gi1/0/1_UPLINK
Gi1/0/2                up             up       PRINTER_3F-COPYROOM_ASSET-PRN204
Gi1/0/10               administratively down down UNUSED_RESERVED

The administrative status indicates whether configuration has enabled or disabled the interface. The line protocol status indicates the operational Layer 2 or protocol state. Compare these fields with the documented connection. A correct description does not prove that the cable, VLAN, neighbor, or service is working.

To inspect the active configuration for one interface, use:

Switch# show running-config interface gigabitEthernet 1/0/1

To view operational details for an individual interface, use:

Switch# show interfaces gigabitEthernet 1/0/1

The detailed output may show the configured description near the interface heading. Use the running configuration command when you need an unambiguous configuration check.

Editing and Removing Descriptions

Entering another description command replaces the existing text; it does not append to it.

Switch# configure terminal
Switch(config)# interface gigabitEthernet 1/0/1
Switch(config-if)# description TO-DIST-SW2_Gi1/0/24_UPLINK
Switch(config-if)# end
Switch# show running-config interface gigabitEthernet 1/0/1

Remove the description with the no form:

Switch# configure terminal
Switch(config)# interface gigabitEthernet 1/0/1
Switch(config-if)# no description
Switch(config-if)# end
Switch# show interfaces description

Always verify that the old text has been replaced or is no longer present. When a cable, endpoint, or uplink moves, update the description as part of the same approved change.

Saving the Configuration

The running-config is the active configuration currently used by the device. The startup-config is the saved configuration loaded after a restart. A description added only to the running configuration disappears after a reload if it has not been saved.

Switch# copy running-config startup-config

Follow local operational procedures for saving and validating changes. If required, confirm that the saved configuration contains the description after the copy operation.

Common Problems and Troubleshooting

The description command is rejected

• Confirm that the prompt indicates interface configuration mode, such as Switch(config-if)#.
• Confirm that the interface name and numbering are valid for the device.
• Use show interfaces description or show ip interface brief to identify interfaces.
• Use description ? to inspect platform-specific syntax and supported input.

The description does not appear in expected output

• Check whether a different interface was configured.
• Match the exact interface identifier in show interfaces description.
• Use show running-config interface <interface-id> to inspect the active configuration.
• Confirm the physical port-to-device mapping.

An old description remains after a network change

• Validate the neighbor, cabling record, and interface status.
• Check that the change was made on the correct router or switch.
• Replace the old text with a new description command, verify it, and save the configuration.

Descriptions disappear after a reload

The running configuration was probably not copied to the startup configuration. Save it with copy running-config startup-config, then verify the saved configuration according to local policy.

The interface is down despite having a description

A description is only documentation. Check administrative and line protocol status, the presence of shutdown, cabling, transceiver or Layer 1 conditions, speed and duplex where relevant, VLAN assignment, and the neighboring device configuration.

Operational Checklist

1. Identify the correct local interface and its actual connected endpoint.
2. Choose a consistent description format used by the organization.
3. Enter interface configuration mode.
4. Apply or update the description.
5. Verify it with show interfaces description.
6. Inspect the specific interface with show running-config interface ... when needed.
7. Update related diagrams, inventory, IPAM, and change records.
8. Save the running configuration to the startup configuration.

Related Cisco IOS Topics

• Configure Passwords in IOS for access-control configuration basics.
• Configure NTP on a Cisco Device for reliable timestamps in logs and change verification.
• OSI Reference Model for understanding the relationship between interface status, Layer 2, and Layer 3 operation.