description (interface view)

Function

The description command configures the description of an interface.

The undo description command deletes the description of an interface.

By default, the description of an interface is empty.

Format

description description

undo description

Parameters

Parameter	Description	Value
description	Specifies the description of an interface.	The value is a string of 1 to 242 case-sensitive characters, with spaces supported.

Parameter

Description

Value

description

Specifies the description of an interface.

The value is a string of 1 to 242 case-sensitive characters, with spaces supported.

Views

NULL interface view, controller view, all-interface view

Default Level

2: Configuration level

Task Name and Operations

Task Name	Operations
interface-mgr	write

Usage Guidelines

Usage Scenario

To help simplify interface management, run the description command on an interface to identify the interface and describe the function of the interface.

Implementation Procedure

Run the description command to configure the description of an interface. Note that the description is displayed from the first non-space character, and a maximum of 242 characters can be displayed.

Follow-up Procedure

After running the description command to configure the description of an interface, run the display interface description command to view the description.

Precautions

It is recommended that the descriptions of all activated interfaces be standardized based on customers.

Example

# Configure the description of a Gigabit Ethernet interface as Connect to Device A GigabitEthernet0/1/0 interface.

<HUAWEI> system-view
[~HUAWEI] interface GigabitEthernet 0/1/0
[*HUAWEI-GigabitEthernet0/1/0] description Connect to DeviceA GigabitEthernet0/1/0 interface