Cisco IOS XR Software

Table Of Contents

About Cisco IOS XR Software Documentation, Release 3.7

Changes to This Document

Documentation Objectives

Audience

Organization of the Cisco IOS XR Software Release 3.7 Documentation Set

Master Index

Documents

Command References

Configuration Guides

Supporting Documents

Documentation Conventions

Obtaining Documentation, Support, and Security Guidelines

About Cisco IOS XR Software Documentation, Release 3.7

---

This document describes the Cisco IOS XR software documentation and its objectives, audience, organization, and conventions. It also provides sources for obtaining documentation, technical assistance, and additional publications and information from Cisco Systems. The document sections are:

•Changes to This Document

•Documentation Objectives

•Audience

•Organization of the Cisco IOS XR Software Release 3.7 Documentation Set

•Command References

•Configuration Guides

•Supporting Documents

•Documentation Conventions

•Obtaining Documentation, Support, and Security Guidelines

Changes to This Document

Table 1 lists the changes made to this document.

Table 1 Changes to This Document 

Revision	Date	Change Summary
OL-15860-01	June 2008	Initial release of this document.

Documentation Objectives

Cisco IOS XR software documentation describes the tasks and commands that are necessary to configure and maintain a router that uses the Cisco IOS XR software.

Audience

The Cisco IOS XR software documentation is intended primarily for users who configure and maintain routers but who might be unfamiliar with the tasks, relationship between tasks, or Cisco IOS XR software commands necessary to perform these tasks. The Cisco IOS XR software documentation is also intended for experienced users who need to know about the new features, configuration options, and characteristics of the Cisco IOS XR software, Release 3.7.0.

Organization of the Cisco IOS XR Software Release 3.7 Documentation Set

The Cisco IOS XR documentation set provides configuration guides, command references, and other supporting documents. Typical characteristics of the documentation set are:

•Documents are delivered online, in PDF and HTML formats, and are not orderable as printed books.

•Cisco IOS XR Release 3.7.0 provides online documents for each technology area, in addition to release notes.

•All command references present commands in an alphabetical order.

Master Index

The master index of command-line interface (CLI) commands is an online index through which you can navigate and find the description of a CLI command. The master index is linked to the command references and provides a quick way for you to find a command when you know the command name.

Documents

The following types of documents support Cisco IOS XR Software Release 3.7.0:

•Command References

•Configuration Guides

•Supporting Documents

Command References

Table 2 lists the command references that support Cisco IOS XR software.

Table 2 Command References 

