Table Of Contents
About Cisco IOS XE Software Documentation
Last Updated: November 24, 2010
This document describes the objectives, audience, conventions, and organization used in Cisco IOS XE software documentation. Also included are resources for obtaining technical assistance, additional documentation, and other information from Cisco. This document is organized into the following sections:
Cisco IOS XE documentation describe the tasks and commands available to configure and maintain Cisco networking devices.
The Cisco IOS XE documentation set is intended for users who configure and maintain Cisco networking devices (such as routers and switches) but who may not be familiar with the configuration and maintenance tasks, the relationship among tasks, or the Cisco IOS commands necessary to perform particular tasks. The Cisco IOS XE documentation set is also intended for those users experienced with Cisco IOS XE software who need to know about new features, new configuration options, and new software characteristics in the current Cisco IOS XE release.
In Cisco IOS XE documentation, the term router may be used to refer to various Cisco products; for example, routers, access servers, and switches. These and other networking devices that support Cisco IOS XE software are shown interchangeably in examples and are used only for illustrative purposes. An example that shows one product does not necessarily mean that other products are not supported.
This section contains the following topics:
Cisco IOS XE documentation uses the following typographic conventions:
Command Syntax Conventions
Cisco IOS XE documentation uses the following command syntax conventions:
Cisco IOS XE software uses the following conventions:
Reader Alert Conventions
Cisco IOS XE documentation uses the following conventions for reader alerts:
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 material not covered in the manual.
Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.
This section describes the Cisco IOS XE documentation set, how it is organized, and how to access it on Cisco.com. Listed are configuration guides, command references, and supplementary references and resources that comprise the documentation set.
Cisco IOS XE Documentation Set
The Cisco IOS XE documentation set consists of the following:
•Release notes and caveats provide information about platform, technology, and feature support for a release and describe severity 1 (catastrophic), severity 2 (severe), and severity 3 (moderate) defects in released Cisco IOS XE software. Review release notes before other documents to learn whether updates have been made to a feature.
•Sets of configuration guides and command references organized by technology and published for each standard Cisco IOS XE release.
–Configuration guides—Compilations of documents that provide conceptual and task-oriented descriptions of Cisco IOS XE features.
–Command references—Alphabetical compilations of command pages that provide detailed information about the commands used in the Cisco IOS XE features and the processes that comprise the related configuration guides. For each technology, there is a single command reference that covers all Cisco IOS XE releases and that is updated at each standard release.
•Command reference book for debug commands.
•Lists of all the commands in a specific release and all commands that are new, modified, removed, or replaced in the release.
•Reference book for system messages for all Cisco IOS XE releases.
Cisco IOS XE Documentation on Cisco.com
The following sections describe the documentation organization and how to access various document types.
Use Cisco Feature Navigator to find information about Cisco IOS XE software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Configuration guides are provided by technology and release and comprise a set of individual feature guides relevant to the release and technology.
Command reference books describe Cisco IOS XE commands that are supported in many different software releases and on many different platforms. The books are organized by technology. For information about all Cisco IOS XE commands, use the Command Lookup Tool at http://tools.cisco.com/Support/CLILookup or the Cisco IOS Master Command List, All Releases, at http://www.cisco.com/en/US/docs/ios/mcl/allreleasemcl/all_book.html.
Cisco IOS XE Supplementary Documents and Resources
Supplementary documents and resources are listed in Table 2.
Configuration Guides, Command References, and Supplementary Resources
Table 1 lists, in alphabetical order, Cisco IOS XE software configuration guides and command references, including brief descriptions of the contents of the documents. The command references contain commands for both Cisco IOS software and Cisco IOS XE software, for all releases. The command references support many different software releases and platforms. Your Cisco IOS XE software release or platform may not support all these technologies.
Table 2 lists documents and resources that supplement the Cisco IOS XE software configuration guides and command references. These supplementary resources include release notes and caveats; master command lists; new, modified, removed, and replaced command lists; system messages; and the debug command reference.
For additional information about configuring and operating specific networking devices, and to access Cisco IOS documentation, go to the Product/Technologies Support area of Cisco.com at the following location:
Table 2 lists documents and resources that supplement the Cisco IOS XE software configuration guides and command references.
Additional Resources and Documentation Feedback
What's New in Cisco Product Documentation is updated monthly and describes all new and revised Cisco technical documentation. The What's New in Cisco Product Documentation publication also provides information about obtaining the following resources:
•Cisco product security overview
•Product alerts and field notices
Cisco IOS XE software technical documentation includes embedded feedback forms where you can rate documents and provide suggestions for improvement. Your feedback helps us improve our documentation.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1005R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.
© 2009-2010 Cisco Systems, Inc. All rights reserved.