Support

Table Of Contents

About Cisco IOS XE Software Documentation

Documentation Objectives

Audience

Documentation Conventions

Typographic Conventions

Command Syntax Conventions

Software Conventions

Reader Alert Conventions

Documentation Organization

Cisco IOS XE Documentation Set

Cisco IOS XE Documentation on Cisco.com

Configuration Guides, Command References, and Supplementary Resources

Additional Resources and Documentation Feedback

About Cisco IOS XE Software Documentation

---

Last Updated: February 25, 2009

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:

•Documentation Objectives

•Audience

•Documentation Conventions

•Documentation Organization

•Additional Resources and Documentation Feedback

Documentation Objectives

Cisco IOS XE documentation describe the tasks and commands available to configure and maintain Cisco networking devices.

Audience

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.

Documentation Conventions

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 includes the following topics:

•Typographic Conventions

•Command Syntax Conventions

•Software Conventions

•Reader Alert Conventions

Typographic Conventions

Cisco IOS XE documentation uses the following typographic conventions:

Convention	Description
^ or Ctrl	Both the ^ symbol and Ctrl represent the Control (Ctrl) key on a keyboard. For example, the key combination ^D or Ctrl-D means that you 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 a Simple Network Management Protocol (SNMP) community string to public, do not use quotation marks around the string; otherwise, the string will include the quotation marks.

Command Syntax Conventions

Cisco IOS XE documentation uses the following command syntax conventions:

Convention	Description
bold	Bold text indicates commands and keywords that you enter as shown.
italic	Italic text indicates arguments for which you supply values.
[x]	Square brackets enclose an optional keyword or argument.
...	An ellipsis (three consecutive nonbolded periods without spaces) after a syntax element indicates that the element can be repeated.
|	A vertical line, called a pipe, indicates a choice within a set of keywords or arguments.
[x | y]	Square brackets enclosing keywords or arguments separated by a pipe indicate an optional choice.
{x | y}	Braces enclosing keywords or arguments separated by a pipe indicate a required choice.
[x {y | z}]	Braces and a pipe within square brackets indicate a required choice within an optional element.

Software Conventions

Cisco IOS XE Software uses the following program code conventions:

Convention	Description
Courier font	Courier font is used for information that is displayed on a PC or terminal screen.
Bold Courier font	Bold Courier font indicates text that the user must enter.
<     >	Angle brackets enclose text that is not displayed, such as a password. Angle brackets also are used in contexts in which the italic font style is not supported; for example, ASCII text.
!	An exclamation point at the beginning of a line indicates that the text that follows is a comment, not a line of code. An exclamation point is also displayed by the Cisco IOS XE software for certain processes.
[     ]	Square brackets enclose default responses to system prompts.

Reader Alert Conventions

The Cisco IOS XE documentation set 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.

---

Documentation Organization

This section describes the Cisco IOS XE documentation set, how it is organized, and how to access the documentation on Cisco.com. Included are lists of configuration guides, command references, and supplementary references and resources that make up the documentation sets. The following topics are included:

•Cisco IOS XE Documentation Set

•Cisco IOS XE Documentation on Cisco.com

•Configuration Guides, Command References, and Supplementary Resources

Cisco IOS XE Documentation Set

Cisco IOS XE documentation 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 code. Review release notes before other documents to learn whether or not 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 informational and task-oriented descriptions of Cisco IOS XE features.

–Command references—Compilations of command pages that provide detailed information about the commands used in the Cisco IOS XE features and processes that make up 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.

•Lists of all the commands in a specific release and all commands that are new, modified, removed, or replaced in the release.

•Command reference book for debug commands. Command pages are listed in alphabetical order.

•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.

New Features List

The New Features List for each release provides a list of all features in the release with hyperlinks to the feature guides in which they are documented.

Configuration Guides

Configuration guides are provided by technology and release and comprise a set of individual feature guides relevant to the release and technology.

Command References

Command reference books describe Cisco IOS XE commands that are supported in many different software releases and on many different platforms. The books are provided 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 are comprehensive, meaning that they include 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.

For additional information about configuring and operating specific networking devices, go to the Product Support area of Cisco.com at http://www.cisco.com/web/psa/products/index.html.

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.

Table 1 Cisco IOS XE Configuration Guides and Command References 

