KB 613242 - Adding a Description to an Interface on SONiC Switch

KB 613242 - Adding a Description to an Interface on SONiC Switch

Title: How to Set Interface Description on SONiC Switch

Purpose: This guide explains how to add or update descriptions for switch interfaces using SONiC-CLI.

Applicable Products: Edgecore SOnic 4.4.3

Steps

  1. Access SONiC CLI:

sonic-cli

  1. Enter configuration mode:

configure terminal

  1. Select the interface:

interface Ethernet<PORT_NUMBER>

Example:

interface Ethernet0

  1. Set the interface description:

description "Node1 HSN-A"

  1. Exit configuration:

exit

  1. Verify the description:

show running-configuration interface Ethernet0

Notes:

  • Descriptions help identify which device or purpose each port serves.

  • Descriptions can be updated or removed anytime with the same command.