Ad space (banner)
📡Networking Lessons
Lesson 10 / 39

Labeling a Port with description

When you want to be able to tell later what a port is used for, use description. It is used in interface configuration mode and attaches an explanatory note to the port.

The syntax is description text. The text has no effect on traffic at all — it is purely an annotation for humans.

Running description Uplink to Core Switch records "Uplink to Core Switch" against the port, and it appears in show running-config and similar output.

A common stumble is running dozens of ports with no descriptions and eventually losing track of what each port is for. Always record the far end and the purpose.

In real work, the larger the network, the more the habit of recording peer device names and VLAN purposes in descriptions determines how fast you can respond to failures and perform maintenance.

Networking
Try it (type this into the pseudo terminal)
description Uplink to Core Switch

🧑‍💻 You can type this command into the Networking pseudo terminal to try it yourself (this page itself has no interactive terminal).

Ad space (banner)
Ad space (in-article)