Document Conventions - Cisco CRS-1 - Carrier Routing System Router Api Manual

Document Conventions

•
•
•
•
•
•
•
•
•
•
•
Document Conventions
This publication uses the following conventions:
•
Command descriptions use these conventions:
•
•
•
•
Examples use these conventions:
•
•
•
•
•
Means reader take note. Notes contain helpful suggestions or references to material not covered in the
Note
publication.
Tip Means the following information will help you solve a problem. The information in tips might not contain
troubleshooting or task-specific actions, but tips do contain useful information.
Cisco CRS-1 Carrier Routing System XML API Guide
x
Chapter 4, "Cisco CRS-1 Series XML and Native Data Operations"
Chapter 5, "Cisco CRS-1 Series XML and Native Data Access Techniques"
Chapter 6, "Cisco CRS-1 Series XML and Encapsulated CLI Operations"
Chapter 7, "Cisco CRS-1 Series XML and Large Data Retrieval (Iterators)"
Chapter 8, "Cisco CRS-1 Series XML Security"
Chapter 9, "Cisco CRS-1 Series XML Schema Versioning"
Chapter 10, "Error Reporting in Cisco CRS-1 Series XML Responses"
Chapter 11, "XML Transport and Event Notifications"
Chapter 12, "Summary of Cisco CRS-1 Series XML API Configuration Tags"
Chapter 13, "Cisco CRS-1 Series XML Schemas"
Appendix A, "Sample BGP Configuration"
The symbol ^ represents the key labeled Ctrl. For example, the key combination ^z means "hold
down the Ctrl key while you press the Z key."
Examples that contain system prompts denote interactive sessions, indicating the commands that
you should enter at the prompt. The system prompt indicates the current level of the EXEC
command interpreter. For example, the prompt router> indicates the user level, and the prompt
router# indicates the privileged level. Access to the privileged level usually requires a password.
Commands and keywords are in boldface font.
Arguments for which you supply values are in italic font.
Elements in square brackets ([ ]) are optional.
Alternative but required keywords are grouped in braces ({ }) and separated by vertical bars (|).
–
Terminal sessions and sample console screen displays are in
Information you enter is in
Nonprinting characters, such as passwords, are in angle brackets (< >).
Default responses to system prompts are in square brackets ([ ]).
An exclamation point (!) at the beginning of a line indicates a comment line.
font.
boldface screen
font.
screen
Preface
OL-4596-01