Adding a Description to an Interface on SONiC Switch

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.

    • Related Articles

    • Configuring Management Interface 0 (eth0) on SONiC 4.5.0 Switch via SONiC CLI

      Purpose: This article provides step-by-step instructions to configure the management interface (Management 0 / eth0) on a SONiC 4.5.0 switch with a static IP and default gateway using the SONiC CLI. Scope: Applicable to Edgecore S-series switches ...

    • Creating a VLAN on SONiC Switch (SONiC-CLI)

      Title: How to Create a VLAN on a SONiC Switch Purpose: This guide explains how to create a VLAN on a SONiC switch using SONiC-CLI. Applicable Products: EdgecoreSONiC Enterprise v 4.4.3 Steps Access SONiC CLI: sonic-cli Enter configuration mode: ...

    • Enabling and Validating RoCE (RDMA over Converged Ethernet) on SONiC

      Purpose This guide explains how to enable RoCE on a SONiC switch, verify RDMA interfaces on connected compute nodes, and validate performance using RDMA bandwidth tests. 1. Enable RoCE on SONiC Switch Step 1.1 — Enable Priority Flow Control (PFC) PFC ...

    • How to configure EdgeCore Switch and Access point (Basic Configurations)

      Edge Core 10-port PoE Access Switch (ECS4125-10P) The Edge core ECS4125-10P switch is a 2.5 Gigabit Ethernet access switch with two 10G uplink ports. The switch is an ideal 2.5 Gigabit PoE access switch for SMB, enterprise, and campus networks. The ...

    • What is Boot Process in Linux OS.

      Boot Process in Linux OS. Have you ever wondered what happens behind the scenes from the time you press the power button until the Linux login prompt appears? Press the power button on your system, and after few moments you see the Linux login ...