Home | Skip to Content | Skip to Search | Skip to Navigation | Skip to Footer |
Worldwide [change] |Register |About Cisco
Guest

Hierarchical Navigation

Cisco IOS XR Software

About Cisco IOS XR Software Documentation, Release 3.6

Downloads

Table Of Contents

About Cisco IOS XR Software Documentation, Release 3.6

Changes to This Document

Documentation Objectives

Audience

Organization of the Cisco IOS XR Software Release  Documentation

Master Index

Documents

Command References

Configuration Guides

Cisco Craft Works Interface Documents

Supporting Documents

Document Conventions

Obtaining Documentation, Obtaining Support, and Security Guidelines


About Cisco IOS XR Software Documentation, Release 3.6

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  Documentation

•Command References

•Configuration Guides

•Cisco Craft Works Interface Documents

•Supporting Documents

•Document Conventions

•Obtaining Documentation, Obtaining 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-14360-01

December 2007

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 is using 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 particular tasks. The Cisco IOS XR software documentation is also for users who are experienced with Cisco IOS XR software and need to know about new features, configuration options, and characteristics of Release 3.6.0 software.

Organization of the Cisco IOS XR Software Release  Documentation

The Cisco IOS XR documentation set provides configuration guides, command references, and other supporting documents. It differs from other Cisco software major releases in these respects:

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

•Cisco IOS XR Release 3.6.0 provides online documents for each technology area.

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

•Command References

•Configuration Guides

•Cisco Craft Works Interface Documents

•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, troubleshooting, fabric management, tech-support command output, and watchdog.

Cisco IOS XR Interface and Hardware Component Command Reference

Provides command syntax and usage guidelines for the commands you use to configure physical and virtual interfaces and additional hardware component types. This document also includes commands that apply to Packet over SONET (POS)—which includes Synchronous Digital Hierarchy (SDH)—SONET/SDH, automatic protection switching (APS), Ethernet, null and loopback virtual interfaces, Tunnel-IPSec (but not Tunnel-TE, which is covered in Cisco IOS XR MPLS Command Reference), VLANs, asynchronous transfer mode (ATM), bidirectional forwarding detect (BFD), net flow, T3/E3 and T1/E1and dense wavelength division multiplexing (DWDM). This command reference also describes the commands that apply to 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 for 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), and transport stacks.

Cisco IOS XR Modular Quality of Service Command Reference

Describes the commands used to display and configure quality of service (QoS) on Cisco IOS XR software.

Cisco IOS XR Multicast Command Reference

Provides command syntax and usage guidelines for the multicast routing protocols that include Protocol Independent Multicast (PIM), Internet Group Management Protocol (IGMP), and Multicast Source Discovery Protocol (MSDP).

Cisco IOS XR Multiprotocol Label Switching Command Reference

Provides command syntax and usage guidelines for 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, Administration, and Maintenance (OAM), Virtual Private Network (VPN), and MPLS Optical-UNI (MPLS O-UNI).

Cisco IOS XR Routing Command Reference

Provides command syntax and usage guidelines to configure and monitor 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, and 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, and 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), and 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) and key chain management.

Cisco 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)


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), and 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 configuration guidance for using 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, and 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: PIM, IGMP, and MSDP.

Cisco IOS XR Multiprotocol Label Switching Configuration Guide

Provides concepts and configuration tasks for the following MPLS12 facilities: LDP13 , RSVP14 , MPLS Forwarding, MPLS-TE 15 , and MPLS O-UNI16 .

Cisco IOS XR Routing Configuration Guide

Provides concepts and configuration tasks for the following technologies: BGP, EIGRP, IS-IS, OSPF, RIP, RIB protocols, routing policy language, and static routing.

Cisco IOS XR Session Border Controller Configuration Guide

Describes the tasks that support SBC17 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 FPD18 software, NTP19 , object tracking, process placement, physical and virtual terminals, SDR20 , managing the router hardware, CDP21 , SNMP, and software entitlement.

Cisco IOS XR System Monitoring Configuration Guide

Provides concepts and configuration tasks for the following technologies: alarm logs and logging correlation, IP SLAs22 , failure logging, logging services, performance management, and OBFL23 .

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, and SAM. It also defines a task ID and provides guidance on the use of task IDs for commands that require them.

Cisco Virtual Firewall Configuration Guide

Describes the tasks that support creating, monitoring, and maintaining a Virtual Firewall (VFW24 ).

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 Multiprotocol Label Switching

13 Label Distribution Protocol

14 MPLS Resource Reservation Protocol

15 MPLS Traffic Engineering

16 MPLS Optical-UNI

17 Session Border Controller

18 Field-Programmable Devices

19 Network Time Protocol

20 Secure Domain Routers

21 Cisco Discovery Protocol

22 IP Service Level Agreements

23 OnBoard Failure Logging

24 Virtual Firewall


Cisco Craft Works Interface Documents

The following Craft Works Interface documents support Cisco IOS XR software:

•Cisco Craft Works Interface Quick Start Guide—Provides a brief overview of the Craft Works Interface (CWI) and describes procedures for setting up the CWI and the router and for establishing a connection between the CWI and the router.

•Cisco Craft Works Interface User Guide—Provides you information about how to use CWI to manage Cisco devices. CWI provides a user-friendly interface that combines graphical, spreadsheet, text editing, and command-line interface (CLI) features to manage Cisco devices.

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

Displays 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, and upgrading and downgrading boothelper and ROM Monitor software on Cisco XR 12000 Series Routers.

Cisco IOS XR XML API Guide

Describes how to use the Cisco XML API2 to configure routers or request information about configuration, management, or operation of the routers.

Release Notes for Cisco IOS XR Software

Describe new, changed, and unique characteristics of this release.

1 Command Line Interface

2 Application Programming Interface


Document 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 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 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, Obtaining 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

CCVP, the Cisco logo, and Welcome to the Human Network are trademarks of Cisco Systems, Inc.; Changing the Way We Work, Live, Play, and Learn is a service mark of Cisco Systems, Inc.; and Access Registrar, Aironet, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Enterprise/Solver, EtherChannel, EtherFast, EtherSwitch, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, IP/TV, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, iQuick Study, LightStream, Linksys, MeetingPlace, MGX, Networkers, Networking Academy, Network Registrar, PIX, ProConnect, ScriptShare, SMARTnet, StackWise, The Fastest Way to Increase Your Internet Quotient, and TransPath 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. (0711R)

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