configure vr description

configure vr vr_name description string

Description

Use this command to configure a description for the specified VR or VRF.

Syntax Description

vrf_name Specifies the name of a user VR or a VRF.
string Specifies a text string to describe the VR. If the text string contains space characters, the entire string must be enclosed with double quotes (" ").

Default

No description.

Usage Guidelines

This command allows you to add comments about a VRF/VR entity. Entering a NULL string on the CLI will unconfigure the description string for the VRF/VR. If the description string has spaces in it, then the string must be enclosed within double quotes (" ").

This text message appears in the show virtual-router command display when the command specifies a VR name. For VPN VRFs, this message is returned for a mplsL3VPN MIB query of the MIB variable mplsL3VpnVrfDescription.

Example

The following example configures a description for the VRF "corporate":

configure vr corporate description "VRF for the corporate intranet"

History

This command was first available in ExtremeXOS 12.5.

Platform Availability

This command is available on all platforms.