peer description (BGP)
Function
The peer description command configures a description for a peer or peer group.
The undo peer description command deletes the description of a peer or peer group.
By default, no description is configured for a peer or peer group.
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 a 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 a peer. | It is in dotted decimal notation. |
| ipv6-address | Specifies the IPv6 address of a peer. | The value is a 32-digit hexadecimal number, in the format of X:X:X:X:X:X:X:X. |
| description-text | Specifies a description, which can be letters and digits. | The value is a string of 1 to 80 characters, with spaces supported. |
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 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.
Precautions
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.
Follow-up Procedure
You can run display bgp peer ipv4-address verbose command can be used to view the description of a peer.