Document Title	Description
Cisco IOS XR Advanced System Command Reference	Provides command syntax and usage guidelines for the following areas: •ASIC drivers •Fabric management •Troubleshooting •Tech-support command output •Watchdog
Cisco IOS XR Interface and Hardware Component Command Reference	Provides command syntax and usage guidelines for commands used to configure physical and virtual interfaces, in the following areas: •Asynchronous Transfer Mode (ATM) •Bidirectional Forwarding Detect (BFD) •Diagnostics •Dense Wavelength Division Multiplexing (DWDM) •Ethernet interface •Frame Relay service configuration •Global interface •Internal ethernet control network •Inter-rack Switch Control Network •Link bundling •Management ethernet interface •Multilink commands •NetFlow commands •Null interface •Packet over SONET (POS), which includes Synchronous Digital Hierarchy (SDH)—SONET/SDH •Point-to-Point Protocol (PPP) •Serial interface •SONET controller •Spatial Reuse Protocol (SRP) •T3/E3 and T1/E1 controllers •802.1Q VLAN Subinterface This document also provides command syntax and usage guidelines for certain hardware component types such as the shared port adapter (SPA) and the SPA interface processor (SIP).
Cisco IOS XR IP Addresses and Services Command Reference	Provides command syntax and usage guidelines for the commands used in the following technologies: •Address Resolution Protocol (ARP) •Access Control Lists (ACLs) •Cisco Express Forwarding (CEF) •Dynamic Host Configuration Protocol (DHCP) •Local Packet Transport Services (LPTS) •Network IPv4 and IPv6 stacks •Prefix lists •Quality of Service (QoS) •Transport stacks
Cisco IOS XR Modular Quality of Service Command Reference	Provides command syntax and usage guidelines for the quality of service (QoS) commands on the Cisco IOS XR software.
Cisco IOS XR Multicast Command Reference	Provides command syntax and usage guidelines for commands used in the following multicast routing protocols: •Protocol Independent Multicast (PIM) •Internet Group Management Protocol (IGMP) •Multicast Source Discovery Protocol (MSDP)
Cisco IOS XR Multiprotocol Label Switching Command Reference	Provides command syntax and usage guidelines for commands used in the following Multiprotocol Label Switching (MPLS) facilities: •MPLS Label Distribution Protocol (LDP) •MPLS Resource Reservation Protocol (RSVP) •MPLS Forwarding, MPLS Traffic Engineering (MPLS-TE) •MPLS Operations •Operation, Administration and Maintenance (OAM) •Virtual Private Network (VPN) •MPLS Optical-UNI (MPLS O-UNI)
Cisco IOS XR Routing Command Reference	Provides command syntax and usage guidelines for commands used to configure and monitor the following: •Border Gateway Protocol (BGP) •Intermediate System-to-Intermediate System (IS-IS) •Open Shortest First Path (OSPF) •Open Shortest First Path Version 3 (OSPFv3) •Enhanced Interior Gateway Routing Protocol (EIGRP) •Routing Information Protocol (RIP) •Routing Information Base (RIB) routing protocols •Static routing
Cisco IOS XR Session Border Controller Command Reference	Provides command syntax and usage guidelines for Session Border Controller (SBC) applications.
Cisco IOS XR System Management Command Reference	Provides command syntax and usage guidelines for the following System Management commands: •Software package •Boot •Network Time Protocol (NTP) •Process management •Memory management •Terminal services •Secure domain router (SDR) •Hardware redundancy and node administration •Cisco Discovery Protocol (CDP) •Simple Network Management Protocol (SNMP) server •Object tracking •Clock •Configuration management •Distributed Route Processor (DRP) •File system •Manageability •Software entitlement
Cisco IOS XR System Monitoring Command Reference	Provides command syntax and usage guidelines for the following System Monitoring commands: •Alarm logs and logging correlation •IP Service Level Agreements (IP SLAs) •Embedded event manager •Fault management •Logging services •Performance management •Onboard Failure Logging (OBFL) •Statistics services
Cisco IOS XR System Security Command Reference	Provides command syntax and usage guidelines for the following areas: •Internet Key Exchange (IKE) •IP Security (IPSec) •Public Key Infrastructure (PKI) •Secure Shell (SSH) •Secure Socket Layer (SSL) •Authentication, Authorization and Accounting (AAA) •Software Authentication Manager (SAM) •Management Plane Protection (MPP) •Key chain management
Cisco IOS XR Virtual Firewall Command Reference	Provides command syntax and usage guidelines for the two command sets that support the Virtual Firewall (VFW) feature: Cisco IOS XR and SanOS (Linux). The VFW commands that support Cisco IOS XR are in the following areas: •Default interface •Action failure •Firewall •Firewall interface •Specific node •Firewall Management Interface (FMI) •Location attach •Service role on a multiservice blade (MSB) •Display firewall service attachment •Firewall context The VFW commands that support SanOS (Linux) are in the following areas: •Class map •Access Control Lists (ACL) •Policy map •Virtual firewall interface •Virtualization •Authentication and Accounting (AAA) •High availability •TCP/IP normalization and IP reassembly parameters •Parameter map •Terminal and session •System and file management •Simple Network Management Protocol (SNMP) •Logging •VRF-Aware Service Infrastructure (VASI)

Configuration Guides

Table 3 lists the configuration guides that support Cisco IOS XR software:

Table 3 Configuration Guides 

