peer description (BGP)
Function
The peer description command sets the description of the peer or peer group.
The undo peer description command removes the description of the peer or peer group.
By default, the description of peer or peer group is not set.
Format
peer { group-name | ipv4-address | ipv6-address } description description-text
undo peer { group-name | ipv4-address | ipv6-address } description
Parameters
| Parameter | Description | Value |
|---|---|---|
| group-name | Specifies the name of the peer group. | The name is a string of 1 to 47 case-sensitive characters, with spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. |
| ipv4-address | Specifies the IPv4 address of the peer. | - |
| ipv6-address | Specifies the IPv6 address of the peer. | - |
| description-text | Specifies the description. | The description is a string of letters or figures. The value ranges from 1 to 80 characters that can contain spaces. |
ipv4-address is valid only in the BGP view and BGP-VPN instance IPv4 address family view.
ipv6-address is valid only in the BGP view and BGP-VPN instance IPv6 address family view.
Views
BGP view, BGP-VPN instance IPv4 address family view, BGP-VPN instance IPv6 address family view
Usage Guidelines
Usage Scenario
The peer description can be used to configure a description for a peer or peer group, which facilitates memorization and management of peers or peer groups. The description records information about the peer or peer group, such as the VPN instance to which the peer or peer group belongs, and devices that establish peer relationships with the peer or peer group.
Procedure
The description configured by using the peer description command for a peer is displayed from the first non-space character, and a maximum of 80 characters can be displayed.
Configuration Impact
If the peer description command is run more than once to configure a description for a peer, the latest configuration overwrites the previous one.
Follow-up Procedure
display bgp peer verbose command can be used to view the description of a peer.