Configuration Guide and Command Reference Titles	Features/Protocols/Technologies
Cisco IOS XE AppleTalk Configuration Guide Cisco IOS AppleTalk Command Reference	AppleTalk protocol.
Cisco IOS XE Asynchronous Transfer Mode Configuration Guide Cisco IOS Asynchronous Transfer Mode Command Reference	LAN ATM, multiprotocol over ATM (MPoA), and WAN ATM.
Cisco IOS XE Broadband and DSL Configuration Guide Cisco IOS Broadband and DSL Command Reference	PPP over Ethernet (PPPoE).
Cisco IOS XE Configuration Fundamentals Configuration Guide Cisco IOS Configuration Fundamentals Command Reference	Autoinstall, Setup, Cisco IOS command-line interface (CLI), Cisco IOS file system (IFS), Cisco IOS web browser user interface (UI), basic file transfer services, and file management.
Cisco IOS XE DECnet Configuration Guide Cisco IOS DECnet Command Reference	DECnet protocol.
Cisco IOS XE Dial Technologies Configuration Guide Cisco IOS Dial Technologies Command Reference	Asynchronous communications, dial backup, dialer technology, multilink PPP (MLP), PPP, virtual private dialup network (VPDN).
Cisco IOS XE High Availability Configuration Guide Cisco IOS High Availability Command Reference	A variety of High Availability (HA) features and technologies that are available for different network segments (from enterprise access to service provider core) to facilitate creation of end-to-end highly available networks. Cisco IOS HA features and technologies can be categorized in three key areas: system-level resiliency, network-level resiliency, and embedded management for resiliency.
Cisco IOS XE Intelligent Services Gateway Configuration Guide Cisco IOS Intelligent Services Gateway Command Reference	Subscriber identification, service and policy determination, session creation, session policy enforcement, session life-cycle management, accounting for access and service usage, session state monitoring.
Cisco IOS XE Interface and Hardware Component Configuration Guide Cisco IOS Interface and Hardware Component Command Reference	LAN interfaces, logical interfaces, serial interfaces, virtual interfaces, and interface configuration.
Cisco IOS XE IP Addressing Services Configuration Guide Cisco IOS IP Addressing Services Command Reference	IP addressing, Address Resolution Protocol (ARP), Network Address Translation (NAT), Domain Name System (DNS), Dynamic Host Configuration Protocol (DHCP), and Next Hop Address Resolution Protocol (NHRP).
Cisco IOS XE IP Application Services Configuration Guide Cisco IOS IP Application Services Command Reference	Enhanced Object Tracking (EOT), Gateway Load Balancing Protocol (GLBP), Hot Standby Router Protocol (HSRP), IP Services, TCP, Web Cache Communication Protocol (WCCP), User Datagram Protocol (UDP), and Virtual Router Redundancy Protocol (VRRP).
Cisco IOS XE IP Multicast Configuration Guide Cisco IOS IP Multicast Command Reference	Protocol Independent Multicast (PIM) sparse mode (PIM-SM), bidirectional PIM (bidir-PIM), Source Specific Multicast (SSM), Multicast Source Discovery Protocol (MSDP), Internet Group Management Protocol (IGMP), and Multicast VPN (MVPN).
Cisco IOS XE IP Routing Protocols Configuration Guide Cisco IOS IP Routing Protocols Command Reference	Bidirectional Forwarding Detection (BFD), Border Gateway Protocol (BGP), Enhanced Interior Gateway Routing Protocol (EIGRP), Intermediate System-to-Intermediate System (IS-IS), On-Demand Routing (ODR), Open Shortest Path First (OSPF), protocol-independent routing, and Routing Information Protocol (RIP).
Cisco IOS XE IP SLAs Configuration Guide Cisco IOS IP SLAs Command Reference	Cisco IOS IP Service Level Agreements (IP SLAs).
Cisco IOS XE IP Switching Configuration Guide Cisco IOS IP Switching Command Reference	Cisco Express Forwarding.
Cisco IOS XE IPv6 Configuration Guide Cisco IOS IPv6 Command Reference	For a list of IPv6 features, protocols, and technologies, go to the IPv6 "Start Here" document at the following URL: http://www.cisco.com/en/US/docs/ios/ios_xe/ipv6/configuration/guide/ip6-roadmap_xe.html
Cisco IOS XE ISO CLNS Configuration Guide Cisco IOS ISO CLNS Command Reference	ISO connectionless network service (CLNS).
Cisco IOS XE LAN Switching Configuration Guide Cisco IOS LAN Switching Command Reference	VLANs and multilayer switching (MLS).
Cisco IOS XE Multiprotocol Label Switching Configuration Guide Cisco IOS Multiprotocol Label Switching Command Reference	MPLS Label Distribution Protocol (LDP), MPLS Layer 2 VPNs, MPLS Layer 3 VPNs, MPLS Traffic Engineering (TE), and MPLS Embedded Management (EM) and MIBs.
Cisco IOS XE NetFlow Configuration Guide Cisco IOS NetFlow Command Reference	Network traffic data analysis, aggregation caches, export features.
Cisco IOS XE Network Management Configuration Guide Cisco IOS Network Management Command Reference	Basic system management; system monitoring and logging; Cisco IOS Scripting with Tool Control Language (Tcl); Cisco networking services (CNS); Embedded Event Manager (EEM); Embedded Syslog Manager (ESM); HTTP; and Remote Monitoring (RMON); SNMP.
Cisco IOS XE Novell IPX Configuration Guide Cisco IOS Novell IPX Command Reference	Novell Internetwork Packet Exchange (IPX) protocol.
Cisco IOS XE Quality of Service Solutions Configuration Guide Cisco IOS Quality of Service Solutions Command Reference	Class-based weighted fair queueing (CBWFQ), low latency queueing (LLQ), Modular Quality of Service (QoS) Command-Line Interface (CLI) (MQC), Network-Based Application Recognition (NBAR), priority queueing, Multilink PPP (MLPPP) for QoS, header compression, Resource Reservation Protocol (RSVP), weighted fair queueing (WFQ), and weighted random early detection (WRED).
Cisco IOS XE Security Configuration Guide Cisco IOS Security Command Reference	Access control lists (ACLs), authentication, authorization, and accounting (AAA), firewalls, IP security and encryption, neighbor router authentication, network access security, public key infrastructure (PKI), RADIUS, and TACACS+.
Cisco IOS XE VPDN Configuration Guide Cisco IOS VPDN Command Reference	Multihop by Dialed Number Identification Service (DNIS), timer and retry enhancements for L2TP and Layer 2 Forwarding (L2F), RADIUS Attribute 82: tunnel assignment ID, shell-based authentication of VPDN users, tunnel authentication via RADIUS on tunnel terminator.
Cisco IOS XE Wide-Area Networking Configuration Guide Cisco IOS Wide-Area Networking Command Reference	Frame Relay.