Document Title	Description
Cisco IOS XR Interface and Hardware Component Configuration Guide	Provides interface configuration and management information, and describes a variety of global interfaces: •POS1 —which also applies to SDH2 —SONET/SDH •APS3 •Ethernet, null and loopback virtual interfaces •Tunnel-IPSec (but not Tunnel-TE, which is covered in Cisco IOS XR MPLS Configuration Guide) •VLANs •BFD4 •BFD over VLAN bundles (on Cisco IOS XR in the current release) •Management. It contains the information on how to configure the SPA5 and the SIP6 . SIPs and SPAs are carrier cards and port adapters that increase modularity, flexibility, and scalability across the Cisco Systems routers. This document also includes information on how to configure and use NetFlow and DWDM7 .
Cisco IOS XR IP Addresses and Services Configuration Guide	Provides concepts and configuration tasks for the following technologies: •ARP •ACLs8 •CEF9 •DHCP •LPTS10 •Network IPv4 and IPv6 stacks •Prefix lists •QoS •Transport stacks.
Cisco IOS XR Modular Quality of Service Configuration Guide	Describes the Cisco IOS XR QoS11 feature for prioritizing traffic flows and providing preferential forwarding for higher-priority packets. The QoS techniques described include allocating bandwidth, improving loss characteristics, avoiding and managing network congestion, metering network traffic, and setting traffic-flow priorities across the network.
Cisco IOS XR Multicast Configuration Guide	Provides concepts and configuration tasks for the following technologies: •PIM12 •MLD13 •IGMP14 •MSDP15 .
Cisco IOS XR Multiprotocol Label Switching Configuration Guide	Provides concepts and configuration tasks for the following MPLS16 facilities: •LDP17 •RSVP18 •MPLS Forwarding •MPLS-TE 19 •MPLS O-UNI20 .
Cisco IOS XR Routing Configuration Guide	Provides concepts and configuration tasks for the following technologies: •BGP21 •EIGRP22 •IS-IS23 •OSPF24 •RIP25 •RIB26 protocols •Routing policy language •Static routing
Cisco IOS XR Session Border Controller Configuration Guide	Describes the tasks that support SBC27 applications.
Cisco IOS XR System Management Configuration Guide	Provides concepts and configuration tasks for managing the following: •Upgrading and managing Cisco IOS XR software packages •Upgrading FPD28 software •NTP29 •Object tracking •Process placement •Physical and virtual terminals •SDR30 •Managing the router hardware •CDP31 •SNMP32 •Software entitlement
Cisco IOS XR System Monitoring Configuration Guide	Provides concepts and configuration tasks for the following technologies: •Alarm logs and logging correlation •IP SLAs33 •Failure logging •Logging services •Performance management •OBFL34
Cisco IOS XR System Security Configuration Guide	Provides concepts and configuration tasks for the following technologies: •IKE •IPSec •PKI •SSH •SSL •AAA •key chain management •SAM It also defines a task ID and provides instructions on how to use the task ID.
Cisco Virtual Firewall Configuration Guide	Describes the tasks that support creating, monitoring, and maintaining a Virtual Firewall (VFW35 ).

1 Packet over SONET 2 Synchronous Digital Hierarchy 3 Automatic Protection Switching 4 Bidirectional Forwarding Detection 5 Shared Port Adapter 6 SPA Interface Processor 7 Dense Wave-Division Multiplexing 8 access control lists 9 Cisco Express Forwarding 10 Local Packet Transport Service 11 Quality of Service 12 Platform Independent Multicast 13 Multicast Listener Discovery 14 Internet Group Management Protocol 15 Multicast Source Discovery Protocol 16 Multiprotocol Label Switching 17 Label Distribution Protocol 18 MPLS Resource Reservation Protocol 19 MPLS Traffic Engineering 20 MPLS Optical-UNI 21 Border Gateway Protocol 22 Enhanced Interior Gateway Routing Protocol 23 Intermediate System-to-Intermediate System 24 Open Shortest Path First 25 Routing Information Protocol 26 Routing Information Base 27 Session Border Controller 28 Field-Programmable Devices 29 Network Time Protocol 30 Secure Domain Routers 31 Cisco Discovery Protocol 32 Simple Network Management Protocol 33 IP Service Level Agreements 34 OnBoard Failure Logging 35 Virtual Firewall

Supporting Documents

Table 4 lists the documents that support the Cisco IOS XR software documentation:

Table 4 Supporting Documents 

Document Title	Description
Accessing Cisco IOS XR Software Release Notes	Provides instructions to find release notes for Cisco IOS XR software.
Cisco IOS XR Getting Started Guide	Provides an introduction to the Cisco IOS XR software CLI1 and describes the initial router configuration tasks for standalone and multishelf routers.
Cisco IOS XR ROM Monitor Guide	Provides configuration information and examples for using the ROM Monitor mode of the Cisco IOS XR software, including the following subjects: •ROM Monitor overview and basic procedures •Router recovery with ROM Monitor •Managing configuration files in ROM Monitor •Password recovery in ROM Monitor Mode •Upgrading and downgrading ROM Monitor software on CRS-1 •Upgrading and downgrading boothelper and ROM Monitor software on Cisco XR 12000 Series Routers.
Release Notes for Cisco IOS XR Software	Describes new, changed, and unique characteristics of this release.

1 Command Line Interface

Documentation Conventions

Cisco IOS XR 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.

Command syntax descriptions use the following conventions:

Convention	Description
bold	Bold text indicates commands and keywords that you enter literally 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 enclose keywords or arguments separated by a vertical line to show optional choices.
{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 XR software for certain processes.)
[     ]	Square brackets enclose default responses to system prompts.

The following conventions are used to catch the reader's attention:

---

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 not contained in this manual.

---

---

Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.

---

Obtaining Documentation, Support, and Security Guidelines

For information about how to obtain documentation or support, on how to provide documentation feedback, for security guidelines, as well as on recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

CCDE, CCENT, Cisco Eos, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, the Cisco logo, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn is a service mark; 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, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, iQuick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone, MeetingPlace, 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. (0805R)

Copyright © 2008 Cisco Systems, Inc. All rights reserved.