Within the Cisco ASR 1000 Series Modular Ethernet Line Card Software Configuration Guide
, the term router
is generally used to refer to a variety of Cisco products (for example, routers, access servers, and switches). Routers, access
servers, and other networking devices that support Cisco IOS software are shown interchangeably within examples. These products
are used only for illustrative purposes, that is, an example that shows one product does not necessarily indicate that other
products are not supported.
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. If you do, the string will include the quotation marks.
|
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:
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
|
screen
|
Examples of information displayed on the screen are set in Courier font.
|
bold screen
|
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 software for certain processes.)
|
[ ]
|
Square brackets enclose default responses to system prompts.
|
The following conventions are used to attract the attention of the reader:
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.
|
Tip
|
Means the following information will help you solve a problem
. The tips information might not be troubleshooting or even an action, but could be useful information, similar to a Timesaver.
|