configure bgp neighbor description

configure bgp neighbor [all | remoteaddr] description {description}


Configures a description for a BGP neighbor.

Syntax Description

all Specifies all IPv4 and IPv6 neighbors.
remoteaddr Specifies the IPv4 or IPv6 address of a BGP neighbor.
description Specifies a string used to describe the neighbor.


The description is a NULL string by default.

Usage Guidelines

Use this command to attach a description to a BGP neighbor. This description is displayed in the output of the show bgp neighbor command when you specify the detail option, or when you specify a particular neighbor. Enclose the string in double quotes if there are any blank spaces in the string. The maximum length of the string is 56 characters.

If you do not specify the description parameter, the description is reset to the default.

This command applies to the current VR or VRF context.


The following command configures the description for the BGP neighbor to Toledo_5:

configure bgp neighbor description Toledo_5


This command was first available in ExtremeXOS 11.0.

This command required a specific license in ExtremeXOS 11.1.

Support for IPv6 was added in ExtremeXOS 12.6 BGP.

Platform Availability

This command is available on platforms that support the appropriate license. For complete information about software licensing, including how to obtain and upgrade your license and which licenses support the BGP feature, see the Switch Engine 32.2 Feature License Requirements document.