configure port description-string

configure ports port_list description-string string


Configures a description string setting up to 255 characters.

Syntax Description


Specifies one or more ports or slots and ports.


Specifies a port description of up to 255 characters per port. You cannot use the following characters: ‘ “ ‘, “<”, “>”, “:”, “;”, “<space>”, “&”



Usage Guidelines

Use this command to configure a port description of up to 255 characters per port.

The description string must start with an alphanumeric character.

In case that user configures a string longer than 64 chars, the following warning will be displayed:

Port description strings longer than 64 chars are only accessible through SNMP if the following command is issued: configure snmp ifmib ifalias size extended

Some characters are not permitted as they have special meanings. These are: ‘ “ ‘, “<”, “>”, “:”, “<space>”, “&”. The first character should be alphanumeric. This new field is CLI accessible only via “show port info detail” but is also accessible via the SNMP ifAlias object of IfXTable from IF-MIB (RFC 2233) and the XML API. In order to access the value via SNMP the following command should be issued: configure snmp ifmib ifalias size extended.


The following command configures the port:

configure ports 1:3 description-string CorporatePort_123


This command was available in ExtremeXOS 15.3.

Platform Availability

This command is available on ExtremeSwitching X435, X440-G2, X450-G2, X460-G2, X465, X590, X620, X670-G2, X690, X695, X870, 5320, 5420, and 5520 series switches.