Preface
This preface describes the audience, organization, and conventions of this document. It also provides information on how to obtain other documentation.
This preface includes the following sections:
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This preface describes the audience, organization, and conventions of this document. It also provides information on how to obtain other documentation.
This preface includes the following sections:
This document is designed for the person who is responsible for configuring your Cisco Enterprise router. This document is intended primarily for the following audiences:
Customers with technical networking background and experience.
System administrators familiar with the fundamentals of router-based internetworking but who might not be familiar with Cisco IOS software.
System administrators who are responsible for installing and configuring internetworking equipment, and who are familiar with Cisco IOS software.
For more information about the Cisco IOS XE software, including features available on your device as described in the configuration guides, see the respective router documentation set.
To verify support for specific features, use the Cisco Feature Navigator tool. This tool enables you to determine the Cisco IOS XE software images that support a specific software release, feature set, or a platform.
This documentation uses the following conventions:
Convention |
Description |
---|---|
^ or Ctrl |
The ^ and Ctrl symbols represent the Control key. For example, the key combination ^D or Ctrl-D means hold down the Control key while you press the D key. Keys are indicated in capital letters but are not case sensitive. |
string |
A string is a nonquoted set of characters shown in italics. For example, when setting an SNMP community string to public, do not use quotation marks around the string or the string will include the quotation marks. |
The command syntax descriptions use the following conventions:
Convention |
Description |
---|---|
bold |
Bold text indicates commands and keywords that you enter exactly as shown. |
italics |
Italic text indicates arguments for which you supply values. |
[x] |
Square brackets enclose an optional element (keyword or argument). |
| |
A vertical line indicates a choice within an optional or required set of keywords or arguments. |
[x | y] |
Square brackets enclosing keywords or arguments separated by a vertical line indicate an optional choice. |
{x | y} |
Braces enclosing keywords or arguments separated by a vertical line indicate a required choice. |
Nested sets of square brackets or braces indicate optional or required choices within optional or required elements. For example, see the following table.
Convention |
Description |
---|---|
[x {y | z}] |
Braces and a vertical line within square brackets indicate a required choice within an optional element. |
Examples use the following conventions:
Convention |
Description |
---|---|
|
Examples of information displayed on the screen are set in Courier font. |
|
Examples of text that you must enter are set in Courier bold font. |
< > |
Angle brackets enclose text that is not printed to the screen, such as passwords. |
! |
An exclamation point at the beginning of a line indicates a comment line. Exclamation points are also displayed by the Cisco IOS XE software for certain processes. |
[ ] |
Square brackets enclose default responses to system prompts. |
Caution |
Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data. |
Note |
Means reader take note. Notes contain helpful suggestions or references to materials that may not be contained in this manual. |
To receive timely, relevant information from Cisco, sign up at Cisco Profile Manager.
To get the business impact you’re looking for with the technologies that matter, visit Cisco Services.
To submit a service request, visit Cisco Support.
To discover and browse secure, validated enterprise-class apps, products, solutions and services, visit Cisco Marketplace.
To obtain general networking, training, and certification titles, visit Cisco Press.
To find warranty information for a specific product or product family, access Cisco Warranty Finder.
Cisco Bug Search Tool (BST) is a web-based tool that acts as a gateway to the Cisco bug tracking system that maintains a comprehensive list of defects and vulnerabilities in Cisco products and software. BST provides you with detailed defect information about your products and software.
To provide feedback about Cisco technical documentation, use the feedback form available in the right pane of every online document.
For the most up-to-date, detailed troubleshooting information, see the Cisco TAC website at https://www.cisco.com/en/US/support/index.html.
Go to Products by Category and choose your product from the list, or enter the name of your product. Look under Troubleshoot and Alerts to find information for the issue that you are experiencing.