Table 2 Cisco IOS XE Software Supplementary Documents and Resources 

Document Title	Description
Cisco IOS Master Command List, All Releases	Alphabetical list of all the commands documented in all Cisco IOS XE Software releases.
Cisco IOS XE Software System Messages	List of Cisco IOS XE system messages and descriptions. System messages may indicate problems with your system; be informational only; or may help diagnose problems with communications lines, internal hardware, or the system software.
Cisco IOS Debug Command Reference	Alphabetical list of debug commands including brief descriptions of use, command syntax, and usage guidelines.
Release Notes and Caveats	Information about new and changed features, system requirements, and other useful information about specific software releases; information about defects in specific Cisco IOS XE Software releases.
MIBs	Files used for network monitoring. To locate and download MIBs for selected platforms, Cisco IOS XE Software releases, and feature sets, use Cisco MIB Locator at the following URL: http://www.cisco.com/go/mibs
RFCs	Standards documents maintained by the Internet Engineering Task Force (IETF) that Cisco IOS XE documentation references where applicable. The full text of referenced RFCs may be obtained at the following URL: http://www.rfc-editor.org/

Additional Resources and Documentation Feedback

What's New in Cisco Product Documentation is published 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:

•Technical documentation

•Cisco product security overview

•Product alerts and field notices

•Technical assistance

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.

---

CCDE, CCENT, Cisco Eos, Cisco HealthPresence, the Cisco logo, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, Cisco TelePresence, Cisco WebEx, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store are service marks; and Access Registrar, Aironet, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event Center, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, iQuick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare, SenderBase, SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.

All other trademarks mentioned in this document or website 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. (0812R)

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 Cisco Systems, Inc. All rights reserved.