Vous êtes sur la page 1sur 312

Cisco IOS XR Getting Started Guide

Cisco IOS XR Software Release 3.2

Corporate Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 526-4100

Text Part Number: OL-6142-06

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCBs public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

CCVP, the Cisco Logo, and the Cisco Square Bridge logo 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, BPX, 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, Networking Academy, Network Registrar, Packet, PIX, ProConnect, RateMUX, ScriptShare, SlideCast, 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. (0704R)
Cisco IOS XR Getting Started Guide Copyright 2005-2007 Cisco Systems, Inc. All rights reserved.

CONTENTS
Preface
xiii xiv

Document Revision History

About This Document xiv Intended Audience xiv Organization of the Document Related Documents xv Conventions xvi

xv

Obtaining Documentation xvi Cisco.com xvi Product Documentation DVD xvii Ordering Documentation xvii Documentation Feedback
xvii

Cisco Product Security Overview xvii Reporting Security Problems in Cisco Products

xviii

Obtaining Technical Assistance xviii Cisco Technical Support & Documentation Website Submitting a Service Request xix Definitions of Service Request Severity xix Obtaining Additional Publications and Information
1
xx

xix

CHAPTER

Getting Started with Cisco IOS XR Software Contents


1-1 1-1

1-1

Supported System Configurations

Router Management Interfaces 1-2 Command-Line Interface 1-2 Craft Works Interface 1-2 Extensible Markup Language API 1-3 Simple Network Management Protocol

1-4 1-4

Bringing Up the Cisco IOS XR Software on a Router for the First Time Hardware Prerequisites and Documentation 1-4 Connecting to the Router Through the Console Port 1-5 Verifying the System After Initial Bring-Up 1-12

Cisco IOS XR Getting Started Guide

iii

Contents

CHAPTER

Configuring General Router Features Contents


2-1 2-1

2-1

Logical Routers

Connecting and Communicating with the Router 2-2 Establishing a Connection Through the Console Port 2-6 Establishing a Connection Through a Terminal Server 2-7 Establishing a Connection Through the Management Ethernet Interface Logging In to a Router or Logical Router CLI Prompt
2-11 2-10

2-9

User Access Privileges 2-12 User Groups, Task Groups, and Task IDs 2-12 Predefined User Groups 2-13 Displaying the User Groups and Task IDs for Your User Account Navigating the Cisco IOS XR Command Modes 2-14 Identifying the Command Mode in the CLI Prompt 2-15 Summary of Common Command Modes 2-16 Entering EXEC Commands from a Configuration Mode 2-18 Command Mode Navigation Example 2-19

2-13

Managing Configuration Sessions 2-20 Entering Configuration Changes in the Nonactive Target Configuration 2-21 Committing Changes to the Running Configuration 2-21 Displaying Configuration Details with show Commands 2-23 Displaying Configuration Errors 2-28 Reloading a Failed Configuration 2-29 Clearing All Changes to a Target Configuration 2-29 Ending a Configuration Session 2-30 Locking and Unlocking the Running Configuration During Configuration Sessions Configuring the Router Hostname
2-32

2-31

Configuring the Management Ethernet Interface 2-33 Specifying the Management Ethernet Interface Name in CLI Commands Displaying the Available Management Ethernet Interfaces 2-35 Configuring the Management Ethernet Interface 2-35 Manually Setting the Router Clock Where to Go Next
3
2-40 2-38

2-33

CHAPTER

Configuring Additional Router Features Contents


3-1

3-1

Configuring the Domain Name and Domain Name Server


Cisco IOS XR Getting Started Guide

3-1

iv

Contents

Configuring Telnet, HTTP, and XML Host Services Prerequisites 3-3

3-2

Managing Configuration History and Rollback 3-3 Displaying the CommitIDs 3-4 Displaying the Configuration History Log 3-5 Displaying the Configuration Changes Recorded in a CommitID 3-6 Previewing Rollback Configuration Changes 3-6 Rolling Back the Configuration to a Specific Rollback Point 3-7 Rolling Back the Configuration over a Specified Number of Commits 3-7 Loading the Configuration Changes for a Specific CommitID 3-8 Loading Rollback Configuration Changes to the Target Configuration 3-8 Deleting CommitIDs 3-9 Saving and Loading Target Configuration Files 3-9 Saving the Target Configuration to a File 3-10 Loading the Target Configuration from a File 3-10 Loading an Alternative Configuration at System Startup Configuring Logging and Logging Correlation 3-11 Logging Locations and Severity Levels 3-11 Alarm Logging Correlation 3-11 Configuring Basic Message Logging 3-12 Creating and Modifying User Accounts and User Groups 3-14 Displaying Details About User Accounts, User Groups, and Task IDs Configuring User Accounts 3-15 Creating Users and Assigning Groups 3-16 Configuration Limiting 3-17 Static Route Configuration Limits 3-18 IS-IS Configuration Limits 3-19 OSPFv2 and v3 Configuration Limits 3-19 BGP Configuration Limits 3-22 Routing Policy Language Line and Policy Limits Multicast Configuration Limits 3-26 MPLS Configuration Limits 3-27 Other Configuration Limits 3-27
4
3-15

3-10

3-24

CHAPTER

CLI Tips, Techniques, and Shortcuts Contents


4-1

4-1

CLI Tips and Shortcuts 4-1 Entering Abbreviated Commands 4-2 Using the Question Mark (?) to Display On-Screen Command Help

4-2

Cisco IOS XR Getting Started Guide

Contents

Completing a Partial Command with the Tab Key Identifying Command Syntax Errors 4-4 Using the no Form of a Command 4-4 Editing Command Lines that Wrap 4-5

4-4

Displaying System Information with show Commands 4-5 Common show Commands 4-6 Browsing Display Output when the --More-- Prompt Appears Halting the Display of Screen Output 4-7 Redirecting Output to a File 4-7 Narrowing Output from Large Configurations 4-8 Filtering show Command Output 4-9 Wildcards, Templates, and Aliases 4-10 Using Wildcards to Identify Interfaces in show Commands Creating Configuration Templates 4-12 Applying Configuration Templates 4-14 Aliases 4-16 Keystrokes Used as Command Aliases 4-17 Command History 4-17 Recalling Previously Entered Commands Recalling Deleted Entries 4-18 Redisplaying the Command Line 4-18
4-17

4-6

4-11

Key Combinations 4-18 Key Combinations to Move the Cursor 4-19 Keystrokes to Control Capitalization 4-19 Keystrokes to Delete CLI Entries 4-20 Transposing Mistyped Characters 4-20
5

CHAPTER

Managing Cisco IOS XR Software Packages Contents


5-1

5-1

Overview of Software Packages 5-1 Available Packages 5-1 Package Installation Envelope Files 5-11 Standard PIE Filenames and Version Numbers 5-11 Software Maintenance Update PIE Filenames and Version Numbers Selecting and Obtaining Software Packages 5-16 Obtaining Cisco IOS XR Software and Version Information from Cisco Where to Place Installable PIE Files 5-16 Information About Package Management 5-18 Overview of Package Management 5-18
Cisco IOS XR Getting Started Guide

5-13

5-16

vi

Contents

Upgrading Packages 5-20 Downgrading Packages 5-20 Impact of Package Version Changes 5-21 Impact of Package Activation and Deactivation 5-21 Activation and Deactivation Prerequisites 5-22 Package Management Procedures 5-22 Displaying the Active Packages for All Cards 5-23 Displaying the Active Packages for a Single Card 5-25 Displaying the Committed Package Versions for Each Card Upgrading, Downgrading, and Installing Packages 5-26 Rolling Back to the Last Committed Package Set 5-34 Displaying Noncommitted Rollback Points 5-34 Rolling Back to a Noncommitted Rollback Point 5-35 Committing the Active Package Set 5-36 Deactivating a Package 5-37 Removing Inactive Packages from the Router 5-37 Configuration Examples for Managing Packages 5-37 Activating and Testing a Package on the Router: Example
6

5-25

5-38

CHAPTER

Managing the Router Hardware Contents


6-1

6-1

Displaying Hardware Status 6-1 Displaying Hardware Version Information 6-1 Displaying Software and Hardware Information 6-3 Displaying Node IDs and Status 6-3 Displaying Router Environment Information 6-5 Displaying RP Redundancy Status 6-8 RP Redundancy and Switchover 6-8 Determining the Primary RP 6-9 Role of the Standby RP 6-9 Summary of Redundancy Commands 6-10 Automatic Switchover 6-10 RP Redundancy During RP Reload 6-10 Manual Switchover 6-11 Communicating with a Standby RP 6-12 Reloading, Shutting Down, or Power Cycling a Node 6-12 Reloading the Primary RP 6-13 Administratively Shutting Down or Powering On or Off a Node Using Controller Commands to Manage Hardware Components

6-15

6-15

Cisco IOS XR Getting Started Guide

vii

Contents

Formatting Hard Drives, Flash Drives, and Other Storage Devices

6-16

Removing and Replacing Cards 6-16 Removing Line Cards, MSCs, or PLIMs 6-17 Replacing an MSC 6-18 Replacing a Line Card or PLIM with the Same Media Type and Port Count 6-18 Replacing a Line Card or PLIM with the Same Media Type and a Different Port Count Replacing a Line Card or PLIM with a Different Media Type 6-19 Removing and Replacing Cisco CRS-1 Switch Fabric Cards 6-19 Removing and Replacing CSC and SFC Cards 6-22 Removing and Replacing CSFC Cards 6-27 Adding a Standby PRP to a Cisco 12000 Series Router 6-28
7

6-18

CHAPTER

Troubleshooting the Cisco IOS XR Software Contents


7-1 7-1

7-1

Additional Sources for Information

Basic Troubleshooting Commands 7-2 Using show Commands to Display System Status and Configuration Using the ping Command 7-3 Using the traceroute Command 7-3 Using debug Commands 7-4 Understanding Processes and Threads 7-7 Commands Used to Display Process and Thread Details 7-8 Commands Used to Manage Process and Threads 7-13 Configuration Error Messages 7-14 Configuration Failures During a Commit Operation Configuration Errors at Startup 7-15
7-14

7-2

Memory Warnings in Configuration Sessions 7-15 Understanding Low-Memory Warnings in Configuration Sessions 7-16 Displaying System Memory Information 7-17 Removing Configurations to Resolve Low-Memory Warnings 7-18 Contacting TAC for Additional Assistance 7-21 Interfaces Not Coming Up 7-21 Verifying the System Interfaces
A
7-22

APPENDIX

Router Recovery and Management with ROM Monitor Contents


A-1 A-1

A-1

ROM Monitor Overview

Reinstalling the Cisco IOS XR Software from ROMMON

A-2

Cisco IOS XR Getting Started Guide

viii

Contents

Contents A-3 Cisco IOS XR Software Installation Overview A-3 Locating Installable Files A-4 tar Filenames and Version Numbers A-6 .vm Filenames and Version Numbers A-9 Reinstalling the Software from an Image Located on a TFTP Server A-10 Reinstalling the Software from a .vm File Located on Flash disk1: A-16 What to Do Next A-21 Recovering the Root Password A-21 Recovering the Root Password on Single-RP Routers A-22 Recovering the Root Password on Redundant-RP Routers A-23 Specifying an Alternative Configuration
A-24

ROM Monitor Procedures A-25 Entering ROM Monitor Mode A-25 Displaying the Available ROM Monitor Commands and Options Displaying the Configuration Register Setting A-30 Displaying Environment Variable Settings A-30 Saving Environment Variable Settings A-31 Exiting ROM Monitor Mode A-31
B

A-29

APPENDIX

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers Contents
B-1

B-1

Information About ROM Monitor Software B-1 ROM Monitor Upgrade and Downgrade Basics How to Upgrade or Downgrade ROM Monitor B-3 Upgrading or Downgrading ROM Monitor B-3 Configuration Examples for ROM Monitor Upgrades ROM Monitor Upgrade: Example B-8 Additional References B-13 Related Documents B-13 Technical Assistance B-13
B-13

B-1

B-7

APPENDIX

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers Contents
C-1

C-1

Information About ROM Monitor and Boothelper Software C-1 ROM Monitor and Boothelper Upgrade and Downgrade Basics How to Upgrade or Downgrade Boothelper
C-2

C-1

Cisco IOS XR Getting Started Guide

ix

Contents

Upgrading or Downgrading Boothelper

C-2

How to Upgrade or Downgrade ROM Monitor C-4 Upgrading or Downgrading ROM Monitor C-4 Additional References C-10 Related Documents C-10 Technical Assistance C-10
C-11

APPENDIX

Understanding Regular Expressions, Special Characters, and Patterns Regular Expressions Special Characters
D-1 D-2 D-2 D-3 D-3

D-1

Character Pattern Ranges Multiple-Character Patterns Pattern Alternation Anchor Characters Underscore Wildcard
D-4 D-4 D-4

Complex Regular Expressions Using Multipliers

Parentheses Used for Pattern Recall


GLOSSARY

D-4

INDEX

Cisco IOS XR Getting Started Guide

Preface
This guide describes how to create the initial configuration for a router using the Cisco IOS XR software. This guide also describes how to complete additional administration, maintenance, and troubleshooting tasks that may be required after initial configuration. This preface contains the following sections:

About This Document, page xiv Obtaining Documentation, page xvi Documentation Feedback, page xvii Cisco Product Security Overview, page xvii Obtaining Technical Assistance, page xviii Obtaining Additional Publications and Information, page xx

Cisco IOS XR Getting Started Guide

xiii

Preface Document Revision History

Document Revision History


The Document Revision History table records technical changes to this document. Table 1 shows the document revision number for the change, the date of the change, and a brief summary of the change. Note that not all Cisco documents use a Document Revision History Table.
Table 1 Document Revision History

Revision OL-6142-06

Date May 2007

Change Summary

Corrected ROM Monitor upgrade procedure in the Upgrading or Downgrading ROM Monitor section in Appendix B Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers. Added support for the Cisco XR 12000 Series Routers, including overview, installation and configuration instructions. Added instructions to remove and replace CSC and SFC cards in the the Cisco XR 12000 Series Routers. Added support for multiple logical routers on Cisco XR 12000 Series Routers. Added information regarding the commands supported in Admin command modes. Revised overview information and procedures for router recovery and management with ROM Monitor (Appendix A). Revised overview information and procedures for recovering the root password. Added instructions to recover the root password on single-RP routers. Added instructions for Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers (Appendix C).

OL-6142-04

August 2005

About This Document


The following sections provide information about the Cisco IOS XR Getting Started Guide and related documents:

Intended Audience, page xiv Organization of the Document, page xv Related Documents, page xv Conventions, page xvi

Intended Audience
This document is intended for the following people:

Experienced service provider administrators Cisco telecommunications management engineers

Cisco IOS XR Getting Started Guide

xiv

Preface About This Document

Third-party field service technicians who have completed the Cisco IOS XR software training sessions Customers who daily use and manage routers running Cisco IOS XR software

Organization of the Document


This document contains the following chapters:

Chapter 1, Getting Started with Cisco IOS XR Software Chapter 2, Configuring General Router Features Chapter 3, Configuring Additional Router Features Chapter 4, CLI Tips, Techniques, and Shortcuts Chapter 5, Managing Cisco IOS XR Software Packages Chapter 6, Managing the Router Hardware Chapter 7, Troubleshooting the Cisco IOS XR Software Appendix A, Router Recovery and Management with ROM Monitor Appendix B, Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers Appendix C, Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers Appendix D, Understanding Regular Expressions, Special Characters, and Patterns

Related Documents
For a complete listing of available documentation for the Cisco IOS XR software and the routers on which it operates, see to the following Web pages:

Cisco IOS XR Software Documentation http://www.cisco.com/univercd/cc/td/doc/product/ioxsoft/index.htm Cisco CRS-1 Carrier Routing System Documentation http://www.cisco.com/univercd/cc/td/doc/product/core/crs/ Cisco 12000 Series Router Documentation http://www.cisco.com/univercd/cc/td/doc/product/core/cis12000/index.htm

Note

Cisco IOS XR software runs only on the Cisco XR 12000 Series Routers listed in the Supported System Configurations section on page 1 in Chapter 1, Getting Started with Cisco IOS XR Software.

Cisco IOS XR Getting Started Guide

xv

Preface Obtaining Documentation

Conventions
This document uses the following conventions:

Item Commands and keywords Variable for which you supply values Displayed session and system information Commands and keywords you enter in an interactive environment Menu items and button names Menu navigation

Convention boldface font italic font


screen

font font

boldface screen

Variables you enter in an interactive environment italic screen font boldface font Option > Network Preferences

Note

Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.

Tip

Means the following information will help you solve a problem. The information in tips might not be troubleshooting or an action, but contains useful information.

Caution

Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.

Obtaining Documentation
Cisco documentation and additional literature are available on Cisco.com. Cisco also provides several ways to obtain technical assistance and other technical resources. These sections explain how to obtain technical information from Cisco Systems.

Cisco.com
You can access the most current Cisco documentation at this URL: http://www.cisco.com/techsupport You can access the Cisco website at this URL: http://www.cisco.com You can access international Cisco websites at this URL: http://www.cisco.com/public/countries_languages.shtml

Cisco IOS XR Getting Started Guide

xvi

Preface Documentation Feedback

Product Documentation DVD


Cisco documentation and additional literature are available in the Product Documentation DVD package, which may have shipped with your product. The Product Documentation DVD is updated regularly and may be more current than printed documentation. The Product Documentation DVD is a comprehensive library of technical product documentation on portable media. The DVD enables you to access multiple versions of hardware and software installation, configuration, and command guides for Cisco products and to view technical documentation in HTML. With the DVD, you have access to the same documentation that is found on the Cisco website without being connected to the Internet. Certain products also have .pdf versions of the documentation available. The Product Documentation DVD is available as a single unit or as a subscription. Registered Cisco.com users (Cisco direct customers) can order a Product Documentation DVD (product number DOC-DOCDVD=) from Cisco Marketplace at this URL: http://www.cisco.com/go/marketplace/

Ordering Documentation
Beginning June 30, 2005, registered Cisco.com users may order Cisco documentation at the Product Documentation Store in the Cisco Marketplace at this URL: http://www.cisco.com/go/marketplace/ Nonregistered Cisco.com users can order technical documentation from 8:00 a.m. to 5:00 p.m. (0800 to 1700) PDT by calling 1 866 463-3487 in the United States and Canada, or elsewhere by calling 011 408 519-5055. You can also order documentation by e-mail at tech-doc-store-mkpl@external.cisco.com or by fax at 1 408 519-5001 in the United States and Canada, or elsewhere at 011 408 519-5001.

Documentation Feedback
You can rate and provide feedback about Cisco technical documents by completing the online feedback form that appears with the technical documents on Cisco.com. You can send comments about Cisco documentation to bug-doc@cisco.com. You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address: Cisco Systems Attn: Customer Document Ordering 170 West Tasman Drive San Jose, CA 95134-9883 We appreciate your comments.

Cisco Product Security Overview


Cisco provides a free online Security Vulnerability Policy portal at this URL: http://www.cisco.com/en/US/products/products_security_vulnerability_policy.html

Cisco IOS XR Getting Started Guide

xvii

Preface Obtaining Technical Assistance

From this site, you can perform these tasks:


Report security vulnerabilities in Cisco products. Obtain assistance with security incidents that involve Cisco products. Register to receive security information from Cisco.

A current list of security advisories and notices for Cisco products is available at this URL: http://www.cisco.com/go/psirt If you prefer to see advisories and notices as they are updated in real time, you can access a Product Security Incident Response Team Really Simple Syndication (PSIRT RSS) feed from this URL: http://www.cisco.com/en/US/products/products_psirt_rss_feed.html

Reporting Security Problems in Cisco Products


Cisco is committed to delivering secure products. We test our products internally before we release them, and we strive to correct all vulnerabilities quickly. If you think that you might have identified a vulnerability in a Cisco product, contact PSIRT:

Emergencies security-alert@cisco.com An emergency is either a condition in which a system is under active attack or a condition for which a severe and urgent security vulnerability should be reported. All other conditions are considered nonemergencies.

Nonemergencies psirt@cisco.com 1 877 228-7302 1 408 525-6532

In an emergency, you can also reach PSIRT by telephone:


Tip

We encourage you to use Pretty Good Privacy (PGP) or a compatible product to encrypt any sensitive information that you send to Cisco. PSIRT can work from encrypted information that is compatible with PGP versions 2.x through 8.x. Never use a revoked or an expired encryption key. The correct public key to use in your correspondence with PSIRT is the one linked in the Contact Summary section of the Security Vulnerability Policy page at this URL: http://www.cisco.com/en/US/products/products_security_vulnerability_policy.html The link on this page has the current PGP key ID in use.

Obtaining Technical Assistance


Cisco Technical Support provides 24-hour-a-day award-winning technical assistance. The Cisco Technical Support & Documentation website on Cisco.com features extensive online support resources. In addition, if you have a valid Cisco service contract, Cisco Technical Assistance Center (TAC) engineers provide telephone support. If you do not have a valid Cisco service contract, contact your reseller.

Cisco IOS XR Getting Started Guide

xviii

Preface Obtaining Technical Assistance

Cisco Technical Support & Documentation Website


The Cisco Technical Support & Documentation website provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The website is available 24 hours a day, at this URL: http://www.cisco.com/techsupport Access to all tools on the Cisco Technical Support & Documentation website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a user ID or password, you can register at this URL: http://tools.cisco.com/RPF/register/register.do

Note

Use the Cisco Product Identification (CPI) tool to locate your product serial number before submitting a web or phone request for service. You can access the CPI tool from the Cisco Technical Support & Documentation website by clicking the Tools & Resources link under Documentation & Tools. Choose Cisco Product Identification Tool from the Alphabetical Index drop-down list, or click the Cisco Product Identification Tool link under Alerts & RMAs. The CPI tool offers three search options: by product ID or model name; by tree view; or for certain products, by copying and pasting show command output. Search results show an illustration of your product with the serial number label location highlighted. Locate the serial number label on your product and record the information before placing a service call.

Submitting a Service Request


Using the online TAC Service Request Tool is the fastest way to open S3 and S4 service requests. (S3 and S4 service requests are those in which your network is minimally impaired or for which you require product information.) After you describe your situation, the TAC Service Request Tool provides recommended solutions. If your issue is not resolved using the recommended resources, your service request is assigned to a Cisco engineer. The TAC Service Request Tool is located at this URL: http://www.cisco.com/techsupport/servicerequest For S1 or S2 service requests or if you do not have Internet access, contact the Cisco TAC by telephone. (S1 or S2 service requests are those in which your production network is down or severely degraded.) Cisco engineers are assigned immediately to S1 and S2 service requests to help keep your business operations running smoothly. To open a service request by telephone, use one of the following numbers: Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227) EMEA: +32 2 704 55 55 USA: 1 800 553-2447 For a complete list of Cisco TAC contacts, go to this URL: http://www.cisco.com/techsupport/contacts

Definitions of Service Request Severity


To ensure that all service requests are reported in a standard format, Cisco has established severity definitions.

Cisco IOS XR Getting Started Guide

xix

Preface Obtaining Additional Publications and Information

Severity 1 (S1)Your network is down, or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation. Severity 2 (S2)Operation of an existing network is severely degraded, or significant aspects of your business operation are negatively affected by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation. Severity 3 (S3)Operational performance of your network is impaired, but most business operations remain functional. You and Cisco will commit resources during normal business hours to restore service to satisfactory levels. Severity 4 (S4)You require information or assistance with Cisco product capabilities, installation, or configuration. There is little or no effect on your business operations.

Obtaining Additional Publications and Information


Information about Cisco products, technologies, and network solutions is available from various online and printed sources.

Cisco Marketplace provides a variety of Cisco books, reference guides, documentation, and logo merchandise. Visit Cisco Marketplace, the company store, at this URL: http://www.cisco.com/go/marketplace/ Cisco Press publishes a wide range of general networking, training and certification titles. Both new and experienced users will benefit from these publications. For current Cisco Press titles and other information, go to Cisco Press at this URL: http://www.ciscopress.com Packet magazine is the Cisco Systems technical user magazine for maximizing Internet and networking investments. Each quarter, Packet delivers coverage of the latest industry trends, technology breakthroughs, and Cisco products and solutions, as well as network deployment and troubleshooting tips, configuration examples, customer case studies, certification and training information, and links to scores of in-depth online resources. You can access Packet magazine at this URL: http://www.cisco.com/packet iQ Magazine is the quarterly publication from Cisco Systems designed to help growing companies learn how they can use technology to increase revenue, streamline their business, and expand services. The publication identifies the challenges facing these companies and the technologies to help solve them, using real-world case studies and business strategies to help readers make sound technology investment decisions. You can access iQ Magazine at this URL: http://www.cisco.com/go/iqmagazine or view the digital edition at this URL: http://ciscoiq.texterity.com/ciscoiq/sample/ Internet Protocol Journal is a quarterly journal published by Cisco Systems for engineering professionals involved in designing, developing, and operating public and private internets and intranets. You can access the Internet Protocol Journal at this URL: http://www.cisco.com/ipj Networking products offered by Cisco Systems, as well as customer support services, can be obtained at this URL: http://www.cisco.com/en/US/products/index.html

Cisco IOS XR Getting Started Guide

xx

Preface Obtaining Additional Publications and Information

Networking Professionals Connection is an interactive website for networking professionals to share questions, suggestions, and information about networking products and technologies with Cisco experts and other networking professionals. Join a discussion at this URL: http://www.cisco.com/discuss/networking World-class networking training is available from Cisco. You can view current offerings at this URL: http://www.cisco.com/en/US/learning/index.html

Cisco IOS XR Getting Started Guide

xxi

Preface Obtaining Additional Publications and Information

Cisco IOS XR Getting Started Guide

xxii

C H A P T E R

Getting Started with Cisco IOS XR Software


This chapter introduces the routers that support Cisco IOS XR software and the user interfaces you can use to manage routers that run Cisco IOS XR software. This chapter also describes how to bring up a new router that uses Cisco IOS XR software.

Contents
This chapter contains the following sections:

Supported System Configurations, page 1-1 Router Management Interfaces, page 1-2 Bringing Up the Cisco IOS XR Software on a Router for the First Time, page 1-4

Supported System Configurations


The Cisco IOS XR software runs on the following systems:

Cisco CRS-1 8-Slot Line Card Chassis Cisco CRS-1 16-Slot Line Card Chassis Cisco XR 12404 Router Cisco XR 12406 Router Cisco XR 12410 Router Cisco XR 12416 Router Cisco XR 12000 and 12000 Series Performance Route Processor-2 Cisco XR 12000 and 12000 Series Performance Route Processor-1 Cisco XR 12000 and 12000 Series 4-Port OC-3c/STM-1c Packet-over-Sonet (PoS) ISE Line Card Cisco XR 12000 and 12000 Series 8-Port OC-3c/STM-1c PoS ISE Line Card Cisco XR 12000 and 12000 Series 16-Port OC-3c/STM-1c PoS ISE Line Card Cisco XR 12000 and 12000 Series 4-Port OC-12/STM-4 PoS ISE Line Card Cisco XR 12000 and 12000 Series 1-Port OC-48c/STM-16c PoS ISE Line Card

Cisco XR 12000 Series Routers support the following hardware:


Cisco IOS XR Getting Started Guide

1-1

Chapter 1 Router Management Interfaces

Getting Started with Cisco IOS XR Software

Cisco XR 12000 and 12000 Series 4-Port Gigabit Ethernet ISE Line Card Cisco XR12000 and 12000 Series SPA Interface Processor (SIP)-600 and the following shared port adapters (SPAs):
1-Port 10-Gigabit Ethernet SPA 5-Port Gigabit Ethernet SPA 10-Port Gigabit Ethernet SPA 1-Port OC-192c/STM-64c PoS/RPR SPA

Router Management Interfaces


Because new routers are not yet configured for your environment, you must start configuration using the command-line interface (CLI). This guide provides instructions on using the CLI to configure basic router features. The Cisco IOS XR software supports the following router management interfaces, which are described in the following sections:

Command-Line Interface, page 1-2 Craft Works Interface, page 1-2 Extensible Markup Language API, page 1-3 Simple Network Management Protocol, page 1-4

Command-Line Interface
The CLI is the primary user interface for configuring, monitoring, and maintaining routers that run the Cisco IOS XR software. The CLI allows you to directly and simply execute Cisco IOS XR commands. All procedures in this guide use the CLI. Before you can use other router management interfaces, you must first use the CLI to install and configure those interfaces. Guidelines for using the CLI are presented in the following chapters:

Chapter 2, Configuring General Router Features Chapter 3, Configuring Additional Router Features Chapter 4, CLI Tips, Techniques, and Shortcuts

For information on CLI procedures for other procedures, such as hardware interface and software protocol management, see the Cisco IOS XR software documents listed in the Related Documents section on page xv.

Craft Works Interface


The Craft Works Interface (CWI) is a client-side application used to configure and manage routers that run the Cisco IOS XR software. CWI includes advanced CLI features and a graphical user interface (GUI, see Figure 1-1), and it is included with the Cisco IOS XR Manageability package. The CWI is a desktop used to launch management and configuration applications. The management and configuration features include fault management, configuration management, performance management, security management, and inventory management, with an emphasis on speed and efficiency. For more information, see the Cisco IOS XR software documents listed in the Related Documents section on page xv.

Cisco IOS XR Getting Started Guide

1-2

Chapter 1

Getting Started with Cisco IOS XR Software Router Management Interfaces

Figure 1-1

Craft Works Interface Browser Screen

Extensible Markup Language API


The Extensible Markup Language (XML) application programming interface (API) is an XML interface used for rapid development of client applications and perl scripts to manage and monitor the router. Client applications can be used to configure the router or request status information from the router by encoding a request in XML API tags and sending it to the router. The router processes the request and sends the response to the client in the form of encoded XML API tags. The XML API supports readily available transport layers, including Telnet, Secure Shell (SSH), and Common Object Request Broker Architecture (CORBA). The Secure Socket Layer (SSL) transport is also supported by the XML API. For more information, see the Cisco IOS XR software documents listed in the Related Documents section on page xv.

Cisco IOS XR Getting Started Guide

1-3

Chapter 1 Bringing Up the Cisco IOS XR Software on a Router for the First Time

Getting Started with Cisco IOS XR Software

Simple Network Management Protocol


Simple Network Management Protocol (SNMP) is an application-layer protocol designed to facilitate the exchange of management information between network devices. By using SNMP-transported data (such as packets per second and network error rates), network administrators can more easily manage network performance, find and solve network problems, and plan for network growth. The Cisco IOS XR software supports SNMP v1, v2c, and v3. SNMP is part of a larger architecture called the Internet Network Management Framework (NMF), which is defined in Internet documents called RFCs. The SNMPv1 NMF is defined by RFCs 1155, 1157, and 1212, and the SNMPv2 NMF is defined by RFCs 1441 through 1452. SNMP is a popular protocol for managing diverse commercial internetworks and those used in universities and research organizations. SNMP-related standardization activity continues even as vendors develop and release state-of-the-art, SNMP-based management applications. SNMP is a relatively simple protocol, yet its feature set is sufficiently powerful to handle the difficult problems presented in trying to manage the heterogeneous networks of today. For more information, see the Cisco IOS XR software documents listed in the Related Documents section on page xv.

Bringing Up the Cisco IOS XR Software on a Router for the First Time
This section provides instructions for bringing up the Cisco IOS XR software on a router for the first time. This section applies to routers that are delivered with Cisco IOS XR software installed.

Note

If you are upgrading a Cisco 12000 Series Router from Cisco IOS software to Cisco IOS XR software, see the Cisco IOS XR software document titled Upgrading from Cisco IOS to Cisco IOS XR Software on the Cisco 12000 Series Router. The following sections provide information related to bringing up a system:

Hardware Prerequisites and Documentation, page 1-4 Connecting to the Router Through the Console Port, page 1-5 Verifying the System After Initial Bring-Up, page 1-12

Hardware Prerequisites and Documentation


The Cisco IOS XR software runs on the routers listed in the Supported System Configurations section on page 1-1. Before a router can be started, the following hardware management procedures must be completed:

Site preparation Equipment unpacking Router installation

Cisco IOS XR Getting Started Guide

1-4

Chapter 1

Getting Started with Cisco IOS XR Software Bringing Up the Cisco IOS XR Software on a Router for the First Time

For information on how to complete these procedures for your router equipment, see the hardware documents listed in the Related Documents section on page xv.

Note

If you are upgrading a Cisco 12000 Series Router from Cisco IOS software to Cisco IOS XR software, you must first prepare the router. Refer to Upgrading from Cisco IOS to Cisco IOS XR Software on the Cisco 12000 Series Router for more information. See the Related Documents section on page xv for a complete listing of available documents.

Connecting to the Router Through the Console Port


The first time you connect to a new router with Cisco IOS XR software, you must connect through the Console port on the active route processor (RP) or PRP card. Although typical router configuration and management take place using an Ethernet port on the RP or PRP, this port must be configured for your local area network before it can be used. Figure 1-2 shows the RP connections on the Cisco CRS-1 16-Slot Line Card Chassis, and Figure 1-3 shows the RP connections on the Cisco CRS-1 8-Slot Line Card Chassis. Figure 1-4 shows the PRP-2 connections on the Cisco XR 12000 Series Router.

Note

Cisco IOS XR software does not support the PRP-1.

Note

Throughout this guide, the term RP is used to refer to the RP cards supported on Cisco CRS-1s and the PRP cards supported on Cisco XR 12000 Series Routers. If a feature or an issue applies to only one platform, the accompanying text specifies the platform.

Cisco IOS XR Getting Started Guide

1-5

Chapter 1 Bringing Up the Cisco IOS XR Software on a Router for the First Time

Getting Started with Cisco IOS XR Software

Figure 1-2

Communication Ports on the RP for a Cisco CRS-1 16-Slot Line Card Chassis

RP
RJ-45 cable

Local terminal or terminal server for CLI communication

Console AUX

RJ-45 cable
HDD

Remote terminal for CLI communication

PC Card (disk1:)

CNTL ETH 0

Network Remote CLI, CWI, XML, or SNMP communication

Management Ethernet connection for out-of-band network communciation

CNTL ETH 1 MGMT ETH

Optical Gigabit Ethernet for control plane: (not user configurable)

Status

Cisco IOS XR Getting Started Guide

1-6

116547

Primary

Chapter 1

Getting Started with Cisco IOS XR Software Bringing Up the Cisco IOS XR Software on a Router for the First Time

Figure 1-3

Communication Ports on the RP for a Cisco CRS-1 8-Slot Line Card Chassis RJ-45 cable

Local terminal or terminal server for CLI communication

Console AUX

Terminal connection Modem connection

RJ-45 cable
ALARM PID/VID

Remote terminal for CLI communication Ethernet cable

CRITICAL MAJOR MINOR

Network Remote CLI, CWI, XML, or SNMP communication. Remote file storage

MGMT ETH CNTL ETH 0 CNTL ETH 1

Management Ethernet connection for out-of-band network communication Optical Gigabit Ethernet for control plane: (not user configurable)

PC CARD

User-removable flash disk1: stores installation PIE files A second internal flash disk0: stores installed software and active configurations

EXT CLK 1 EXT CLK 2

Primary Status

LED status displays (alphanumeric) Primary RP (on=primary) Card status (green=OK)

Cisco IOS XR Getting Started Guide

122803

1-7

Chapter 1 Bringing Up the Cisco IOS XR Software on a Router for the First Time

Getting Started with Cisco IOS XR Software

Figure 1-4

Communication Ports on the PRP-2 for a Cisco XR 12000 Series Router

User-removable flash disk1: stores installation PIE files A second internal flash disk0: stores installed software and active configurations
-1 OT SL 0 OT SL

Network Remote CLI, CWI, XML, or SNMP communication. Remote file storage

Ethernet cable

ETH 0 ETH 1 BITS 0 BITS 1 AUX

LIN K TA DA LIN K TA DA SI G T AC SI G T AC

RJ-45 cable Remote terminal for CLI communication RJ-45 cable


ETH 2 CONSOLE

Modem connection Terminal connection

Local terminal or terminal server for CLI communication

Cisco IOS XR Getting Started Guide

1-8

138282

PERFORMANCE ROUTE PROCESSOR 2

RE SE T

LED status displays (alphanumeric)

Chapter 1

Getting Started with Cisco IOS XR Software Bringing Up the Cisco IOS XR Software on a Router for the First Time

To connect to the router, perform the following procedure.

SUMMARY STEPS
1. 2. 3. 4. 5. 6. 7. 8.

Power on the router. Identify the primary RP. Connect a terminal to the Console port of the primary RP. Start the terminal emulation program. Press Enter. Type the username for the root-system login and press Return. Type the password for the root-system login and press Return. Log in to the router.

DETAILED STEPS

Command or Action
Step 1

Purpose Starts the router.


Power on the router.

This step is required only if the router power is not on. For information on power installation and controls, see the hardware documentation listed in the Related Documents section on page xv. This step is not required when the router hosts only one RP. On Cisco CRS-1 RPs, the primary RP is identified by a lighted Primary LED on the RP front panel. On a Cisco XR 12000 Series Router, the primary RP is identified by the alphanumeric display: PRI RP. If there are multiple RPs on a Cisco XR 12000 Series Router when it is first started, the default configuration selects the RP in the lowest numbered slot as the primary RP and the designated shelf controller (DSC). To have an RP in a higher-numbered slot become the DSC, you must bring up the router with only that RP installed. Once the chosen RP becomes the DSC, it remains the DSC after subsequent restarts and you can add the other RPs.

Step 2

Identify the primary RP.

Identifies the RP to which you must connect in the next step.


Note

Cisco IOS XR Getting Started Guide

1-9

Chapter 1 Bringing Up the Cisco IOS XR Software on a Router for the First Time

Getting Started with Cisco IOS XR Software

Command or Action
Step 3

Purpose

Connect a terminal to the Console port of the primary Establishes a communications path to the router. RP. During the initial setup, you can communicate with the router only through the Console port of the primary RP.

The router Console port is designed for a serial cable connection to a terminal or a computer that is running a terminal emulation program. The terminal settings are:
Bits per second: 9600/9600 Data bits: 8 Parity: None Stop bit: 2 Flow control: None

For information on the cable requirements for the Console port, see the hardware documentation listed in the Related Documents section on page xv. The step is not required if you are connecting through a terminal. Terminals send keystrokes to and receive characters from another device. If you connect a computer to the Console port, you must use a terminal emulation program to communicate with the router. For instructions on using the terminal emulation program, see the documentation for that program. If no text or router prompt appears when you connect to the console port, press Enter to initiate communications. If no text appears when you press Enter, give the router more time to complete the initial boot procedure, then press Enter. If the router has no configuration, the router displays the prompt: Enter root-system username: The root-system username is for a user who manages the router in the admin plane. All general router configuration takes place in the admin plan. (If the router is configured with more than one logical router, logical router configuration takes place outside the admin plane when a user logs in with a username defined for the logical router.) If the router has been configured, the router displays the prompt: Username:

Step 4

Start the terminal emulation program.

(Optional.) Prepares a computer for router communications.


Step 5

Press Enter.

Initiates communication with the router.

Cisco IOS XR Getting Started Guide

1-10

Chapter 1

Getting Started with Cisco IOS XR Software Bringing Up the Cisco IOS XR Software on a Router for the First Time

Command or Action
Step 6 Step 7 Step 8

Purpose

Type the username for the root-system login and press Sets the root-system username, which is used to log in to the Return. router. Type the password for the root-system login and press Creates an encrypted password for the root-system Return. username. Log in to the router. Establishes your access rights for the router management session.

Enter the root-system username and password that were created earlier in this procedure. After you log in, the router displays the CLI prompt, which is described in the CLI Prompt section on page 2-11.

Examples
The following example shows the root-system username and password configuration for a new router, and it shows the initial log in:
--- Administration User Dialog ---

Enter root-system username: lab Enter secret: lab

The following configuration command script was created: username lab secret 5 $1$bo9D$L52cOe8Sa4PnlwJ/mVpwR1 group cisco-support ! end

[0] Return back to the setup without saving this config. [1] Save this configuration and exit. Enter your selection [1]: 1 RP/0/0/CPU0:Feb 9 00:51:32.197 : exec[65697]: %MGBL-LIBTARCFG-6-SYSTEM_ADMIN_CO MMIT : Administration configuration committed by system. Use the 'configure' command to modify this configuration. User Access Verification Username: lab Password: RP/0/0/CPU0:ios#

The secret line in the configuration command script shows that the password is encrypted. When you enter the password during login, the password is hidden.

Cisco IOS XR Getting Started Guide

1-11

Chapter 1 Bringing Up the Cisco IOS XR Software on a Router for the First Time

Getting Started with Cisco IOS XR Software

Verifying the System After Initial Bring-Up


To verify the status of the router, perform the following procedure:

SUMMARY STEPS
1. 2. 3. 4.

show version show platform [node-id] show redundancy show environment

DETAILED STEPS

Command or Action
Step 1

Purpose Displays information about the router, including image names, uptime, and other system information.

show version

RP/0/RP0/CPU0:router# show version

Step 2

show platform [node-id]

Displays information about the status of cards and modules installed in the router.

RP/0/RP0/CPU0:router# show platform

Some cards support a CPU module and service processor (SP) module. Other cards support only a single module. A card module is also called a node. When all nodes are working properly, the status of each node in the State column is IOS-XR RUN. Type the show platform node-id command to display information for a specific node. Replace node-id with a node name from the show platform command Node column.

Step 3

show redundancy
Example:
RP/0/RP0/CPU0:router# show redundancy

Displays the state of the primary (active) and standby (inactive) RPs, including the ability of the standby to take control of the system.

If both RPs are working correctly, the This node row displays active role, the Partner node row displays standby role, and the Standby node row displays Ready.

Step 4

show environment
Example:
RP/0/RP0/CPU0:router# show environment

Displays information about the hardware attributes and status.

Cisco IOS XR Getting Started Guide

1-12

Chapter 1

Getting Started with Cisco IOS XR Software Bringing Up the Cisco IOS XR Software on a Router for the First Time

Examples of show Commands


The following sections provide examples of show commands:

show version Command, page 1-13 show environment Command, page 1-13 show platform Command, page 1-14 show redundancy Command, page 1-15

show version Command

To display basic information about the router configuration, type the show version command in EXEC mode, as shown in the following example:
RP/0/RP0/CPU0:router# show version Cisco IOS-XR Software, Version 1.0.0 Copyright (c) 2004 by cisco Systems, Inc. ROM: System Bootstrap, Version 1.15(20040120:002852) , router uptime is 2 days, 1 hour, 59 minutes System image file is "tftp://223.0.0.0/usr/comp-hfr-full.vm-1.0.0 cisco CRS-16/S (7450) processor with 2097152K bytes of memory. 7450 processor at 650Mhz, Implementation , Revision 4 Packet over SONET network interface(s) 4 SONET/SDH Port controller(s) 1 Ethernet/IEEE 802.3 interface(s) 2043k bytes of non-volatile configuration memory. 1000592k bytes of ATA PCMCIA card at disk 0 (Sector size 512 bytes). Configuration register is 0x2 Package active on node 0/2/SP: hfr-admin, V 1.0.0, Cisco Systems, at mem:hfr-admin-1.0.0 Built on Fri Mar 5 19:12:26 PST 2004 --More--

show environment Command

To display environmental monitor parameters for the system, use the show environment command in EXEC mode. The following command syntax is used: show environment [options] Table 1-1 defines the show environment command options.
Table 1-1 show environment Command Options

Option all last table

Displays Information for all environmental monitor parameters. Information measured in the prior measurement interval (Cisco XR 12000 Series Routers only). Environmental parameter ranges.

Cisco IOS XR Getting Started Guide

1-13

Chapter 1 Bringing Up the Cisco IOS XR Software on a Router for the First Time

Getting Started with Cisco IOS XR Software

Table 1-1

show environment Command Options (continued)

Option temperatures voltages

Displays System temperature information. System voltage information.

In the following example, temperature information for a Cisco CRS-1 is shown:


RP/0/RP0/CPU0:router# show environment temperatures R/S/I Modules Inlet Temperature (deg C) 31, 27 Exhaust Temperature (deg C) 43, 45 Hotspot Temperature (deg C) 48 31 46 44 34 43 35 42 44 36 42 43 41, 33

0/2/*

host cpu fabricq0 fabricq1 ingressq egressq ingresspse egresspse plimasic 0/RP1/* host cpu ingressq fabricq0 0/SM0/* host

41

30, 31 38

42

29, 29

In the following example, LED status of the nodes in a Cisco CRS-1 is shown:
RP/0/RP0/CPU0:router# show environment leds 0/2/*: Module (host) LED status says: OK 0/2/*: Module (plimasic) LED status says: OK 0/SM0/*: Module (host) LED status says: OK

See the Cisco IOS XR Interface and Hardware Component Command Reference for more information.
show platform Command

The following is sample output from the show platform command for all nodes in a router:
RP/0/RP0/CPU0:router# show platform Node Type PLIM State Config State ----------------------------------------------------------------------------0/0/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/0/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/2/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/2/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/RP0/CPU0 RP(Standby) N/A IOS-XR RUN PWR,NSHUT,MON 0/RP1/CPU0 RP(Active) N/A IOS-XR RUN PWR,NSHUT,MON 0/SM0/SP FC/S(SP) N/A IOS-XR RUN PWR,NSHUT,MON

Note

Line cards in Cisco CRS-1s are called modular services cards (MSCs). The show platform command output is different for Cisco CRS-1s and Cisco XR 12000 Series Routers.

Cisco IOS XR Getting Started Guide

1-14

Chapter 1

Getting Started with Cisco IOS XR Software Bringing Up the Cisco IOS XR Software on a Router for the First Time

In the following example, information is shown for a single node in a Cisco CRS-1:
RP/0/RP0/CPU0:router# show platform 0/2/cpu0 Node Type PLIM State Config State ----------------------------------------------------------------------------0/2/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON

For more information on nodeID, see the Displaying Node IDs and Status section on page 6-3. For more information on the show platform command, see the Cisco IOS XR Interface and Hardware Component Command Reference.
show redundancy Command

To display information about the primary (active) and standby (inactive) RPs, enter the show redundancy command as follows:
RP/0/RP0/CPU0:router# show redundancy This node (0/RP0/CPU0) is in ACTIVE role Partner node (0/RP1/CPU0) is in STANDBY role Standby node in 0/RP1/CPU0 is ready

Cisco IOS XR Getting Started Guide

1-15

Chapter 1 Bringing Up the Cisco IOS XR Software on a Router for the First Time

Getting Started with Cisco IOS XR Software

Cisco IOS XR Getting Started Guide

1-16

C H A P T E R

Configuring General Router Features


This chapter describes how to communicate with the router using the command-line interface (CLI), and it describes basic Cisco IOS XR software configuration management.

Contents
The chapter contains the following sections:

Logical Routers, page 2-1 Connecting and Communicating with the Router, page 2-2 Logging In to a Router or Logical Router, page 2-10 CLI Prompt, page 2-11 User Access Privileges, page 2-12 Navigating the Cisco IOS XR Command Modes, page 2-14 Managing Configuration Sessions, page 2-20 Configuring the Router Hostname, page 2-32 Configuring the Management Ethernet Interface, page 2-33 Manually Setting the Router Clock, page 2-38 Where to Go Next, page 2-40

Logical Routers
Cisco XR 12000 Series Routers can be partitioned into multiple, independent routers known as logical routers (LRs). Every router ships with a default LR, which is called the owner LR because, by default, it owns all RPs and line cards installed in the routing system. To build an LR, you must create the LR using configuration commands on the owner LR, assign RP and line cards to the LR, and then configure the interfaces on the line cards on the new LR. An LR is a group of cards within a Cisco XR 12000 Series Router that is configured to operate as an independent router. Logical routers perform routing functions in the same manner as a physical router, but share some chassis resources with the rest of the system. For example, the applications, configurations, protocols, and routing tables assigned to an LR belong to that LR only, but other functions, such as chassis control, switch fabric, and partitioning, are shared with the rest of the system.

Cisco IOS XR Getting Started Guide

2-1

Chapter 2 Connecting and Communicating with the Router

Configuring General Router Features

To manage an owner LR, you must connect to the RP for the owner LR. When you are connected to the owner LR, you have control over the entire system and all cards assigned to the owner LR. Although you can reassign cards from one LR to another, you cannot configure and manage cards assigned to an LR. To manage cards assigned to an LR, you must connect to the appropriate LR. When you manage an LR, you must connect to the RP for that LR. You can connect to the LR using any of the connection methods you use for the owner LR (for example, you can connect through the console port or the Management Ethernet interface), and you have control over only the cards assigned to that LR. For example, you cannot configure and manage interfaces on line cards assigned to the owner LR or other LRs unless you connect to those LRs.

Note

Cisco IOS XR Software Releases 2, 3, and 3.2 support only one logical router on the Cisco CRS-1. Cisco IOS XR Software Release 3.2 supports multiple logical routers on Cisco XR 12000 Series Routers. For more information, see the Cisco IOS XR Interface and Hardware Component Configuration Guide.

Connecting and Communicating with the Router


To manage or configure a router running the Cisco IOS XR software, you must first connect to the router using a terminal or a PC. Connections are made either through a direct physical connection to the Console port of the primary route processor (RP) or from a remote location using a modem or an Ethernet connection.

Figure 2-1 shows the RP connections on the Cisco CRS-1 16-Slot Line Card Chassis, and Figure 2-2 shows the RP connections on the Cisco CRS-1 8-Slot Line Card Chassis. Figure 2-3 shows the performance route processor 2 (PRP-2) connections for a Cisco XR 12000 Series Router.

Cisco IOS XR Getting Started Guide

2-2

Chapter 2

Configuring General Router Features Connecting and Communicating with the Router

Figure 2-1

Communication Ports on the RP for a Cisco CRS-1 16-Slot Line Card Chassis

RP
RJ-45 cable

Local terminal or terminal server for CLI communication

Console AUX

RJ-45 cable
HDD

Remote terminal for CLI communication

PC Card (disk1:)

CNTL ETH 0

Network Remote CLI, CWI, XML, or SNMP communication

Management Ethernet connection for out-of-band network communciation

CNTL ETH 1 MGMT ETH

Optical Gigabit Ethernet for control plane: (not user configurable)

Status

The first time a router is started, you must use a direct connection to the Console port to connect to the router and enter the initial configuration. When you use a direct connection to the Console port, CLI commands are entered at a terminal or at a computer running terminal emulation software. A direct Console port connection is useful for entering initial configurations and performing some debugging tasks. This chapter describes some of the tasks you might want to perform during your initial configuration. One of those tasks is the configuration of the Management Ethernet interface, which is described in the Configuring the Management Ethernet Interface section on page 2-33. After the Management Ethernet interface is configured, most router management and configuration sessions take place over an Ethernet network connected to the Management Ethernet interface. SNMP agents and the CWI also use the network connection. The modem connection can be used for remote communications with the router and serves as an alternate remote communications path if the Management Ethernet interface fails.

Cisco IOS XR Getting Started Guide

116547

Primary

2-3

Chapter 2 Connecting and Communicating with the Router

Configuring General Router Features

Figure 2-2

Communication Ports on the RP for a Cisco CRS-1 8-Slot Line Card Chassis RJ-45 cable

Local terminal or terminal server for CLI communication

Console AUX

Terminal connection Modem connection

RJ-45 cable
ALARM PID/VID

Remote terminal for CLI communication Ethernet cable

CRITICAL MAJOR MINOR

Network Remote CLI, CWI, XML, or SNMP communication. Remote file storage

MGMT ETH CNTL ETH 0 CNTL ETH 1

Management Ethernet connection for out-of-band network communication Optical Gigabit Ethernet for control plane: (not user configurable)

PC CARD

User-removable flash disk1: stores installation PIE files A second internal flash disk0: stores installed software and active configurations

EXT CLK 1 EXT CLK 2

Primary Status

LED status displays (alphanumeric) Primary RP (on=primary) Card status (green=OK)

Cisco IOS XR Getting Started Guide

2-4

122803

Chapter 2

Configuring General Router Features Connecting and Communicating with the Router

Figure 2-3

Communication Ports on the PRP-2 for a Cisco XR 12000 Series Router

User-removable flash disk1: stores installation PIE files A second internal flash disk0: stores installed software and active configurations
-1 OT SL 0 OT SL

Network Remote CLI, CWI, XML, or SNMP communication. Remote file storage

Ethernet cable

ETH 0 ETH 1 BITS 0 BITS 1 AUX

LIN K TA DA LIN K TA DA SI G T AC SI G T AC

RJ-45 cable Remote terminal for CLI communication RJ-45 cable


ETH 2 CONSOLE

Modem connection Terminal connection

Local terminal or terminal server for CLI communication

The following sections describe three ways to connect to the router:


Establishing a Connection Through the Console Port, page 2-6 Establishing a Connection Through a Terminal Server, page 2-7 Establishing a Connection Through the Management Ethernet Interface, page 2-9

Cisco IOS XR Getting Started Guide

138282

PERFORMANCE ROUTE PROCESSOR 2

RE SE T

LED status displays (alphanumeric)

2-5

Chapter 2 Connecting and Communicating with the Router

Configuring General Router Features

Establishing a Connection Through the Console Port


To connect to the router through the console port, perform the following procedure.

SUMMARY STEPS
1. 2. 3. 4. 5.

Identify the primary RP. Connect a terminal to the Console port of the primary RP. Start the terminal emulation program. Press Enter. Log in to the router.

DETAILED STEPS

Command or Action
Step 1

Purpose Identifies the RP to which you must connect in the next step.

Identify the primary RP.

This step is not required when the router hosts only one RP. On a Cisco CRS-1 router, the primary RP is identified by a lighted Primary LED on the RP front panel. On a Cisco XR 12000 Series Router, the primary RP is identified by the alphanumeric display: PRI RP.

Step 2

Connect a terminal to the Console port of the primary Establishes a communications path to the router. RP. During the initial setup, you can communicate with the router only through the Console port of the primary RP.

The router Console port is designed for a serial cable connection to a terminal or a computer that is running a terminal emulation program. The terminal settings are:
Bits per second: 9600/9600 Data bits: 8 Parity: None Stop bit: 2 Flow control: None

For information on the cable requirements for the Console port, see the hardware documentation listed in the Related Documents section on page xv.

Cisco IOS XR Getting Started Guide

2-6

Chapter 2

Configuring General Router Features Connecting and Communicating with the Router

Command or Action
Step 3

Purpose (Optional.) Prepares a computer for router communications.


Start the terminal emulation program.

The step is not required if you are connecting through a terminal. Terminals send keystrokes to and receive characters from another device. If you connect a computer to the Console port, you must use a terminal emulation program to communicate with the router. For instructions on using the terminal emulation program, see the documentation for that program. If no text or router prompt appears when you connect to the console port, press Enter to initiate communications. If no text appears when you press Enter and the router has been started recently, give the router more time to complete the initial boot procedure, then press Enter. If the router has no configuration, the router displays the prompt: Enter root-system username:. If the router is starting up for the first time, see the Bringing Up the Cisco IOS XR Software on a Router for the First Time section on page 1-4. If the router has been configured, the router displays the prompt: Username:

Step 4

Press Enter.

Initiates communication with the router.

Step 5

Log in to the router.

Establishes your access rights for the router management session.

Enter your username and password as described in the Logging In to a Router or Logical Router section on page 2-10. After you log in, the router displays the CLI prompt, which is described in the CLI Prompt section on page 2-11.

Establishing a Connection Through a Terminal Server


A terminal server connection provides a way to access the Console port from a remote location. It is less expensive to connect to the router through the Management Ethernet interface (because you do not have the additional cost of a terminal server). However, if you need to perform tasks that require Console port access from a remote location, a terminal server is the best connection method. The procedure for connecting to the router through a terminal server is similar to the procedure for directly connecting through the Console port. For both connection types, the physical connection takes place through the Console port. The difference is that the terminal server connects directly to the Console port, and you must use a Telnet session to establish communications through the terminal server to the router.

Cisco IOS XR Getting Started Guide

2-7

Chapter 2 Connecting and Communicating with the Router

Configuring General Router Features

To establish a connection through a terminal server, perform the following procedure:

SUMMARY STEPS
1. 2. 3. 4. 5. 6. 7.

Install and configure the terminal server. Connect the terminal server to the Console port of the target RP. Power on the router. Identify the target RP. telnet access-server-address port Press Enter. Log in to the router.

DETAILED STEPS

Command or Action
Step 1

Purpose Prepares the terminal server for communications with the router and with Telnet clients.

Install and configure the terminal server.

This step is usually preformed once. For router access, users need the Telnet server IP address and port number for each RP they access. For additional information on configuring terminal services, including terminal servers and templates, see the Cisco IOS XR System Management Configuration Guide.

Step 2

Connect the terminal server to the Console port of the Establishes a communications path between the terminal target RP. server and the router.

During the initial router setup, you can communicate with the router only through the Console port of the primary RP. The router Console port is designed for a serial cable connection to a terminal or terminal server. The terminal settings are:
Bits per second: 9600/9600 Data bits: 8 Parity: None Stop bit: 2 Flow control: None

For information on the cable requirements for the Console port, see the hardware documentation listed in the Related Documents section on page xv. To enable terminal server connections to the Console ports on two RPs, install a cable between each Console port and the terminal server.

Cisco IOS XR Getting Started Guide

2-8

Chapter 2

Configuring General Router Features Connecting and Communicating with the Router

Command or Action
Step 3

Purpose Starts the router.


Power on the router.

This step is required only if the router power is not on. For information on power installation and controls, see the hardware documentation listed in the Related Documents section on page xv. This step is not required when the router hosts only one RP. On a Cisco CRS-1 router, the primary RP is identified by a lighted Primary LED on the RP front panel. On a Cisco XR 12000 Series Router, the primary RP is identified by the alphanumeric display: PRI RP. If you cannot look at the RPs, use a Management Ethernet interface connection to determine which RP is active, or establish terminal server connections to both RPs and then try both. Replace access-server-address with the IP address of the terminal server, and replace port with the terminal server port number that connects to the target RP Console port. If no text or router prompt appears when you start the Telnet session, press Enter to initiate communications. If the router has no configuration, the router displays the prompt: Enter root-system username: Enter the root-system username and password when prompted. If the router has been configured, the router displays the prompt: Username:

Step 4

Identify the target RP.

Identifies the RP to which you connect in the next step.


Step 5

telnet access-server-address port

Establishes a Telnet session with the terminal server.

Step 6

Press Enter.

(Optional.) Initiates communications with the router.


Step 7

Log in to the router.

Establishes your access rights for the router management session.

Enter a username and password when prompted.

Establishing a Connection Through the Management Ethernet Interface


The Management Ethernet interface allows you to manage the router using a network connection. Before you can use the Management Ethernet interface, the interface must be configured, as described in the Configuring the Management Ethernet Interface section on page 2-35.

Cisco IOS XR Getting Started Guide

2-9

Chapter 2 Logging In to a Router or Logical Router

Configuring General Router Features

Once configured, the network connection takes place between client software on a workstation computer and a server process within the router. The type of client software you use depends on the server process you want to use. The Cisco IOS XR software supports the following client and server services:

Telnet clients can connect to a Telnet server in the router. The Telnet server is disabled by default and can be enabled with the telnet ipv4 server or telnet ipv6 server command. Secure Shell (SSH) clients can connect to an SSH server in the router. The SSH server is disabled by default and can be enabled with the ssh server command. The SSH server handles both Secure Shell Version 1 (SSHv1) and SSHv2 incoming client connections for both IPv4 and IPv6 address families.

Note

IPv6 is not supported on Cisco XR 12000 Series routers. To start a Telnet network connection, you start the Telnet client software with a command similar to the following: telnet ManagementEthernetInterfaceIPaddress For specific instructions on connecting to the router through a Telnet or SSH client, see the instructions for that software. Ask your system administrator for the IP address of the Management Ethernet interface. When the Telnet session is established, the router prompts you to log in, as described in the Logging In to a Router or Logical Router section on page 2-10.

Logging In to a Router or Logical Router


The login process can require users to enter a password or a username and password before accessing the router CLI. The user groups to which your username is assigned determine which commands you can use. If you log into a router with a single logical router configured (this is the default configuration), you can manage the entire router. If you log into the owner LR on a system with multiple logical routers, you can manage general features that apply to the entire system and the interfaces assigned to the owner LR. If you log into an LR, you can manage only that logical router. For more information on logical routers, see the Logical Routers section on page 2-1. When you log in, the username and password may be validated by any of the following services:

Usernames configured on the router (username command in global configuration mode) Root-system usernames configured on the owner LR. Passwords configured for specific lines on the router (password or secret command in line configuration mode) A RADIUS server A TACACS+ server

The username and password validation method that your router uses is determined by the router configuration. For information on configuring username and password validation methods, see the Cisco IOS XR System Security Configuration Guide. For information on which username and password to use, see your system administrator.

Cisco IOS XR Getting Started Guide

2-10

Chapter 2

Configuring General Router Features CLI Prompt

To log in to the router, enter your username and password when prompted. For example:
User Access Verification Username: iosxr Password: password RP/0/RP0/CPU0:router#

Note

Passwords are case sensitive. If you want to log into an LR using a root-system username from the owner LR, enter the username in the following format: username@admin. After you log in, the router displays the CLI prompt, which is described in the CLI Prompt section on page 2-11. The command set that you can use is determined by the privileges assigned to your username. For information on how privileges are assigned to usernames, see the Cisco IOS XR Task ID Reference Guide.

CLI Prompt
After you log in, you see the CLI prompt for the Cisco IOS XR software. This prompt identifies the router or logical router to which you are issuing commands. The CLI prompt represents the path, through the router, to the CPU that executes the commands you enter. The syntax for the CLI prompt is: type/rack/slot/module: router-name#. The CLI prompt is described in Table 2-1.
Table 2-1 CLI Prompt Description

Prompt Syntax Components type rack slot

Description Type of interface or card with which you are communicating. For most user communication tasks, the type is RP. Chassis number of the rack. In a single-chassis system, the rack is always 0. Slot in which the RP is installed. In a Cisco CRS-1, the physical slot number is RP0 or RP1. In a Cisco XR 12000 Series Router, the physical slot number can be 0 to 15, and there can be multiple logical routers, each of which is represented by an RP. Entity on a card that executes user commands or communicates with a port (interface). For executing commands from the EXEC prompt, the module is the CPU0 of the RP. CPU0 also controls the forwarding and operating system (OS) functions for the system. Hostname of the router or logical router. The hostname is usually defined during initial configuration of the router, as described in the Verifying the System After Initial Bring-Up section on page 1-12.

module

router-name

For example, the following prompt indicates that the CLI commands are executed on the RP in rack 0, slot RP0, by the CPU0 module on a router named router:
RP/0/RP0/CPU0:router#

Cisco IOS XR Getting Started Guide

2-11

Chapter 2 User Access Privileges

Configuring General Router Features

User Access Privileges


When you log in to the router, your username and password are used to determine if you are authorized to access the router. After you successfully log in, your username is used to determine which commands you are allowed to use. The following sections provide information on how the router determines which commands you can use:

User Groups, Task Groups, and Task IDs, page 2-12 Predefined User Groups, page 2-13 Displaying the User Groups and Task IDs for Your User Account, page 2-13

User Groups, Task Groups, and Task IDs


The commands that each user can use are defined by the user groups to which he or she belongs. Within the Cisco IOS XR software, the commands for a particular feature, such as access control lists, are assigned to tasks, which are uniquely identified by task IDs. If a user wants to use a particular command, his or her username must be associated with the appropriate task ID. The association between a username and a task ID takes place through two intermediate entities, the user group and task group. The user group is basically a logical container that can be used to assign the same task IDs to multiple users. Instead of assigning task IDs to each user, you can assign them to the user group, and then assign users to the user group. When a task is assigned to a user group, you can define the access rights for the commands associated with that task. These rights include read, write, execute, and notify. The task group is also a logical container, but it is used to group tasks. Instead of assigning task IDs to each user group, you assign them to a task group, which allows you to quickly enable access to a specific set of tasks by assigning a task group to a user group. To summarize the associations, usernames are assigned to user groups, which are then assigned to task groups. Users can be assigned to multiple user groups, and each user group can be assigned to one or more task groups. The commands that a user can execute are all those commands assigned to the tasks within the task groups that are associated with the user groups to which the user belongs. Users are not assigned to groups by default and must be explicitly assigned by an administrator. You can display all task IDs available on the system with the show task supported command. For example:
RP/0/RP0/CPU0:router# show task supported bgp ospf hsrp isis route-map route-policy static vrrp cef lpts iep rib multicast mpls-te mpls-ldp mpls-static ouni

Cisco IOS XR Getting Started Guide

2-12

Chapter 2

Configuring General Router Features User Access Privileges

fabric bundle network transport ppp hdlc --More--

Note

Only the root-system users, root-lr users, or users associated with the WRITE:AAA task ID can configure task groups.

Predefined User Groups


The Cisco IOS XR software includes a set of predefined user groups that meets the needs of most organizations. The predefined user groups are described in Table 2-2.
Table 2-2 Predefined User Group Descriptions

User Group root-system root-lr sysadmin

Privileges Display and execute all commands for all logical routers (LRs) in the system. Display and execute all commands within a single LR. Perform system administration tasks for the router, such as maintaining where the core dumps are stored or setting up the Network Time Protocol (NTP) clock. Configure network protocols, such as Border Gateway Protocol (BGP) and Open Shortest Path First (OSPF) (usually network administrators). Perform day-to-day monitoring activities, and have limited configuration rights. Debug and troubleshoot features (usually Cisco support personnel).

netadmin

operator cisco-support

Although the predefined user groups are sufficient for the needs of most organizations, administrators can configure their own groups. For more information, see Cisco IOS XR System Security Configuration.

Displaying the User Groups and Task IDs for Your User Account
To display the user groups and task IDs associated with your account, enter the show user command in EXEC mode. Table 2-3 summarizes the options available for this command.
Table 2-3 Options to Display Information About Your Account

Command show user show user group show user tasks

Description Displays your user name. Displays the user groups assigned to your account. Displays the task IDs assigned to your account.

Cisco IOS XR Getting Started Guide

2-13

Chapter 2 Navigating the Cisco IOS XR Command Modes

Configuring General Router Features

Table 2-3

Options to Display Information About Your Account (continued)

Command show user all show aaa usergroup group-name

Description Displays all user groups and task ID information for your account. Displays the task IDs assigned to a user group.

Examples
To display your username, enter the show user command:
RP/0/RP0/CPU0:router# show user Username: crs

To display the tasks assigned to your account and your rights to those tasks, enter the show user tasks command:
RP/0/RP0/CPU0:router# show user tasks Task: Task: Task: Task: Task: basic-services cdp diag ext-access logging : : : : : READ READ READ READ READ WRITE EXECUTE NOTIFY

EXECUTE

To display the user groups assigned to your user account, enter the show user group command:
RP/0/RP0/CPU0:router# show user group User group operator

To display the rights assigned to a user group, enter the show aaa usergroup group-name command:
RP/0/RP0/CPU0:router# show aaa usergroup operator User group 'operator' Inherits from task group 'operator' User group 'operator' has the following combined set of task IDs (including all inherited groups): Task: basic-services : READ WRITE EXECUTE Task: cdp : READ Task: diag : READ Task: ext-access : READ EXECUTE Task: logging : READ

NOTIFY

Navigating the Cisco IOS XR Command Modes


The CLI for the Cisco IOS XR software is divided into different command modes. Each mode provides access to a subset of commands used to configure, monitor, and manage the router. Access to a mode is determined by your user group assignments. The following sections describe the navigation of the command modes:

Identifying the Command Mode in the CLI Prompt, page 2-15 Summary of Common Command Modes, page 2-16

Cisco IOS XR Getting Started Guide

2-14

Chapter 2

Configuring General Router Features Navigating the Cisco IOS XR Command Modes

Entering EXEC Commands from a Configuration Mode, page 2-18 Command Mode Navigation Example, page 2-19

Figure 2-4 illustrates the basic command mode navigation for the CLI. Only a small sample of the possible configuration submodes is shown.
Figure 2-4 Example of Command Mode Navigation in Cisco IOS XR software

Login

EXEC mode

Admin EXEC mode

Admin configuration mode

Global configuration mode Configuration submode examples Interface configuration submode Router configuration submode Line template configuration submode
116544

Logical router configuration submode

Task group configuration submode

Identifying the Command Mode in the CLI Prompt


The command mode is identified in the CLI prompt after the router name. For example, when the router enters global configuration mode from the EXEC mode, the CLI prompt changes to include (config) after the router name:
RP/0/RP0/CPU0:routername# configure RP/0/RP0/CPU0:routername(config)#

When the router enters interface configuration submode, the prompt changes to include (config-if) after the router name:
RP/0/RP0/CPU0:routername(config)# interface POS 0/2/0/0 RP/0/RP0/CPU0:routername(config-if)#

Cisco IOS XR Getting Started Guide

2-15

Chapter 2 Navigating the Cisco IOS XR Command Modes

Configuring General Router Features

Summary of Common Command Modes


Table 2-4 summarizes the most common command modes of the Cisco IOS XR software and the associated CLI prompts.
Table 2-4 Common Command Modes and CLI prompts

Command Mode EXEC

Description Logging in to a router running the Cisco IOS XR software automatically places the router in EXEC mode. Example:
RP/0/RP0/CPU0:router#

EXEC mode enables a basic set of commands to display the operational state of the router and examine the state of an operating system. Most CLI commands in EXEC mode do not change the system operation. The most common EXEC commands are show commands (to display router configuration or operational data) and clear commands (to clear or reset system counters). Additional commands are available depending on the access privileges (user groups) assigned to your username. Minimal privileges also include a small set of EXEC commands for connecting to remote devices, changing terminal line settings on a temporary basis, and performing basic tests. Global configuration Global configuration mode is the starting point for system configuration. Commands entered in this mode affect the system as a whole, rather than just one protocol or interface. Global configuration mode is also used for entering configuration submodes to configure specific elements, such as interfaces or protocols. To enter global configuration mode, enter the configure command at the EXEC command prompt:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)#

Note

The system prompt changes to router(config) to indicate that the router is now in global configuration mode.

Configuration submodes

From the global configuration mode, you can also enter other, more specific command modes. These modes are available based on your assigned access privileges and include protocol-specific, platform-specific, and feature-specific configuration modes. In the following example, MPLS LDP configuration mode is entered from global configuration mode. The prompt for MPLS LDP configuration submode appears as config-ldp. The following command syntax is used for entering configuration MPLS LDP submode:
RP/0/RP0/CPU0:router# RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# mpls ldp RP/0/RP0/CPU0:router(config-ldp)

Note

The availability of any particular mode depends on the router features and the access rights of the individual user. For example, a configuration mode for configuring access servers is not available on most routers.

Cisco IOS XR Getting Started Guide

2-16

Chapter 2

Configuring General Router Features Navigating the Cisco IOS XR Command Modes

Table 2-4

Common Command Modes and CLI prompts (continued)

Command Mode Interface configuration

Description The interface configuration submode is used to select and configure a hardware interface, such as a Packet-over-SONET (PoS) interface. To enter interface configuration mode from global configuration mode, use an interface command. An interface configuration command always follows an interface global configuration command, which defines the interface type. The following command syntax is used for entering interface configuration submode:
RP/0/RP0/CPU0:router(config)# interface POS 0/2/0/0 RP/0/RP0/CPU0:router(config-if)#

Router configuration

The router configuration submode is used to select and configure a routing protocol, such as BGP, OSPF, or IS-IS. The following command syntax is used for entering router configuration submode:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# router <protocol> RP/0/RP0/CPU0:router(config-protocol)#

In the following example, the router enters the router configuration mode for BGP:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# router bgp 140 RP/0/RP0/CPU0:router(config-bgp)#

Router submode configuration

Router configuration submodes are accessed from router configuration mode. The following command syntax is used for entering router address family configuration submode:
RP/0/RP0/CPU0:router(config)# router bgp 140 RP/0/RP0/CPU0:router(config-bgp)# address-family ipv4 multicast RP/0/RP0/CPU0:router(config-bgp-af)#

For more information, see the following Cisco Systems documents:


Cisco IOS XR Routing Configuration Guide Cisco IOS XR Routing Command Reference

Cisco IOS XR Getting Started Guide

2-17

Chapter 2 Navigating the Cisco IOS XR Command Modes

Configuring General Router Features

Table 2-4

Common Command Modes and CLI prompts (continued)

Command Mode admin EXEC and admin configuration modes

Description The Cisco IOS XR software provides a separate admin EXEC mode for users with the appropriate access permissions. This mode is used primarily to display system-wide parameters, configure the administration plane over the control Ethernet, and configure LRs on multiple-chassis systems. These operations are available only to users with the required root level access. From EXEC mode, use the admin command to enter admin EXEC mode. The following command syntax is used for entering admin EXEC and admin configuration submode:
RP/0/RP0/CPU0:router# admin RP/0/RP0/CPU0:router(admin)# RP/0/RP0/CPU0:router(admin)# configure RP/0/RP0/CPU0:router(admin-config)#

ROM Monitor (ROMMON) mode

The ROM Monitor is a bootstrap program that initializes the hardware and boots the system when a router is powered on or reset. ROM Monitor mode is also known as ROMMON, which reflects the CLI prompt for the mode.
rommon B1>

During normal operation, users do not interact with ROMMON. This mode is accessed only by manually interrupting the boot process and placing the system in ROMMON. Once in ROMMON, you can perform ROM Monitor tasks, including reinstallation of the Cisco IOS XR software, password recovery, and other diagnostic tasks. The ROM Monitor CLI mode is accessible only from a terminal connected directly to the Console port of the primary RP, a terminal-modem connection to the AUX port, or through a terminal server. See Appendix A, Router Recovery and Management with ROM Monitor, for information and instructions on using ROM Monitor mode.

Entering EXEC Commands from a Configuration Mode


EXEC commands can be executed from any configuration mode by preceding the command with the do keyword. Executing EXEC commands from a configuration mode allows you to display the state of the system without exiting the configuration mode. For example:
RP/0/RP0/CPU0:router(config)# do show version Cisco IOS-XR Software, Version 1.0.0 Copyright (c) 2004 by cisco Systems, Inc. ROM: System Bootstrap, Version 1.15(20040120:002852) [ROMMON], router uptime is 1 hour, 40 minutes 1000592k bytes of ATA PCMCIA card at disk 0 (Sector size 512 bytes). Configuration register is 0x2 --More--

Cisco IOS XR Getting Started Guide

2-18

Chapter 2

Configuring General Router Features Navigating the Cisco IOS XR Command Modes

Command Mode Navigation Example


The following steps provide an example of command mode navigation:
Step 1

Start a session by logging in to the router and entering EXEC mode, as shown in the following example:
router con0_RP0_CPU0 is now available

Press RETURN to get started.

User Access Verification Username: iosxr Password:<secret> RP/0/RP0/CPU0:router#

From EXEC mode you can issue EXEC commands or enter global configuration mode. Examples of EXEC commands are the show commands used to display system status and clear commands to clear counters or interfaces.
Step 2

Enter a question mark at the end of the prompt, or after a command, to display the available options:
RP/0/RP0/CPU0:router# show ? aaa adjacency aliases aps arm arp as-path-access-list asic-errors auto-rp bgp buffer-manager calendar cdp cef cetftp checkpoint cinetd clns clock commit community-list configuration --More-Show AAA configuration and operational data Adjacency information Display alias commands SONET APS information IP ARM information ARP table List AS path access lists ASIC error information Auto-RP Commands BGP show commands Show all buffer manager memory related information Display the system calendar CDP information Cisco Express Forwarding CRS-1 control plane ethernet TFTP server Show checkpoint services Cisco inetd services Display CLNS related information Display the system clock Show commit information List community-list Contents of Non-Volatile memory

Note Step 3

The commands available to you depend on the router mode and your user group assignments.

If you belong to a user group that has configuration privileges, you can place the router in the global configuration mode by entering the configure command:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)#

Step 4

From global configuration mode, you can place the router in a configuration submode, such as interface configuration mode or a protocol-specific configuration mode.

Cisco IOS XR Getting Started Guide

2-19

Chapter 2 Managing Configuration Sessions

Configuring General Router Features

In the following example, the router enters interface configuration mode and the user selects a Packet-over-SONET (PoS) interface for configuration. The command syntax is interface type rack/slot/module/port.
RP/0/RP0/CPU0:router(config)# interface POS 0/2/0/4 RP/0/RP0/CPU0:router(config-if)#

The command mode prompt changes from (config) to (config-if) and you can now enter configuration commands for the specified interface.
Step 5

To exit interface configuration mode and return to global configuration mode, enter the exit command. To return to EXEC mode, enter the end command.

Managing Configuration Sessions


In the Cisco IOS XR software, the running (active) configuration can never be altered directly. All configuration changes are entered into an inactive target configuration. When the target configuration is ready for use, you can apply that configuration to the router with the commit command,. This two-stage process allows configuration changes to be made, edited, and verified before the actual running state of the router is impacted. The following sections describe the management options for configuration sessions:

Entering Configuration Changes in the Nonactive Target Configuration, page 2-21 Committing Changes to the Running Configuration, page 2-21 Displaying Configuration Details with show Commands, page 2-23 Displaying Configuration Errors, page 2-28 Reloading a Failed Configuration, page 2-29 Clearing All Changes to a Target Configuration, page 2-29 Ending a Configuration Session, page 2-30 Locking and Unlocking the Running Configuration During Configuration Sessions, page 2-31

Figure 2-5 illustrates the two-stage configuration process.


Figure 2-5 Two-Stage Configuration Process

EXEC mode

Create the target configuration by entering global configuration mode.

Stage 1: Enter configuration changes to the nonactive target configuration.

Stage 2: "Commit" changes to the running configuration.

Save the target configuration to file, or load a file.

Startup configuration

Cisco IOS XR Getting Started Guide

2-20

116541

Automatic Save

Chapter 2

Configuring General Router Features Managing Configuration Sessions

Entering Configuration Changes in the Nonactive Target Configuration


When you place the router in global configuration mode using the configure command, a new target configuration session is created. The target configuration allows you to enter, review, and verify configuration changes without impacting the running configuration.

Note

The target configuration is not a copy of the running configuration; the target configuration contains only the configuration commands entered during the target configuration session. While in configuration mode, you can enter all Cisco IOS XR software commands that are supported in configuration mode. Each command is added to the target configuration. You can view the target configuration by entering the show configuration command in configuration mode. The target configuration is not applied until you enter the commit command, as described in the Committing Changes to the Running Configuration section on page 2-21. Target configurations can be saved to disk as nonactive configuration files. These saved files can be loaded, further modified, and committed at a later time. For more information, see the Saving and Loading Target Configuration Files section on page 3-9. This example shows a simple configuration session in which the target configuration is created and previewed:

Step 1

To create a new target configuration session, enter global configuration mode using the configure command:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)#

Step 2

Make changes to the target configuration. These changes do not affect the running configuration. The CLI automatically verifies the syntax of your commands and allows only valid entries:
RP/0/RP0/CPU0:router(config)# interface POS 0/2/0/1 RP/0/RP0/CPU0:router(config-if)# description faq RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.10.10.10 255.0.0.0

Step 3

To display the inactive changes, use the show configuration command:


RP/0/RP0/CPU0:router(config-if)# show configuration Building configuration... interface POS0/0/0/1 description faq ipv4 address 10.10.10.10 255.0.0.0 end

Committing Changes to the Running Configuration


The changes in the target configuration do not become part of the running configuration until you enter the commit command. When you commit a target configuration, you can use the commit command to do either of the following:

Merge the target configuration with the running configuration to create a new running configuration. Replace the running configuration with the target configuration.

Cisco IOS XR Getting Started Guide

2-21

Chapter 2 Managing Configuration Sessions

Configuring General Router Features

To commit target configuration changes to the running configuration, enter the commit command by itself or with one of the options described in Table 2-5.
Table 2-5 Commit Command Options

Command commit

Description (Default) Merges the target configuration with the running configuration and commits changes only if all changes in the target configuration pass the semantic verification process. If any semantic errors are found, none of the configuration changes takes effect. Merges the target configuration with the running configuration and commits only valid changes (best effort). Some configuration changes might fail due to semantic errors. (Optional) Assigns a comment to a commit.

commit best-effort

commit comment line

This text comment is displayed in the commit entry displayed with the show configuration commit list [detail] command. The line argument is the text for the optional comment or label. The comment option must appear at the end of the command line. If multiple options are entered, all text after the comment option is treated as a comment.

commit label line

(Optional) Assigns a meaningful label. This label is displayed in the output for the show configuration commit list [detail] command instead of the numeric label.

The line argument is the text for the optional comment or label.

commit force

(Optional) Merges the target configuration with the running configuration and allows a logical router owner to commit the configuration in low-memory conditions. A low-memory warning occurs when a user attempts to commit a target configuration that exceeds the default capacity of the router. The recommended resolution to such a warning is to remove configurations using the no commands.

Caution

The force option can cause the router to experience severe problems if low-memory conditions occur. The force option should be used only to remove configurations.

commit replace

(Optional) Replaces the contents of the running configuration with the target configuration.

In the following example, the default commit option is entered:


RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# interface POS 0/0/0/2 RP/0/RP0/CPU0:router(config-if)# description faq RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.1.1.1 255.0.0.0 RP/0/RP0/CPU0:router(config-if)# commit

Cisco IOS XR Getting Started Guide

2-22

Chapter 2

Configuring General Router Features Managing Configuration Sessions

Note

If you try to end a configuration session without saving your changes to the running configuration with the commit command, you are prompted to save the changes. See the Ending a Configuration Session section on page 2-30 for more information. When a target configuration is committed to the running configuration, a configuration change message is logged, as shown in the following example:
RP/0/0/0:Aug 6 09:26:17.781 : %LIBTARCFG-6-COMMIT Configuration committed by user user_a'. Use 'show configuration commit changes 1000000124' to view the changes.

Note

The preceding message is stored in the log and appears only if logging is configured to display on screen.

Note

Configuration files are stored on flash disk0:. Access these configurations only through the CLI commands for configuration management, history, and rollback. Direct modification or deletion of these files can result in lost router configurations.

Displaying Configuration Details with show Commands


Table 2-6 summarizes the commands used in global configuration mode to display the contents of the target configuration, the running configuration, or a combination of both.
Table 2-6 Configuration show Commands in Global Configuration Mode

Command show running-config show running-config sanitized

Description Displays the contents of the active running configuration. This is the committed configuration that defines the router operations. Displays the contents of the active running configuration without installation specific parameters. Some configuration details, such as IP addresses, are replaced with different addresses. The sanitized configuration can be used to share a configuration without exposing the configuration details. Displays the changes made to the target configuration. These are the changes that have been entered but not yet committed. Displays the combined contents of the target and running configuration without committing the changes.

show configuration show configuration merge

Note

You can use the show running-config command in the EXEC mode to display the contents of the running configuration.

Cisco IOS XR Getting Started Guide

2-23

Chapter 2 Managing Configuration Sessions

Configuring General Router Features

The following sections provide examples of displaying configuration details:


Displaying the Current Running Configuration, page 2-24 Displaying the Sanitized Running Configuration, page 2-25 Displaying the Target (Nonactive) Configuration Changes, page 2-27 Displaying the Merged Configuration Before Committing the Changes, page 2-27

Displaying the Current Running Configuration


To display the details of the currently running configuration, enter the show running-config command. The running configuration is the active configuration used to operate the router.
RP/0/RP1/CPU0:router(config)# show running-config Building configuration... !! Last configuration change at 11:05:38 UTC Mon May 02 2005 by lab ! hostname router logging console debugging telnet ipv4 server max-servers 5 username iosxr password 7 011F0706 group root-system group cisco-support ! ntp interface Loopback99 broadcast ! interface Loopback999 broadcast ! interface Loopback9999 broadcast ! authenticate max-associations 2000 ! interface Loopback0 ipv4 address 10.1.2.3 255.255.0.0 load-interval 0 ! interface Loopback1 ipv4 address 10.4.5.6 255.255.0.0 ! interface Loopback7 load-interval 0 ! interface Loopback2000 load-interval 0 ! interface Loopback2001 load-interval 0 ! interface Loopback2003 load-interval 0 ! interface MgmtEth0/RP1/CPU0/0 ipv4 address 10.11.12.13 255.255.0.0 !

Cisco IOS XR Getting Started Guide

2-24

Chapter 2

Configuring General Router Features Managing Configuration Sessions

interface POS0/0/0/0 shutdown ! interface POS0/0/0/1 shutdown ! interface POS0/0/0/2 shutdown ! interface POS0/0/0/3 shutdown ! interface POS0/3/0/0 shutdown ! interface POS0/3/0/1 shutdown ! interface POS0/3/0/2 shutdown ! interface POS0/3/0/3 shutdown ! interface preconfigure MgmtEth0/RP0/CPU0/0 shutdown ! route ipv4 0.0.0.0/0 MgmtEth0/RP1/CPU0/0 end

Displaying the Sanitized Running Configuration


To display the sanitized version of the currently running configuration, enter the show running-config sanitized command.
RP/0/RP1/CPU0:router(config)# show running-config sanitized Building configuration... !! Last configuration change at 11:05:38 UTC Mon May 02 2005 by <removed> ! hostname <removed> logging console debugging telnet ipv4 server max-servers 5 username <removed> password 7 <removed> group root-system group cisco-support ! ntp interface Loopback99 broadcast ! interface Loopback999 broadcast ! interface Loopback9999 broadcast ! authenticate max-associations 2000 !

Cisco IOS XR Getting Started Guide

2-25

Chapter 2 Managing Configuration Sessions

Configuring General Router Features

interface Loopback0 ipv4 address 10.0.0.0 255.0.0.0 load-interval 0 ! interface Loopback1 ipv4 address 10.0.0.0 255.0.0.0 ! interface Loopback7 load-interval 0 ! interface Loopback2000 load-interval 0 ! interface Loopback2001 load-interval 0 ! interface Loopback2003 load-interval 0 ! interface MgmtEth0/RP1/CPU0/0 ipv4 address 10.0.0.0 255.0.0.0 ! interface POS0/0/0/0 shutdown ! interface POS0/0/0/1 shutdown ! interface POS0/0/0/2 shutdown ! interface POS0/0/0/3 shutdown ! interface POS0/3/0/0 shutdown ! interface POS0/3/0/1 shutdown ! interface POS0/3/0/2 shutdown ! interface POS0/3/0/3 shutdown ! interface preconfigure MgmtEth0/RP0/CPU0/0 shutdown ! route ipv4 10.0.0.1/0 MgmtEth0/RP1/CPU0/0 end

Cisco IOS XR Getting Started Guide

2-26

Chapter 2

Configuring General Router Features Managing Configuration Sessions

Displaying the Target (Nonactive) Configuration Changes


To display the changes you have entered into the nonactive target configuration, enter the show configuration command. The target configuration includes changes that have not yet been committed, and are therefore not part of the active running configuration.
RP/0/RP0/CPU0:router(config-if)# show configuration Building configuration... interface POS0/3/0/3 description faq ipv4 address 10.1.1.1 255.0.0.0 end

Displaying the Merged Configuration Before Committing the Changes


To display the currently running configuration combined with the nonactive changes from the target configuration, enter the show configuration merge command in any configuration mode. In the following example, the user first displays the active configuration, then makes the necessary configuration changes, and displays the merged configuration. The merged configuration provides a preview of what the new active configuration will be after the commit command is executed.

Note

The merged configuration shows what the new running configuration will look like after the changes from the target configuration are committed. It does not represent the actual running configuration. Display the currently running configuration:
RP/0/RP0/CPU0:router# show running-config Building configuration... !! Last configuration change at 16:52:49 UTC Sun March 10 2004 by lab ! hostname router shutdown end

Step 1

Step 2

Open a target configuration session and enter configuration changes:


RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# interface POS 0/3/0/3 RP/0/RP0/CPU0:router(config-if)# description faq RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.1.1.1 255.0.0.0

Step 3

Display the merged configuration before committing the new settings:


RP/0/RP0/CPU0:router(config-if)# show configuration merge Building configuration... hostname router interface POS0/3/0/3 description faq ipv4 address 10.1.1.1 255.0.0.0 shutdown end

Cisco IOS XR Getting Started Guide

2-27

Chapter 2 Managing Configuration Sessions

Configuring General Router Features

Displaying Configuration Errors


Configuration changes are automatically verified during the commit operation, and a configuration message is displayed if one or more configuration entries fail. To display the cause of each failure, enter the show configuration failed commands, as summarized in Table 2-7.

Note

You can view configuration errors only during the current configuration session. If you exit configuration mode after the commit operation, the configuration error information is lost.
Table 2-7 Commands to Display Configuration Failure Details

Command show configuration failed show configuration failed load show configuration failed noerror

Description Displays commit error messages and descriptions generated during the last configuration commit. Displays any syntax errors found in a configuration loaded with the load command. Displays only commit error messages (without error descriptions).

In the following example, the configuration commit encounters an error:


RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# taskgroup bgp RP/0/RP0/CPU0:router(config-tg)# description this is a test of an invalid taskgroup RP/0/RP0/CPU0:router(config-tg)# commit % Failed to commit one or more configuration items. Please use 'show configurati on failed' to view the errors

To display the configuration items that failed, enter the show configuration failed command. The output from this command includes a description of the error:
RP/0/RP0/CPU0:router(config-tg)# show configuration failed !! CONFIGURATION FAILED DUE TO SEMANTIC ERRORS taskgroup bgp !!% Usergroup/Taskgroup names cannot be taskid names !

To display the configuration items that failed without error descriptions, enter the show configuration failed noerror command:
RP/0/RP0/CPU0:router(config-tg)# show configuration failed noerror !! CONFIGURATION FAILED DUE TO SEMANTIC ERRORS taskgroup bgp !

Cisco IOS XR Getting Started Guide

2-28

Chapter 2

Configuring General Router Features Managing Configuration Sessions

Reloading a Failed Configuration


If the router displays a configuration failure message when you attempt to commit a configuration change, the configuration changes are not lost. You can load the configuration changes into the target configuration, correct the errors, and commit the changes. To load a failed configuration, enter the load configuration failed command, as shown in the following example:
RP/0/0/CPU0:router(config-tg)# load configuration failed RP/0/0/CPU0:router(config)# show configuration Building configuration... taskgroup bgp ! end

In the preceding example, the show configuration command displays the target configuration, which includes the failed configuration.

Clearing All Changes to a Target Configuration


To clear changes made to the target configuration without terminating the configuration session, enter the clear command in global configuration mode. This command deletes any configuration changes that have not been committed. In the following example, the user configures an interface, but does not commit it. After reviewing the changes to the target configuration with the show configuration command, the user decides to remove the changes and start over by entering the clear command:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# interface POS 0/3/0/1 RP/0/RP0/CPU0:router(config-if)# description this is my interface RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.1.1.1 255.0.0.0 RP/0/RP0/CPU0:router(config-if)# shutdown RP/0/RP0/CPU0:router(config-if)# exit RP/0/RP0/CPU0:router(config)# show configuration Building configuration... interface POS0/3/0/1 description this is my interface ipv4 address 10.1.1.1 255.0.0.0 shutdown end RP/0/RP0/CPU0:router(config)# clear RP/0/RP0/CPU0:router(config)# show configuration Building configuration... end

Cisco IOS XR Getting Started Guide

2-29

Chapter 2 Managing Configuration Sessions

Configuring General Router Features

Ending a Configuration Session


The commands used to end a configuration session are summarized in Table 2-8.
Table 2-8 Commands to End a Configuration Sessions

Command exit

Description Returns to the next highest mode, one step at a time. If you use this command to exit global configuration mode when uncommitted changes are present, the router prompts you to select one of the following options:
Note

yes, commit the configuration changes and exit configuration mode no, exit configuration mode without committing the configuration changes cancel, remain in configuration mode without committing the configuration changes In EXEC mode, the exit command is used to log out of the system.

end abort

Returns directly to EXEC mode from any configuration mode. You are prompted to save any uncommitted changes to the target configuration. Discards any changes to the target configuration and returns directly to EXEC mode. No warning is given before the configuration changes are deleted.

The following sections provide examples of ending a configuration session:


Exit Command Example, page 2-30 End Command Example, page 2-31 Abort Command Example, page 2-31

Exit Command Example


To return to the previous configuration mode without saving changes to the target configuration, use the exit command. When you use this command to return to the EXEC mode, you are prompted to commit any uncommitted changes.
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# interface POS 0/3/0/1 RP/0/RP0/CPU0:router(config-if)# description this is my interface RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.1.1.1 255.0.0.0 RP/0/RP0/CPU0:router(config-if)# exit RP/0/RP0/CPU0:router(config)# exit RP/0/RP1/CPU0:ios(config)#exit Uncommitted changes found, commit them before exiting(yes/no/cancel)? [cancel]:yes RP/0/RP0/CPU0:router#

Note

In EXEC mode, the exit command is used to log out of the system.

Cisco IOS XR Getting Started Guide

2-30

Chapter 2

Configuring General Router Features Managing Configuration Sessions

End Command Example


To return to EXEC mode without saving changes to the target configuration, use the end command. You are prompted to commit any uncommitted changes.
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# hostname host1 RP/0/RP0/CPU0:router(config)# interface POS 0/2/0/2 RP/0/RP0/CPU0:router(config-if)# description this is my interface RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.1.1.1 255.0.0.0 RP/0/RP0/CPU0:router(config-if)# shutdown RP/0/RP0/CPU0:router(config-if)# end Uncommitted changes found, commit them? [yes]: no RP/0/RP0/CPU0:router#

Tip

You can also end a configuration session by pressing Ctrl-Z.

Abort Command Example


To discard any changes to the target configuration and return to EXEC mode, use the abort command. You are not prompted to commit any uncommitted changes:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# hostname host1 RP/0/RP0/CPU0:router(config)# interface POS 0/2/0/2 RP/0/RP0/CPU0:router(config-if)# description this is my interface RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.1.1.1 255.0.0.0 RP/0/RP0/CPU0:router(config-if)# shutdown RP/0/RP0/CPU0:router(config-if)# abort RP/0/RP0/CPU0:router#

Locking and Unlocking the Running Configuration During Configuration Sessions


When you place the router in global configuration mode with the configure command, a new target configuration is automatically created. More than one user can open a target configuration session at a time, allowing multiple users to work on separate target configurations. By default, the running configuration is locked whenever a commit operation is being performed. This automatic locking ensures that each commit operation is completed before the next one begins. Other users receive an error message if they attempt to commit a target configuration while another commit operation is under way. You can lock the running configuration for the duration of your own configuration session and use commands to display the other active configuration sections, as described in Table 2-9.
Table 2-9 Configuration Session Commands

Command configure

Description Enters global configuration mode and allows other users to commit target configurations.

show configuration sessions Displays the other configuration sessions on the router.

Cisco IOS XR Getting Started Guide

2-31

Chapter 2 Configuring the Router Hostname

Configuring General Router Features

Table 2-9

Configuration Session Commands (continued)

Command configure exclusive

Description Enters global configuration mode and denies other users the ability to commit changes while your configuration session is active. Other users can still enter global configuration mode and populate a target configuration, but they cannot commit those changes to the running configuration until you exit your exclusive configuration session.
Note

If the configuration is already locked by another user, the configure exclusive command fails.

exit or end

Unlocks the other configuration sessions by ending your configuration session and returning to EXEC mode.

To display the current configuration sessions, enter the show configuration sessions command in EXEC mode. Exclusive configuration sessions are noted by an asterisk (*), as shown in the following example:
RP/0/RP0/CPU0:router# show configuration sessions Session 00000000-000650a4-00000000 00000000-0006a0a3-00000000 Line dummy_line dummy_line User root root Date Thu Oct Thu Oct Lock 3 12:20:12 2003 3 12:24:23 2003 *

To lock the running configuration so that other users cannot commit changes while your configuration session is active, enter the configure exclusive command:
RP/0/RP0/CPU0:router# configure exclusive RP/0/RP0/CPU0:router(config)#

The running configuration is unlocked when the user who entered the configuration mode using the configure exclusive command exits the configuration mode:
RP/0/RP0/CPU0:router(config)# exit

Configuring the Router Hostname


The hostname identifies a router on the network. Although devices can be uniquely identified by their Layer 2 and Layer 3 addresses (such as an IP address), it is often simpler to remember network devices by an alphanumeric hostname. This name is used in the CLI prompt and default configuration filenames, and to identify the router on the network. To configure the hostname, perform the following procedure:

SUMMARY STEPS
1. 2. 3.

configure hostname router-name commit

Cisco IOS XR Getting Started Guide

2-32

Chapter 2

Configuring General Router Features Configuring the Management Ethernet Interface

Example
The following example shows how to configure the hostname for the router:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# hostname new_name RP/0/RP0/CPU0:router(config)# commit RP/0/RP0/CPU0:Apr 7 00:07:33.246 : config[65669]: %LIBTARCFG-6-COMMIT : Configu ration committed by user 'user_a'. Use 'show configuration commit changes 1000000067' to view the changes. RP/0/RP0/CPU0:new_name(config)#

Note

No blanks or spaces are permitted as part of a name. Do not expect case to be preserved. Upper- and lowercase characters look the same to many Internet software applications. It may seem appropriate to capitalize a name the same way you might if you were writing, but conventions dictate that computer names appear all lowercase. For more information, see RFC 1178, Choosing a Name for Your Computer.

Configuring the Management Ethernet Interface


The Management Ethernet interface on the RPs is used to connect the router to a network for remote management using a Telnet client, the Craft Works Interface (CWI), the Simple Network Management Protocol (SNMP), or other management agents. The following sections provide information on the Management Ethernet interface:

Specifying the Management Ethernet Interface Name in CLI Commands Displaying the Available Management Ethernet Interfaces Configuring the Management Ethernet Interface

Specifying the Management Ethernet Interface Name in CLI Commands


Before you can configure the Management Ethernet interface, you must know the Management Ethernet interface name, which is defined using the following syntax: typerack/slot/module/port. Table 2-10 describes the Management Ethernet interface name syntax.
Table 2-10 Management Ethernet Interface Name Syntax Description

Syntax Components type rack slot

Description Interface type for a Management Ethernet port is MgmtEth. Chassis number of the rack. In a single-chassis system, the rack is always 0. Physical slot of the RP on which the interface is located. For a Cisco CRS-1 router, the slot is RP0 or RP1. For a Cisco XR 12000 Series Router, the PRPs may be installed in slots 0 through 15, depending on the router model.

Cisco IOS XR Getting Started Guide

2-33

Chapter 2 Configuring the Management Ethernet Interface

Configuring General Router Features

Table 2-10

Management Ethernet Interface Name Syntax Description (continued)

Syntax Components module port

Description On an RP, the module is CPU0. On Cisco XR 12000 Series Routers, there are three Ethernet ports on PRP-2 cards. The Ethernet ports are labeled ETH 0, ETH 1, and ETH 2. For the ETH 0 port, specify 0, for the ETH 1 port, specify 1, and for the ETH 2 port, specify 2. On a Cisco CRS-1 router, one Ethernet port labeled MGMT ETH exists. Specify 0 for the MGMT ETH interface on a Cisco CRS-1 router.

Table 2-10 provides examples of Management Ethernet interface names for a single-chassis system.
Table 2-11 Management Ethernet Interface Names for Single-Chassis Systems

Management Interface Cisco CRS-1 RP in slot RP0 Cisco CRS-1 RP in slot RP1

Interface Name MgmtEth0/RP0/CPU0/0 MgmtEth0/RP1/CPU0/0

Example router(config)# interface MgmtEth0/RP0/CPU0/0 router(config)# interface MgmtEth0/RP1/CPU0/0 router(config)# interface MgmtEth0/0/CPU0/0 router(config)# interface MgmtEth0/0/CPU0/1 router(config)# interface MgmtEth0/1/CPU0/0 router(config)# interface MgmtEth0/1/CPU0/1

Cisco XR 12000 Series Router PRP MgmtEth0/0/CPU0/0 in slot 0, port ETH0 Cisco XR 12000 Series Router PRP MgmtEth0/0/CPU0/1 in slot 0, port ETH1 Cisco XR 12000 Series Router PRP MgmtEth0/1/CPU0/0 in slot 1, port ETH0 Cisco XR 12000 Series Router PRP MgmtEth0/1/CPU0/1 in slot 1, port ETH1

Cisco IOS XR Getting Started Guide

2-34

Chapter 2

Configuring General Router Features Configuring the Management Ethernet Interface

Displaying the Available Management Ethernet Interfaces


To display the router interfaces, enter the show interface brief command in EXEC mode as follows:
RP/0/0/CPU0:router# show interface brief Intf Name Intf State LineP State Encap MTU Type (byte) BW (Kbps)

-------------------------------------------------------------------------------Nu0 Mg0/0/CPU0/0 Mg0/0/CPU0/1 PO0/3/0/0 PO0/3/0/1 PO0/3/0/2 PO0/3/0/3 PO0/3/0/4 PO0/3/0/5 PO0/3/0/6 PO0/3/0/7 . . . up up admin-down admin-down admin-down admin-down admin-down admin-down admin-down admin-down admin-down up up admin-down admin-down admin-down admin-down admin-down admin-down admin-down admin-down admin-down Null ARPA ARPA HDLC HDLC HDLC HDLC HDLC HDLC HDLC HDLC 1500 1514 1514 4474 4474 4474 4474 4474 4474 4474 4474 Unknown 100000 10000 155520 155520 155520 155520 155520 155520 155520 155520

The Management Ethernet interfaces are listed with the prefix Mg in the Intf Name column.

Configuring the Management Ethernet Interface


To use the Management Ethernet interface for system management and remote communication, you must configure an IP address and a subnet mask for the interface. If you want the interface to communicate with devices on other networks (such as remote management stations or TFTP servers), you need to configure a default route for the router.

Tip

For information on additional configuration options for the Management Ethernet interface, see the Cisco IOS XR Interface and Hardware Component Configuration Guide.

Prerequisites
To configure the Ethernet Management port for network communications, you must enter the interface network addresses and subnet mask. Consult your network administrator or system planner for this information.

Cisco IOS XR Getting Started Guide

2-35

Chapter 2 Configuring the Management Ethernet Interface

Configuring General Router Features

SUMMARY STEPS
1. 2. 3. 4. 5. 6. 7. 8. 9.

configure interface MgmtEth0/slot/CPU0/port ipv4 address ipv4-address subnet-mask no shutdown exit route ipv4 unicast 0.0.0.0/0 default-gateway commit end show interfaces MgmtEth0/slot/CPU0/port

DETAILED STEPS
Command or Action
Step 1

Purpose Enters global configuration mode.

configure
Example:
RP/0/RP0/CPU0:router# configure

Step 2

interface MgmtEth0/slot/CPU0/port
Example:
RP/0/RP0/CPU0:router(config)# interface MgmtEth0/RP0/CPU0/0

Enters interface configuration mode and specifies the Management Ethernet interface of the primary RP.

The syntax is interface typerack/slot/module/port: The command parameters are described in Table 2-10.

Step 3

ipv4 address ipv4-address subnet-mask


Example:
RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.1.1.1 255.0.0.0

Assigns an IP address and subnet mask to the interface.

Step 4

no shutdown
Example:
RP/0/RP0/CPU0:router(config-if)# no shutdown

Places the interface in an up state.

Step 5

exit

Exits the Management Ethernet interface configuration mode.

Cisco IOS XR Getting Started Guide

2-36

Chapter 2

Configuring General Router Features Configuring the Management Ethernet Interface

Command or Action
Step 6

Purpose Configures a default route to use for communications with devices on other networks.

route ipv4 unicast 0.0.0.0/0 default-gateway

Replace default-gateway with the IP address of the local gateway that can be used to reach other networks. This default route applies to all interfaces. You might need to configure additional static routes to support your network. For more information on configuring static routes, see the Cisco IOS XR Routing Configuration Guide.

Step 7

commit
Example:
RP/0/RP0/CPU0:router(config-if)# commit

Commits the target configuration to the running configuration.

Step 8

end
Example:
RP/0/RP0/CPU0:router(config-if)# end

Ends the configuration session and returns to EXEC mode.

Step 9

show interfaces MgmtEth0/slot/CPU0/port


Example:
RP/0/RP0/CPU0:router# show interfaces MgmtEth0/RP0/CPU0/0

Displays the interface details to verify the settings.

Examples
In the following example, the Management Ethernet interface on the RP in slot RP1 is configured with an IP address:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# interface MgmtEth0/RP1/CPU0/0 RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.1.1.1 255.255.255.0 RP/0/RP0/CPU0:router (config-if)# no shutdown RP/0/RP0/CPU0:router (config-if)# commit RP/0/RP0/CPU0:router (config-if)# end RP/0/RP0/CPU0:router# RP/0/RP0/CPU0:router# show interfaces MgmtEth 0/RP1/CPU0/0 MgmtEth0/RP1/CPU0/0 is up, line protocol is up Hardware is Management Ethernet, address is 0005.9a39.910c (bia 0005.9a39.910c ) Internet address is 10.1.1.1 MTU 1514 bytes, BW 100000 Kbit reliability 255/255, txload 1/255, rxload 1/255 Encapsulation ARPA, Full-duplex, 100Mb/s loopback not set ARP type ARPA, ARP timeout 01:00:00 Last clearing of "show interface" counters never 30 second input rate 0 bits/sec, 0 packets/sec

Cisco IOS XR Getting Started Guide

2-37

Chapter 2 Manually Setting the Router Clock

Configuring General Router Features

30 second output rate 0 bits/sec, 0 packets/sec 15205 packets input, 7467959 bytes, 0 total input drops 0 drops for unrecognized upper-level protocol Received 2352 broadcast packets, 0 multicast packets 0 runts, 0 giants, 0 throttles, 0 parity 0 input errors, 0 CRC, 0 frame, 0 overrun, 0 ignored, 0 abort 13528 packets output, 656060 bytes, 0 total output drops Output 56 broadcast packets, 0 multicast packets 0 output errors, 0 underruns, 0 applique, 0 resets 0 output buffer failures, 0 output buffers swapped out 0 carrier transitions --More--

Related Documents
Related Topic Additional information on configuring management interfaces Document Title Cisco IOS XR Interface and Hardware Component Configuration Guide

Manually Setting the Router Clock


Generally, if the system is synchronized by a valid outside timing mechanism, such as a Network Time Protocol (NTP) or VINES clock source, you need not set the software clock. Use the clock set command for initial configuration or if a network time source is not available. The clock timezone command should be entered before the clock is set because it defines the difference between the system time and Coordinated Universal Time (UTC). When you set the time, you set the system time, and the router uses the clock timezone command setting to translate that time to UTC. The system internally keeps time in UTC. When you enter the show time command, the router displays the system time. To manually set the router clock, complete the following steps:

SUMMARY STEPS
1. 2. 3. 4. 5. 6. 7.

configure clock timezone zone hours-offset commit end clock set hh:mm:ss dd mm yyyy clock update-calendar show clock

Cisco IOS XR Getting Started Guide

2-38

Chapter 2

Configuring General Router Features Manually Setting the Router Clock

DETAILED STEPS
Command or Action
Step 1

Purpose Enters global configuration mode.

configure
Example:
RP/0/RP0/CPU0:router# configure

Step 2

clock timezone zone hours-offset


Example:
RP/0/RP0/CPU0:router(config)# clock timezone pst -8

Sets the time zone for the router clock.

The clock timezone command should be entered before the clock is set because it defines the difference between the system time and UTC. The system time is the time that appears when you enter the show time command. zone: Name of the time zone to be displayed when standard time is in effect. hours-offset: Difference in hours from UTC. For detailed information about setting the system clock, including the configuration of a network time server, see the following Cisco documents:
Cisco IOS XR System Management

Note

Configuration Guide
Cisco IOS XR System Security Command

Reference
Step 3

commit
Example:
RP/0/RP0/CPU0:router(config-if)# commit

Commits the target configuration to the running configuration.

Step 4

end
Example:
RP/0/RP0/CPU0:router(config-if)# end

Ends the configuration session and returns to EXEC mode.

Step 5

clock set hh:mm:ss dd mm yyyy


Example:
RP/0/RP0/CPU0:router# clock set 14:12:00 10 feb 2004

Sets the system software clock.

Cisco IOS XR Getting Started Guide

2-39

Chapter 2 Where to Go Next

Configuring General Router Features

Step 6

clock update-calendar
Example:
RP/0/RP0/CPU0:router# clock update-calendar

Updates the hardware clock (calendar clock) with the new clock settings.

The hardware clock is battery operated and runs continuously, even if the router is powered off or rebooted. Use this command to verify the settings.

Step 7

show clock
Example:
RP/0/RP0/CPU0:router# show clock

Displays the clock setting.

Examples
In the following example, the manual system clock is configured:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# clock timezone pst -8 RP/0/RP0/CPU0:router(config)# commit RP/0/RP0/CPU0:router(config)# end RP/0/RP0/CPU0:router# clock set 14:12:00 10 feb 2004 14:12:00.090 PST Tue Feb 10 2004 RP/0/RP0/CPU0:router# clock update-calendar RP/0/RP0/CPU0:router# show clock 14:12:00.090 PST Tue Feb 10 2004

Related Documents
Related Topic Descriptions of the clock commands available in the Cisco IOS XR software Commands used to configure the NTP Configuration of the NTP on the Cisco IOS XR software Document Title Cisco IOS XR System Management Command Reference Cisco IOS XR System Management Command Reference Cisco IOS XR System Management Configuration Guide

Where to Go Next
When you have completed the configuration procedures in this chapter, consider the following resources for additional configuration documentation:

For information on configuring additional general router features, see Chapter 3, Configuring Additional Router Features. For information on using the Cisco IOS XR software more efficiently, see Chapter 4, CLI Tips, Techniques, and Shortcuts. For information on configuring interfaces, see the hardware documents listed in the Related Documents section on page xv.

Cisco IOS XR Getting Started Guide

2-40

C H A P T E R

Configuring Additional Router Features


This chapter contains instructions and information for entering basic configurations using the command-line interface (CLI).

Contents
This chapter contains the following sections:

Configuring the Domain Name and Domain Name Server, page 3-1 Configuring Telnet, HTTP, and XML Host Services, page 3-2 Managing Configuration History and Rollback, page 3-3 Saving and Loading Target Configuration Files, page 3-9 Configuring Logging and Logging Correlation, page 3-11 Creating and Modifying User Accounts and User Groups, page 3-14 Configuration Limiting, page 3-17

Configuring the Domain Name and Domain Name Server


Configure a domain name and domain name server (DNS) for your router to make contacting other devices on your network more efficient. Use the following guidelines:

To define a default domain name that the Cisco IOS XR software uses to complete unqualified hostnames (names without a dotted-decimal domain name), use the domain-name command in global configuration mode. To specify the address of one or more name servers to use for name and address resolution, use the domain name-server command in global configuration mode. If no name server address is specified, the default name server is 255.255.255.255 so the DNS lookup can be broadcast to the local network segment. If a DNS server is in the local network, it replies. If not, there might be a server that knows how to forward the DNS request to the correct DNS server. Use the show hosts command in EXEC mode to display the default domain name, the style of name lookup service, a list of name server hosts, and the cached list of hostnames and addresses.

Cisco IOS XR Getting Started Guide

3-1

Chapter 3 Configuring Telnet, HTTP, and XML Host Services

Configuring Additional Router Features

To configure the DNS and DNS server, complete the following steps:

SUMMARY STEPS
1. 2. 3. 4. 5. 6.

configure domain name domain-name-of-organization domain name-server ipv4-address commit end show hosts

Examples
In the following example, the domain name and DNS are configured:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# domain name cisco.com RP/0/RP0/CPU0:router(config)# domain name-server 10.1.1.1 RP/0/RP0/CPU0:router(config)# commit RP/0/RP0/CPU0:router(config)# end RP/0/RP0/CPU0:router# show hosts Default domain is cisco.com Name/address lookup uses domain service Name servers: 10.1.1.1

Related Documents
Related Topic Complete descriptions of the domain services commands Document Title Implementing Host Services and Applications on Cisco IOS XR Software in the Cisco IOS XR IP Addresses and Services Configuration Guide

Configuring Telnet, HTTP, and XML Host Services


For security, some host services are disabled by default. Host services, such as Telnet, Extensible Markup Language (XML), and HTTP, can be optionally enabled using the commands described in this section. Host services provide the following features:

Enabling the Telnet server allows users to log in to the router using IPv4 or IPv6 Telnet clients. Enabling the HTTP server allows users to log in to the router using the CWI. Enabling the XML agent enables XML Common Object Request Broker Architecture (CORBA) agent services so that you can manage and configure the router using an XML interface.

Note

IPv6 is not supported on the Cisco XR 12000 Series Router.

Cisco IOS XR Getting Started Guide

3-2

Chapter 3

Configuring Additional Router Features Managing Configuration History and Rollback

Prerequisites
The following prerequisites must be met before configuring the Telnet, HTTP, and XML host services:

For the XML and HTTP host services, the Manageability package must be installed and activated on the router. To enable the Secure Socket Layer (SSL) of the HTTP and XML services, the Security package must be installed and activated on the router.

See Chapter 5, Managing Cisco IOS XR Software Packages, for information on installing and activating packages.

SUMMARY STEPS
1. 2. 3. 4. 5. 6.

configure telnet ipv4 server max-servers 5 telnet ipv6 server max-servers 5 http server xml agent corba commit

Examples
In the following example, the host services are enabled:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# telnet ipv4 server max-servers 5 RP/0/RP0/CPU0:router(config)# telnet ipv6 server max-servers 5 RP/0/RP0/CPU0:router(config)# http server RP/0/RP0/CPU0:router(config)# xml agent corba RP/0/RP0/CPU0:router(config)# commit

Related Documents
Related Topic Installation and activation of the Manageability and Security Packages Descriptions of the Telnet commands Document Title Chapter 5, Managing Cisco IOS XR Software Packages

Descriptions of the HTTP and XML server commands Cisco IOS XR System Management Command Reference Cisco IOS XR IP Addresses and Services Command Reference

Managing Configuration History and Rollback


After each commit operation, a record of the committed configuration changes is saved. This record contains only the changes made during the configuration session; it does not contain the complete configuration. Each record is assigned a unique ID, known as a commitID.

Cisco IOS XR Getting Started Guide

3-3

Chapter 3 Managing Configuration History and Rollback

Configuring Additional Router Features

When multiple commitIDs are present, you can use a commitID to identify a previous configuration to which you want to return, or you can use the commitID to load the configuration changes made during that configuration session. You can also load configuration changes from multiple commitIDs, and you can clear commitIDs. If you are thinking about rolling back the configuration to a specific commitID, consider the following guidelines:

You cannot roll back to a configuration that was removed because of package incompatibility. Configuration rollbacks can succeed only when the configuration passes all compatibility checks with the currently active Cisco IOS XR software. If an incompatible configuration is found during the rollback operation, the operation fails and an error is displayed.

The Cisco IOS XR software automatically saves up to 100 of the most recent commitIDs. The following sections describe how to manage configuration changes and roll back to a previously committed configuration:

Displaying the CommitIDs, page 3-4 Displaying the Configuration History Log, page 3-5 Displaying the Configuration Changes Recorded in a CommitID, page 3-6 Previewing Rollback Configuration Changes, page 3-6 Rolling Back the Configuration to a Specific Rollback Point, page 3-7 Rolling Back the Configuration over a Specified Number of Commits, page 3-7 Loading the Configuration Changes for a Specific CommitID, page 3-8 Loading Rollback Configuration Changes to the Target Configuration, page 3-8 Deleting CommitIDs, page 3-9

Displaying the CommitIDs


To display a history of up to 100 of the most recent commitIDs, enter the show configuration commit list command in EXEC mode. Up to 100 of the most recent commitIDs are saved by the system. Each commitID entry shows the user who committed configuration changes, the connection used to execute the commit, and commitID time stamp.

Cisco IOS XR Getting Started Guide

3-4

Chapter 3

Configuring Additional Router Features Managing Configuration History and Rollback

The commitIDs are shown in the Label/ID column. The following example shows the show configuration commit list command display:
RP/0/RP0/CPU0:router# show configuration commit list SNo. ~~~~ 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 Label/ID ~~~~~~~~ 1000000391 1000000390 1000000389 1000000388 1000000387 1000000386 1000000385 1000000384 1000000383 1000000382 1000000381 1000000380 1000000379 1000000378 1000000377 User ~~~~ user_a user_a user_a user_a user_a user_a user_a user_a user_a user_a user_a user_a user_a user_a user_a Line ~~~~ con0_33_1 con0_33_1 con0_33_1 con0_33_1 con0_33_1 con0_32_1 con0_33_1 con0_33_1 con0_33_1 con0_33_1 con0_33_1 con0_33_1 con0_33_1 con0_33_1 con0_33_1 Client ~~~~~~ CLI CLI CLI CLI CLI CLI CLI CLI CLI CLI CLI CLI CLI CLI CLI Time Stamp ~~~~~~~~~~ 19:29:18 UTC 19:29:16 UTC 19:29:15 UTC 19:29:12 UTC 19:26:16 UTC 19:18:38 UTC 19:14:09 UTC 19:13:58 UTC 19:13:33 UTC 19:12:50 UTC 19:12:48 UTC 19:12:46 UTC 19:12:43 UTC 19:12:14 UTC 19:10:47 UTC

Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed

Jan Jan Jan Jan Jan Jan Jan Jan Jan Jan Jan Jan Jan Jan Jan

10 10 10 10 10 10 10 10 10 10 10 10 10 10 10

2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004

Displaying the Configuration History Log


To display the header records for up to 1000 commit events, enter the show configuration commit history command in EXEC mode, as shown in the following example. The output from this command does not show the details of the entries, but allows you to display a larger list of the commit events that occurred. To display the commitIDs to which you can roll back, use the show configuration commit list command.

Cisco IOS XR Getting Started Guide

3-5

Chapter 3 Managing Configuration History and Rollback

Configuring Additional Router Features

RP/0/RP0/CPU0:router# show configuration commit history SNo. ~~~~ 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Label/ID ~~~~~~~~ 1000000144 1000000143 1000000142 1000000141 1000000140 1000000139 1000000138 1000000137 1000000136 1000000135 1000000134 1000000133 1000000132 1000000131 1000000130 1000000129 1000000128 1000000127 1000000126 1000000125 User ~~~~ user_a user_a user_a user_a user_b user_a user_a user_b user_a user_b user_b user_b user_b user_b user_b user_b user_b user_b user_b user_b Line Client ~~~~ ~~~~~~ vty0 CLI vty0 CLI 0.0.0.0 XMLAgent 0.0.0.0 XMLAgent con0_RP1_C CLI 0.0.0.0 XMLAgent 0.0.0.0 XMLAgent con0_RP1_C CLI 0.0.0.0 XMLAgent con0_RP1_C CLI con0_RP1_C CLI con0_RP1_C CLI con0_33_1 Rollback con0_33_1 Rollback con0_33_1 Rollback con0_33_1 CLI con0_33_1 CLI con0_33_1 CLI con0_33_1 Rollback con0_33_1 Rollback Time Stamp ~~~~~~~~~~ 00:16:51 UTC 00:04:32 UTC 21:58:36 UTC 21:46:07 UTC 21:43:30 UTC 21:40:13 UTC 21:34:48 UTC 21:32:10 UTC 21:30:13 UTC 19:45:04 UTC 19:37:26 UTC 19:36:27 UTC 18:34:45 UTC 18:32:37 UTC 18:31:09 UTC 18:28:12 UTC 18:27:22 UTC 18:27:19 UTC 18:25:55 UTC 18:24:25 UTC

Thu Thu Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed

May May May May May May May May May May May May May May May May May May May May

11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11 11

2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004

Displaying the Configuration Changes Recorded in a CommitID


To display the configuration changes made during a specific commit session (commitID), enter the show configuration commit changes command followed by a commitID number, as shown in the following example:
RP/0/0/CPU0:router# show configuration commit changes Building configuration... hostname router2 end 1000000071

Previewing Rollback Configuration Changes


The show configuration rollback changes command allows you to preview the configuration changes that take place if you roll back the configuration to a specific commitID. For example, if you want to roll back the configuration to a specific point, all configuration changes made after that point must be undone. This rollback process is often accomplished by executing the no version of commands that must be undone.

Cisco IOS XR Getting Started Guide

3-6

Chapter 3

Configuring Additional Router Features Managing Configuration History and Rollback

To display the prospective rollback configuration changes from the current configuration to a specific session, enter the show configuration rollback changes to commitId command:
RP/0/RP0/CPU0:router# show configuration rollback changes to 1000000373 Building configuration... interface Loopback2 no description no ipv4 address 10.0.0.1 255.0.0.0

To display the prospective rollback configuration changes from the current configuration to a specified number of previous sessions, enter the show configuration rollback changes last commit-range command:
RP/0/RP0/CPU0:router# show configuration rollback changes last 2 Building configuration... interface Loopback3 no description no ipv4 address 10.0.1.1 255.0.0.0 exit interface Loopback4 no description no ipv4 address 10.0.0.1 255.0.0.0 end

In the preceding example, the command display shows the proposed rollback configuration changes for the last two commit IDs.

Rolling Back the Configuration to a Specific Rollback Point


When you roll back the configuration to a specific rollback point, you undo all configuration changes made during the session identified by the commit ID for that rollback point, and you undo all configuration changes made after that point. The rollback process rolls back the configuration and commits the rolled-back configuration.

Tip

To preview the commands that undo the configuration during a rollback, use the show configuration rollback changes command. To roll back the router configuration to a previously committed configuration, enter the rollback configuration to commitId command:
RP/0/RP0/CPU0:router# rollback configuration to 1000000325 Configuration successfully rolled back to 1000000325.

Rolling Back the Configuration over a Specified Number of Commits


When you roll back the configuration over a specific number of commits, you do not have to enter a specific commit ID. Instead, you specify a number x, and the software undoes all configuration changes made in the last x committed configuration sessions. The rollback process rolls back the configuration and commits the rolled-back configuration.

Cisco IOS XR Getting Started Guide

3-7

Chapter 3 Managing Configuration History and Rollback

Configuring Additional Router Features

Tip

To preview the commands that undo the configuration during a rollback, use the show configuration rollback changes command. To roll back to the last x commits made, enter the rollback configuration last x command; x is a number ranging from 1 to the number of saved commits in the commit database. In the following example, a request is made to roll back the configuration changes made during the previous two commits:
RP/0/RP0/CPU0:router# rollback configuration last 2 Loading Rollback Changes. Loaded Rollback Changes in Committing. 1 items committed in 1 sec Updating. Updated Commit database in Configuration successfully

1 sec (0)items/sec 1 sec rolled back 2 commits.

Loading the Configuration Changes for a Specific CommitID


You can load the configuration changes recorded by any commitID by entering the load commit changes command in global configuration mode. The load commit changes command must be followed by a commitID number, as shown in the following example:
RP/0/0/CPU0:router(config)# load commit changes 1000000066 Building configuration... Loading. 21 bytes parsed in 1 sec (20)bytes/sec

The configuration changes are added to the target configuration and are not applied until you enter the commit command.

Tip

To display the target configuration, enter the show configuration command.

Loading Rollback Configuration Changes to the Target Configuration


You can load rollback configuration changes to the target configuration by entering the load rollback changes command in global configuration mode. This command is similar to the rollback configuration command. The difference between the commands is that the load rollback changes command copies the rollback changes to the target configuration and does not commit the changes.

Tip

To display the rollback changes, enter the show configuration rollback changes command.

Cisco IOS XR Getting Started Guide

3-8

Chapter 3

Configuring Additional Router Features Saving and Loading Target Configuration Files

To load rollback configuration changes from the current configuration to a specific session, enter the load rollback changes to commitId command:
RP/0/0/CPU0:router(config)# load rollback changes to 1000000068 Building configuration... Loading. 233 bytes parsed in 1 sec (231)bytes/sec

To load rollback configuration changes from the current configuration to a specified number of previous sessions, enter the load rollback changes last commit-range command:
RP/0/0/CPU0:router(config)# load rollback changes last 6 Building configuration... Loading. 221 bytes parsed in 1 sec (220)bytes/sec

In the preceding example, the command loads the rollback configuration changes for the last six commitIDs. To load the rollback configuration for a specific commitID, enter the load rollback changes commitId command:
RP/0/0/CPU0:router(config)# load rollback changes 1000000060 Building configuration... Loading. 199 bytes parsed in 1 sec (198)bytes/sec

Deleting CommitIDs
You can delete the oldest configuration commitIDs by entering the clear configuration commit command in EXEC mode. The clear configuration commit command must be followed by either the amount of disk space you want to reclaim or number of commitIDs you want to delete. To reclaim disk space from the oldest commitIDs, enter the clear configuration commit command followed by the keyword diskspace and number of kilobytes to reclaim:
RP/0/0/CPU0:router# clear configuration commit diskspace 50 Deleting 4 rollback points '1000000001' to '1000000004' 64 KB of disk space will be freed. Continue with deletion?[confirm]

To delete a specific number of the oldest commitIDs, enter the clear configuration commit command followed by the keyword oldest and number of commitIDs to delete:
RP/0/0/CPU0:router# clear configuration commit oldest 5 Deleting 5 rollback points '1000000005' to '1000000009' 80 KB of disk space will be freed. Continue with deletion?[confirm]

Saving and Loading Target Configuration Files


Target configurations can be saved to a separate file without committing them to the running configuration. Target configuration files can then be loaded at a later time and further modified or committed. The following sections describe how to save and load target configurations:

Saving the Target Configuration to a File, page 3-10 Loading the Target Configuration from a File, page 3-10

Cisco IOS XR Getting Started Guide

3-9

Chapter 3 Saving and Loading Target Configuration Files

Configuring Additional Router Features

Saving the Target Configuration to a File


To save the configuration changes in the target configuration to a file, enter the show configuration | file filename command.

If the full path of the file is not specified, the default directory for your account is used. You should always save your target configuration files to this location. The filename should end with the .cfg suffix for easy identification. This suffix is not required, but can help locate target configuration files. Example: myconfig.cfg

Tip

If you have not changed directories since login, you can display your default directory by entering the pwd command. In the following example, a target configuration file is saved to the root of disk0:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# show configuration | file disk0:myconfig.cfg RP/0/RP0/CPU0:router(config)# abort RP/0/RP0/CPU0:router#

Loading the Target Configuration from a File


Enter the load filename command to populate the target configuration with the contents of a previously saved configuration file. Consider the following when entering the filename argument:

The filename argument specifies the configuration file to be loaded into the target configuration. If the full path of the file is not specified, the default location is used. You should always save your target configuration files to this location.

In the following example, a target configuration file is loaded into the current configuration session. The current configuration session is therefore populated with the contents of the file:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# load disk0:myconfig.cfg RP/0/RP0/CPU0:router(config)# show configuration Building configuration... interface POS 0/3/0/0 description My Pos Interface address 10.10.11.20 255.0.0.0 !end

ipv4

Loading an Alternative Configuration at System Startup


When a router is reset or powered on, the last running configuration is loaded and used to operate the router. You can also load an alternative configuration during system boot. See Appendix A, Router Recovery and Management with ROM Monitor, for information and instructions on this process.

Cisco IOS XR Getting Started Guide

3-10

Chapter 3

Configuring Additional Router Features Configuring Logging and Logging Correlation

Configuring Logging and Logging Correlation


System messages generated by the Cisco IOS XR software can be logged to a variety of locations based on the severity level of the messages. For example, you could direct information messages to the system console and also log debugging messages to a network server. In addition, you can define correlation rules that group and summarize related events, generate complex queries for the list of logged events, and retrieve logging events through an XML interface. The following sections describe logging and the basic commands used to log messages in Cisco IOS XR software:

Logging Locations and Severity Levels, page 3-11 Alarm Logging Correlation, page 3-11 Configuring Basic Message Logging, page 3-12

Logging Locations and Severity Levels


Error messages can be logged to a variety of locations, as shown in Table 3-1.
Table 3-1 Logging Locations for System Error Messages

Logging Destination console vty terminal external syslog server internal buffer

Command (Global Configuration Mode) logging console logging monitor logging trap logging buffered

You can log messages based on the severity level of the messages, as shown in Table 3-2.
Table 3-2 Logging Severity Levels for System Error Messages

Level Level 0Emergencies Level 1Alerts Level 2Critical Level 3Errors Level 4Warnings Level 5Notifications Level 6Informational Level 7Debugging

Description System has become unusable. Immediate action needed to restore system stability. Critical conditions that may require attention. Error conditions that may help track problems. Warning conditions that are not severe. Normal but significant conditions that bear notification. Informational messages that do not require action. Debugging messages are for system troubleshooting only.

Alarm Logging Correlation


Alarm logging correlation is used to group and filter similar messages to reduce the amount of redundant logs and isolate the root causes of the messages.

Cisco IOS XR Getting Started Guide

3-11

Chapter 3 Configuring Logging and Logging Correlation

Configuring Additional Router Features

For example, the original message describing a card online insertion and removal (OIR) and system state being up or down can be reported, and all subsequent messages reiterating the same event can be correlated. When you create correlation rules, a common root event that is generating larger volumes of follow-on error messages can be isolated and sent to the correlation buffer. An operator can extract all correlated messages for display later, should the need arise. See the Cisco IOS XR System Management Configuration Guide for more information.

Configuring Basic Message Logging


Numerous options for logging system messages in Cisco IOS XR software are available. This section provides a basic example. To configure basic message logging, complete the following steps:

SUMMARY STEPS
1. 2. 3. 4. 5. 6. 7. 8.

configure logging {ip-address | hostname} logging trap severity logging console [severity] logging buffered [severity | buffer-size] commit end show logging

DETAILED STEPS
Command or Action
Step 1

Purpose Enters global configuration mode.

configure
Example:
RP/0/RP0/CPU0:router# configure

Step 2

logging {ip-address | hostname}


Example:
RP/0/RP0/CPU0:router(config)# logging 10.1.1.1

Specifies a syslog server host to use for system logging.

Step 3

logging trap severity


Example:
RP/0/RP0/CPU0:router(config)# logging trap debugging

Limits the logging of messages sent to syslog servers to only those messages at the specified level.

See Table 3-2 for a summary of the logging severity levels.

Cisco IOS XR Getting Started Guide

3-12

Chapter 3

Configuring Additional Router Features Configuring Logging and Logging Correlation

Command or Action
Step 4

Purpose Logs messages on the console.

logging console [severity]


Example:
RP/0/RP0/CPU0:router(config)# logging console emergencies

When a severity level is specified, only messages at that severity level are logged on the console. See Table 3-2 for a summary of the logging severity levels. Newer messages overwrite older messages after the buffer is filled. Specifying a severity level causes messages at that level and numerically lower levels to be logged in an internal buffer. See Table 3-2 for a summary of the logging severity levels. The buffer size is from 4096 to 4,294,967,295 bytes. Messages above the set limit are logged to the console.

Step 5

logging buffered [severity | buffer-size]


Example:
RP/0/RP0/CPU0:router(config)# logging buffered 1000000

Copies logging messages to an internal buffer.


Step 6

commit
Example:
RP/0/RP0/CPU0:router(config)# commit

Commits the target configuration to the router running configuration.

Step 7

end
Example:
RP/0/RP0/CPU0:router(config)# end

Ends the configuration session and returns to EXEC mode.

Step 8

show logging
Example:
RP/0/RP0/CPU0:router# show logging

Displays the messages that are logged in the buffer.

Examples
In the following example, basic message logging is configured:
RP/0/RP0/CPU0:router# config RP/0/RP0/CPU0:router(config)# logging 10.1.1.1 RP/0/RP0/CPU0:router(config)# logging trap debugging RP/0/RP0/CPU0:router(config)# logging console emergencies RP/0/RP0/CPU0:router(config)# logging buffered 1000000 RP/0/RP0/CPU0:router(config)# commit RP/0/RP0/CPU0:router(config)# end RP/0/RP0/CPU0:router# show logging Syslog logging: enabled (10 messages dropped, 0 flushes, 0 overruns) Console logging: level debugging, 103 messages logged Monitor logging: level debugging, 0 messages logged Trap logging: level informational, 0 messages logged Buffer logging: level debugging, 107 messages logged Log Buffer (16384 bytes):

Cisco IOS XR Getting Started Guide

3-13

Chapter 3 Creating and Modifying User Accounts and User Groups

Configuring Additional Router Features

RP/0/RP0/CPU0:Apr 6 21:30:59.515 : alphadisplay[103][317]: alpha_display_drain_ queue: Draining 1 message from the queue of size = 1 RP/0/RP0/CPU0:Apr 6 21:31:03.099 : ingressq[227]: %INGRESSQ_DLL-3-HALF_DEPTH_PA RT_DISCOVERED : ingressq dll: half depth memory detected, memory: DQ External QE Memory --More--

Related Documents
For more information on message logging and configuration of alarm correlation, see the following Cisco documents: Related Topic Configuration of system logging Commands used to configure logging Configuration of alarm correlation and generating complex queries Commands used to configure alarm correlation Retrieve logging events through an XML interface Document Title Cisco IOS XR System Management Configuration Guide Cisco IOS XR System Management Command Reference Cisco IOS XR System Management Configuration Guide Cisco IOS XR System Management Command Reference Cisco IOS XR XML API Guide

Creating and Modifying User Accounts and User Groups


In the Cisco IOS XR software, users are assigned individual usernames and passwords. Each username is assigned to one or more user groups, each of which defines display and configuration commands the user is authorized to execute. This authorization is enabled by default in the Cisco IOS XR software, and each user must log in to the system using a unique username and password. The following sections describe the basic commands used to configure users and user groups. For a summary of user accounts, user groups, and task IDs, see the User Access Privileges section on page 2-12.

Displaying Details About User Accounts, User Groups, and Task IDs, page 3-15 Configuring User Accounts, page 3-15

Note

The management of user accounts, user groups, and task IDs is part of the AAA feature in the Cisco IOS XR software. AAA stands for authentication, authorization, and accounting, a suite of security features included in the Cisco IOS XR software. For more information on the AAA concepts and configuration tasks, see the Cisco IOS XR System Security Configuration Guide and the Cisco IOS XR System Security Command Reference. For instructions to activate software packages, see Chapter 5, Managing Cisco IOS XR Software Packages.

Cisco IOS XR Getting Started Guide

3-14

Chapter 3

Configuring Additional Router Features Creating and Modifying User Accounts and User Groups

Displaying Details About User Accounts, User Groups, and Task IDs
Table 3-3 summarizes the EXEC mode commands used to display details about user accounts, user groups, and task IDs.
Table 3-3 Commands to Display Details About Users and User Groups

Command show aaa userdb username show aaa usergroup usergroup-name show task supported

Description Displays the task IDs and privileges assigned to a specific username. To display all users on the system, enter the command without a username. Displays the task IDs and privileges that belong to a user group. To display all groups on the system, enter the command without a group name. Displays all task IDs for the system. Only the root-system users, root-lr users, or users associated with the WRITE:AAA task ID can configure task groups.

Configuring User Accounts


User accounts, user groups, and task groups are created by entering the appropriate commands in one of the AAA configuration submodes, as shown in Figure 3-1. This section describes the process to configure usernames. For instructions to configure user groups, task groups, and other AAA security features, see the Cisco IOS XR System Security Configuration Guide.
Figure 3-1 AAA Configuration Submodes

User login

EXEC mode

Global configuration mode (commands) username username AAA configuration submodes Username configuration submode

usergroup usergroup-name

User group configuration submode

Task group configuration submode

Cisco IOS XR Getting Started Guide

116542

taskgroup taskgroup-name

3-15

Chapter 3 Creating and Modifying User Accounts and User Groups

Configuring Additional Router Features

Creating Users and Assigning Groups


To create a user, assign a password, and assign the user to a group, perform the following procedure:

SUMMARY STEPS
1. 2. 3.

configure username user-name password {0 | 7} password or secret {0 | 5} password group group-name Repeat Step 4 for each user group to be associated with the user specified in Step 2. end or commit

4. 5. 6.

DETAILED STEPS

Command or Action
Step 1

Purpose Enters global configuration mode.

configure
Example:
RP/0/RP0/CPU0:router# configure

Step 2

username user-name
Example:
RP/0/RP0/CPU0:router(config)# username user1

Creates a name for a new user (or identifies a current user) and enters username configuration submode.

The user-name argument can be only one word. Spaces and quotation marks are not allowed. Use the secret command to create a secure login password for the user names specified in Step 2. Entering 0 following the password command specifies that an unencrypted (clear-text) password follows. Entering 7 following the password command specifies that an encrypted password follows. Entering 0 following the secret command specifies that a secure unencrypted (clear-text) password follows. Entering 5 following the secret command specifies that a secure encrypted password follows. Type 0 is the default for the password and secret commands.

Step 3

password {0 | 7} password or secret {0 | 5} password

Specifies a password for the user named in Step 2.


Example:
RP/0/RP0/CPU0:router(config-un)# password 0 pwd1

or
RP/0/RP0/CPU0:router(config-un)# secret 5 pwd1

Cisco IOS XR Getting Started Guide

3-16

Chapter 3

Configuring Additional Router Features Configuration Limiting

Command or Action
Step 4

Purpose Assigns the user named in Step 2 to a user group.

group group-name
Example:
RP/0/RP0/CPU0:router(config-un)# group sysadmin

The user takes on all attributes of the user group, as defined by the user group association to various task groups. Each user must be assigned to at least one user group. A user may belong to multiple user groups.

Step 5 Step 6

Repeat Step 4 for each user group to be associated with the user specified in Step 2. end or commit
Example:
RP/0/RP0/CPU0:router(config-un)# end

Saves configuration changes.

When you issue the end command, the system prompts you to commit changes:
Uncommitted changes found. Commit them?

Entering yes saves configuration changes to the

or
RP/0/RP0/CPU0:router(config-un)# commit

running configuration file, exits the configuration session, and returns the router to EXEC mode.
Entering no exits the configuration session and

returns the router to EXEC mode without committing the configuration changes.

Use the commit command to save the configuration changes to the running configuration file and remain within the configuration session.

Related Documents
For more information on configuration and management of users and user access privileges, see the following Cisco documents: Related Topic Document Title

Create users, assign users to user groups, create and Cisco IOS XR System Security Configuration Guide modify user groups, and configure remote AAA access

Configuration Limiting
The Cisco IOS XR software places preset limits on the configurations you can apply to the running configuration of a router. These limits ensure that the router has sufficient system resources (such as RAM) for normal operations. Under most conditions, these preset limits are sufficient. In some cases, for which a large number of configurations is required for a particular feature, it may be necessary to override the preset configuration limits. This override can be done only if configurations for another feature are low or unused. For example, if a router requires a large number of BGP configurations and Multiprotocol Label Switching (MPLS) is not being used at all, then the BGP limits can be increased to use the unused memory assigned to MPLS.

Caution

Overriding the default configuration limits can result in a low-memory condition.

Cisco IOS XR Getting Started Guide

3-17

Chapter 3 Configuration Limiting

Configuring Additional Router Features

The following sections describe the limits you can configure, default and maximum values, and commands for configuring and displaying the configuration limits:

Static Route Configuration Limits, page 3-18 IS-IS Configuration Limits, page 3-19 OSPFv2 and v3 Configuration Limits, page 3-19 BGP Configuration Limits, page 3-22 Routing Policy Language Line and Policy Limits, page 3-24 Multicast Configuration Limits, page 3-26 MPLS Configuration Limits, page 3-27

Static Route Configuration Limits


Table 3-4 summarizes the maximum limits for static routes, including the commands used to display and change the limits.
Table 3-4 Static Route Configuration Limits and Commands

Default Absolute Maximum Maximum Feature Limit Description Limit Limit Maximum static IPv4 routes Maximum static IPv61 routes 4000 4000 128,000 128,000

Configuration Command (Global Configuration Mode) route maximum ipv4 n route maximum ipv6 n

Show Current Settings Command (EXEC Mode) show running-config route maximum show running-config route maximum

1. IPv6 is not supported on the Cisco XR 12000 Series Router.

Examples
In the following example, the maximum number of static IPv4 routes is changed to 5000. The new setting is then displayed with the show running-config route maximum command.
RP/0/RP1/CPU0:router# configure RP/0/RP1/CPU0:router(config)# route maximum ipv4 5000 RP/0/RP1/CPU0:router(config)# commit RP/0/RP1/CPU0:Mar 30 15:50:38 : ipv4_static[214]: %IP_STATIC-6-CONFIG_MAXIMUM_CH ANGE : The maximum number of configurations for static routes has been changed f rom 4000 to 5000 RP/0/RP1/CPU0:Mar 30 15:50:39 : config[65740]: %LIBTARCFG-6-COMMIT : Configurati on committed by user 'lab'. Use 'show configuration commit changes 1000000538' to view the c hanges. RP/0/RP1/CPU0:router(config)# end RP/0/RP1/CPU0:Mar 30 15:50:46 : config[65740]: %SYS-5-CONFIG_I : Configured from console by lab RP/0/RP1/CPU0:router# show running-config route maximum route maximum ipv4 5000 RP/0/RP1/CPU0:router#

Cisco IOS XR Getting Started Guide

3-18

Chapter 3

Configuring Additional Router Features Configuration Limiting

IS-IS Configuration Limits


Table 3-5 summarizes the maximum limits for IS-IS, including the commands used to display and change the limits.
Table 3-5 IS-IS Configuration Limits and Commands

Default Maximum Feature Limit Description Limit Maximum number of prefixes redistributed into IS-IS 10,000

Absolute Maximum Limit 28,000

Configuration Command (Address Family Configuration Mode)

Show Current Settings Command (EXEC Mode)

maximum-redistributed-prefixes n show isis adjacency

Number of active parallel 8 paths for each route on a Cisco CRS-1 router Number of active parallel 8 paths for each route on a Cisco XR 12000 Series Router

32

maximum-paths n

show isis route

16

maximum-paths n

show isis route

Examples
In the following example, the maximum number of active parallel paths for each route is increased to 10, and the maximum number of prefixes redistributed into IS-IS is increased to 12,000:
RP/0/RP1/CPU0:router# configure RP/0/RP1/CPU0:router(config)# router isis 100 address-family ipv4 RP/0/RP1/CPU0:router(config-isis-af)# maximum-paths 10 RP/0/RP1/CPU0:router(config-isis-af)# maximum-redistributed-prefixes 12000 RP/0/RP1/CPU0:router(config-isis-af)# commit RP/0/RP1/CPU0:Mar 30 14:11:07 : config[65739]: %LIBTARCFG-6-COMMIT : Configurati on committed by user 'lab'. Use 'show configuration commit changes 1000000535' to view the c hanges. RP/0/RP1/CPU0:router(config-isis-af)#

OSPFv2 and v3 Configuration Limits


Table 3-6 summarizes the maximum limits for OSPF, including the commands used to display and change the limits.

Cisco IOS XR Getting Started Guide

3-19

Chapter 3 Configuration Limiting

Configuring Additional Router Features

Table 3-6

OSPFv2 and OSPFv3 Configuration Limits and Commands

Feature Limit Description Maximum number of interfaces that can be configured for an OSPF instance Maximum routes redistributed into OSPF

Default Maximum Limit 255

Absolute Maximum Limit 1024

Configuration Command (Router Configuration Mode) maximum interfaces n

Show Current Settings Command (EXEC Mode) show ospf

10,000

28,672

maximum redistributed-prefix n show ospf


Note

The maximum number of redistributed prefixes is displayed only if redistribution is configured. This command shows only changes to the default value. If the maximum paths command does not appear, the router is set to the default value. This command shows only changes to the default value. If the maximum paths command does not appear, the router is set to the default value.

Maximum number of parallel routes (maximum paths) on Cisco CRS-1s

32 (OSPFv2) 16 (OSPFv3)

32

maximum paths n

show running-config router ospf


Note

Maximum number of 16 parallel routes (maximum paths) on a Cisco XR 12000 Series Router

16

maximum paths n

show running-config router ospf


Note

Examples
The following subsections provide the following examples:

Maximum Interfaces for Each OSPF Instance, page 3-21 Maximum Routes Redistributed into OSPF, page 3-22 Number of Parallel Links (max-paths), page 3-22

Cisco IOS XR Getting Started Guide

3-20

Chapter 3

Configuring Additional Router Features Configuration Limiting

Maximum Interfaces for Each OSPF Instance


In the following example, the show ospf command is used to display the maximum number of OSPF interfaces:
RP/0/RP1/CPU0:router# show ospf Routing Process "ospf 100" with ID 0.0.0.0 Supports only single TOS(TOS0) routes Supports opaque LSA It is an area border router Initial SPF schedule delay 5000 msecs Minimum hold time between two consecutive SPFs 10000 msecs Maximum wait time between two consecutive SPFs 10000 msecs Initial LSA throttle delay 500 msecs Minimum hold time for LSA throttle 5000 msecs Maximum wait time for LSA throttle 5000 msecs Minimum LSA interval 5 secs. Minimum LSA arrival 1 secs Maximum number of configured interfaces 255 --More--

The following example configures the maximum interface limit on a router:


RP/0/RP1/CPU0:router# configure RP/0/RP1/CPU0:router(config)# router ospf 100 RP/0/RP1/CPU0:router(config-router)# maximum interfaces 600 RP/0/RP1/CPU0:router(config-router)# end Uncommitted changes found, commit them? [yes]: y RP/0/RP1/CPU0:Mar 30 16:12:39 : config[65740]: %LIBTARCFG-6-COMMIT : Configurati on committed by user 'lab'. Use 'show configuration commit changes 1000000540' to view the c hanges. RP/0/RP1/CPU0:Mar 30 16:12:39 : config[65740]: %SYS-5-CONFIG_I : Configured from console by lab RP/0/RP1/CPU0:router# show ospf Routing Process "ospf 100" with ID 0.0.0.0 Supports only single TOS(TOS0) routes Supports opaque LSA It is an area border router Initial SPF schedule delay 5000 msecs Minimum hold time between two consecutive SPFs 10000 msecs Maximum wait time between two consecutive SPFs 10000 msecs Initial LSA throttle delay 500 msecs Minimum hold time for LSA throttle 5000 msecs Maximum wait time for LSA throttle 5000 msecs Minimum LSA interval 5 secs. Minimum LSA arrival 1 secs Maximum number of configured interfaces 600 --More--

Cisco IOS XR Getting Started Guide

3-21

Chapter 3 Configuration Limiting

Configuring Additional Router Features

Maximum Routes Redistributed into OSPF


In the following example, the maximum redistributed-prefixes command is used to set the maximum routes redistributed into OSPF:
RP/0/RP1/CPU0:router# configure RP/0/RP1/CPU0:router(config)# router ospf 100 RP/0/RP1/CPU0:router(config-router)# maximum redistributed-prefixes 12000 RP/0/RP1/CPU0:router(config-router)# end Uncommitted changes found, commit them? [yes]: y RP/0/RP1/CPU0:Mar 30 16:26:52 : config[65740]: %LIBTARCFG-6-COMMIT : Configurati on committed by user 'lab'. Use 'show configuration commit changes 1000000541' to view the changes. RP/0/RP1/CPU0:Mar 30 16:26:52 : config[65740]: %SYS-5-CONFIG_I : Configured from console by lab RP/0/RP1/CPU0:router#

Number of Parallel Links (max-paths)


In the following example, the maximum paths command is used to set the maximum number of parallel routes:
RP/0/RP1/CPU0:router# configure RP/0/RP1/CPU0:router(config)# router ospf 100 RP/0/RP1/CPU0:router(config-router)# maximum paths 10 RP/0/RP1/CPU0:router(config-router)# end Uncommitted changes found, commit them? [yes]: y RP/0/RP1/CPU0:Mar 30 18:05:13 : config[65740]: %LIBTARCFG-6-COMMIT : Configurati on committed by user 'lab'. Use 'show configuration commit changes 1000000542' to view the changes. RP/0/RP1/CPU0:Mar 30 18:05:13 : config[65740]: %SYS-5-CONFIG_I : Configured from console by lab RP/0/RP1/CPU0:router#

BGP Configuration Limits


The maximum number of BGP neighbors (peers) that can be configured is 1024. This number cannot be changed through configuration. Any attempt to configure additional neighbors beyond the limit fails. To prevent neighbors (peers) from flooding BGP with advertisements, a limit is placed on the number of prefixes that can be accepted from a peer for each supported address family. You can override the default limits for an address family with the maximum-prefix command. Table 3-7 summarizes the maximum configuration limits for BGP.
Table 3-7 BGP Configuration Limits and Commands

Feature Limit Description Maximum number of neighbors (peers). IPv4 unicast maximum prefixes that can be received from a neighbor

Default Maximum Limit 1024 524,288

Absolute Maximum Limit 1024

Configuration Command (Router Configuration Mode) None. This limit cannot be changed or exceeded.

Show Current Settings Command (EXEC Mode) None show bgp neighbor IP_address

4,294,967, maximum-prefix n 295

Cisco IOS XR Getting Started Guide

3-22

Chapter 3

Configuring Additional Router Features Configuration Limiting

Table 3-7

BGP Configuration Limits and Commands (continued)

Feature Limit Description IPv4 multicast maximum prefixes that can be received from a neighbor IPv61 unicast maximum prefixes that can be received from a neighbor Maximum equal-cost parallel routes to external peers

Default Maximum Limit 131,072

Absolute Maximum Limit

Configuration Command (Router Configuration Mode)

Show Current Settings Command (EXEC Mode) show bgp neighbor IP_address

4,294,967, maximum-prefix n 295 4,294,967, maximum-prefix n 295 8 maximum-paths n

131,072

show bgp neighbor IP_address

show running-config
Note

This command shows only changes to the default value. If the maximum paths command does not appear, the router is set to the default value.

1. IPv6 is not supported on the Cisco XR 12000 Series Router.

Cisco IOS XR Getting Started Guide

3-23

Chapter 3 Configuration Limiting

Configuring Additional Router Features

A cease-notification message is sent to the neighbor and the peering with the neighbor is terminated when the number of prefixes received from the peer for a given address family exceeds the maximum limit (either set by default or configured by the user) for that address family. However, if the warning-only keyword (for the maximum-prefix command) is configured, the Cisco IOS XR software sends only a log message, but continues peering with the sender. If the peer is terminated, the peer stays down until the clear bgp command is issued. The same set of actions (sending cease notification followed by the termination of the peering) is taken for a neighbor with which peering has already been established if you decide to configure a maximum that is less than the number of prefixes that have already been received from the neighbor.

Examples
The following example shows how to set the maximum number of IPv4 unicast prefixes allowed from the neighbor at 10.1.1.1 to 100,000:
RP/0/RP1/CPU0:router# configure RP/0/RP1/CPU0:router(config)# router bgp 100 RP/0/RP1/CPU0:router(config-bgp)# neighbor 10.1.1.1 RP/0/RP1/CPU0:router(config-bgp-nbr)# remote-as 1 RP/0/RP1/CPU0:router(config-bgp-nbr)# address-family ipv4 unicast RP/0/RP1/CPU0:router(config-bgp-nbr-af)# maximum-prefix 100000 RP/0/RP1/CPU0:router(config-bgp-nbr-af)# commit RP/0/RP1/CPU0:Mar 30 19:13:16 : config[65740]: %LIBTARCFG-6-COMMIT : Configurati on committed by user 'lab'. Use 'show configuration commit changes 1000000544' to view the c hanges. RP/0/RP1/CPU0:Mar 30 19:13:17 : config[65740]: %SYS-5-CONFIG_I : Configured from console by lab RP/0/RP1/CPU0:router(config-bgp-nbr-af)#

Routing Policy Language Line and Policy Limits


Two limits for Routing Policy Language (RPL) configurations exist:
1. 2.

Lines of configuration: The number of lines entered by the user, including the beginning and ending statements (that is route-policy). The lines of configuration for sets are also included. Number of RPL policies: The number of policies that can be configured on the router. Policies are counted only once: Multiple use of the same policy counts as a single policy toward the limit 1.

The limits for RPL lines and policies are summarized in Table 3-8. You can change the default values up to the absolute maximum, but you cannot change the value to a number less than the number of items that are currently configured.
Table 3-8 Maximum Lines of RPL: Configuration Limits and Commands

Limit Description Maximum number of RPL lines Maximum number of RPL policies

Default Maximum Limit 65,536 3500

Absolute Maximum Limit 131,072 5000

Show Current Settings Configuration Command Command (Global Configuration Mode) (EXEC Mode) rpl maximum lines n rpl maximum policies n show rpl maximum lines show rpl max policies

Cisco IOS XR Getting Started Guide

3-24

Chapter 3

Configuring Additional Router Features Configuration Limiting

Examples
In the following example, the show rpl maximum command is used in EXEC mode to display the current setting for RPL limits and number of each limit currently in use. A summary of the memory used by all of the defined policies is also shown below the limit settings.
RP/0/RP1/CPU0:router# show rpl maximum Current Current Max Total Limit Limit -----------------------------------------------------------Lines of configuration 0 65536 131072 Policies 0 3500 5000 Compiled policies size (kB) 0 RP/0/RP1/CPU0:router#

In the next example, the rpl maximum command changes the currently configured line and policy limits. The show rpl maximum command displays the new settings.
RP/0/RP1/CPU0:router# configure RP/0/RP1/CPU0:router(config)# rpl maximum policies 4000 RP/0/RP1/CPU0:router(config)# rpl maximum lines 80000 RP/0/RP1/CPU0:router(config)# commit RP/0/RP1/CPU0:Apr 1 00:23:44.062 : config[65709]: %LIBTARCFG-6-COMMIT : Configu ration committed by user 'UNKNOWN'. Use 'show configuration commit changes 1000000010' to vi ew the changes. RP/0/RP1/CPU0:router(config)# exit RP/0/RP1/CPU0:Apr 1 00:23:47.781 : config[65709]: %SYS-5-CONFIG_I : Configured from console by console RP/0/RP1/CPU0:router# show rpl maximum Current Current Max Total Limit Limit -----------------------------------------------------------Lines of configuration 0 80000 131072 Policies 0 4000 5000 Compiled policies size (kB) 0 RP/0/RP1/CPU0:router#

Cisco IOS XR Getting Started Guide

3-25

Chapter 3 Configuration Limiting

Configuring Additional Router Features

Multicast Configuration Limits


Table 3-9 summarizes the maximum limits for multicast configuration, including the commands used to display and change the limits.
Table 3-9 Multicast Configuration Limits and Commands

Default Maximum Feature Limit Description Limit Maximum number of groups used by IGMP and accepted by a router 50,000

Absolute Maximum Limit 75,000

Configuration Command (Global Configuration Mode) maximum groups n

Show Current Settings Command (EXEC Mode) show igmp summary

Internet Group Management Protocol (IGMP) Limits

Maximum number of 20,000 groups for each interface accepted by a router Maximum MSDP Source 20,000 Active (SA) entries Maximum MSDP SA entries that can be learned from MSDP peers Maximum PIM routes supported Maximum PIM egress states Maximum PIM registers Maximum number of PIM group map ranges learned from Auto-RP 20,000

40,000

maximum groups per-interface n

show igmp summary

Multicast Source Discovery Protocol (MSDP) Limits

75,000 75,000

maximum external-sa n maximum peer-external-sa n

show msdp summary show msdp summary

Protocol Independent Multicast (PIM) Limits

100,000 300,000 20,000 500

200,000 600,000 75,000 5000

maximum routes n maximum route-interfaces n maximum register-states n maximum group-mappings autorp n

show pim summary show pim summary show pim summary show pim summary

Cisco IOS XR Getting Started Guide

3-26

Chapter 3

Configuring Additional Router Features Configuration Limiting

MPLS Configuration Limits


Table 3-10 summarizes the maximum limits for MPLS configuration, including the commands used to display and change the limits.
Table 3-10 MPLS Configuration Limits and Commands

Limit Description Maximum traffic engineer (TE) tunnels head

Default Maximum Limit 2500

Absolute Maximum Limit 4000

Show Current Settings Configuration Command Command (Global Configuration Mode) (EXEC Mode) mpls traffic-eng maximum show mpls traffic-eng tunnels n maximum tunnels

Other Configuration Limits


Table 3-11 summarizes the maximum limits for additional configuration limits, including the commands used to display and change the limits.
Table 3-11 Additional Configuration Limits and Commands

Limit Description IPv4 ACL (access list and prefix list) IPv4 ACE (access list and prefix list) IPv61 ACL (access list and prefix list) IPv61 ACE (access list and prefix list)

Default Maximum Limit 5000 200,000 1000 50,000

Absolute Maximum Limit 9000 350,000 2000 100,000

Show Current Settings Configuration Command Command (Global Configuration Mode) (EXEC Mode) ipv4 access-list oor acl threshold n ipv4 access-list oor ace threshold n ipv6 access-list oor acl threshold n ipv6 access-list oor ace threshold n show ipv4 access-lists show ipv4 access-lists show ipv4 access-lists show ipv4 access-lists

1. IPv6 is not supported on the Cisco XR 12000 Series Router.

Cisco IOS XR Getting Started Guide

3-27

Chapter 3 Configuration Limiting

Configuring Additional Router Features

Cisco IOS XR Getting Started Guide

3-28

C H A P T E R

CLI Tips, Techniques, and Shortcuts


This chapter describes techniques for using the command-line interface (CLI) of the Cisco IOS XR software.

Contents
The chapter contains the following sections:

CLI Tips and Shortcuts, page 4-1 Displaying System Information with show Commands, page 4-5 Wildcards, Templates, and Aliases, page 4-10 Command History, page 4-17 Key Combinations, page 4-18

Note

Commands can be entered in uppercase, lowercase, or mixed case. Only passwords are case sensitive. However, the Cisco Systems documentation convention presents commands in lowercase.

CLI Tips and Shortcuts


The following sections describe tips and shortcuts useful when using the CLI:

Entering Abbreviated Commands, page 4-2 Using the Question Mark (?) to Display On-Screen Command Help, page 4-2 Completing a Partial Command with the Tab Key, page 4-4 Identifying Command Syntax Errors, page 4-4 Using the no Form of a Command, page 4-4 Editing Command Lines that Wrap, page 4-5

Cisco IOS XR Getting Started Guide

4-1

Chapter 4 CLI Tips and Shortcuts

CLI Tips, Techniques, and Shortcuts

Entering Abbreviated Commands


You can abbreviate commands and keywords to the number of characters that allow a unique abbreviation. For example, the configure command can be abbreviated as config because the abbreviated form of the command is unique. The router accepts and executes the abbreviated command.

Using the Question Mark (?) to Display On-Screen Command Help


Use the question mark (?) to learn what commands are available and the correct syntax for a command. Table 4-1 summarizes the options for on-screen help.

Tip

The space (or lack of a space) before the question mark ( ?) is significant. If you include a space before the question mark, the system displays all available options for a command or CLI mode. If you do not include a space, the system displays a list of commands that begin with a particular character string.

Table 4-1

On-Screen Help Commands

Command partial-command?

Description Enter a question mark (?) at the end of a partial command to list the commands that begin with those characters.
RP/0/RP0/CPU0:router# co? configure copy

Note

Do not include a space between the command and question mark.

? command ?

Lists all commands available for a particular command mode. Include a space before the question mark (?) to list the keywords and arguments that belong to a command.
RP/0/RP0/CPU0:router# configure ? exclusive memory network overwrite-network terminal <cr> Configure Configure Configure Overwrite Configure exclusively from this terminal from NV memory from TFTP network host NV memory from TFTP network host from the terminal

Note

For most commands, the <cr> symbol indicates that you can execute the command with the syntax already entered. For the preceding example, press Return to enter global configuration mode.

command keyword ? Enter a question mark (?) after the keyword to list the next available syntax option for the command.
RP/0/RP0/CPU0:router# show aaa ? taskgroup userdb usergroup Show all the local taskgroups configured in the system Show all local users with the usergroups each belong to Show all the local usergroups configured in the system

Note

Include a space between the keyword and question mark.

Cisco IOS XR Getting Started Guide

4-2

Chapter 4

CLI Tips, Techniques, and Shortcuts CLI Tips and Shortcuts

The following example shows how to add an entry to access list 99. The added entry denies access to all hosts on subnet 172.0.0.0 and ignores bits for IPv4 addresses that start within the range of 0 to 255. The following steps provide an example of on-screen command help:
Step 1

Enter the access-list command, followed by a space and a question mark, to list the available options for the command:
RP/0/RP0/CPU0:router(config)# access-list ? <1-199> <1300-2699> IP Access list IP Access list

Note Step 2

The number ranges (within the angle brackets) are inclusive ranges. Enter the access list number 99, followed by a space and another question mark, to display the arguments that apply to the keyword and brief explanations:
RP/0/RP0/CPU0:router(config)# access-list 99 ? <1-2147483647> Sequence number for this entry deny Specifies packets to reject permit Specifies packets to forward remark Comment for access list <cr> RP/0/RP0/CPU0:router(config)# access-list 99 deny ? A.B.C.D Address to match

Step 3

Generally, uppercase letters represent variables (arguments). Enter the IP address, followed by a space and a question mark (?), to list additional options:
RP/0/RP0/CPU0:router(config)# access-list 99 deny 172.31.134.0 ? A.B.C.D Mask of bits to ignore <cr>

In this output, A.B.C.D indicates that use of a mask is allowed. The mask is a method for matching IP addresses or ranges of IP addresses. For example, a mask of 255.0.0.0 matches any number in the range from 0 to 255 that appears in the first octet of an IP address. Enter the mask, followed by a space and a question mark (?), to list further options.
RP/0/RP0/CPU0:router(config)# access-list 99 deny 172.31.134.0 255.0.0.0 ? <cr>

Step 4

The <cr> symbol by itself indicates that there are no more keywords or arguments. Press Return to execute the command:
RP/0/RP0/CPU0:router(config)# access-list 99 deny 172.31.134.0 255.0.0.0

Note

The configuration does not become active until you enter the commit command to add the target configuration to the running configuration.

Cisco IOS XR Getting Started Guide

4-3

Chapter 4 CLI Tips and Shortcuts

CLI Tips, Techniques, and Shortcuts

Completing a Partial Command with the Tab Key


If you cannot remember a complete command name or want to reduce the amount of typing you have to perform, enter the first few letters of the command, then press the Tab key. If only one command begins with that character string, the system completes the command for you. If the characters you entered indicate more than one command, the system beeps to indicate that the text string is not unique and the system provides a list of commands that match the text entered. In the following example, the CLI recognizes conf as a unique string in EXEC mode and completes the command when Tab is pressed:
RP/0/RP0/CPU0:router# conf<Tab> RP/0/RP0/CPU0:router# configure

The CLI displays the full command name. You must then press Return to execute the command. This feature allows you to modify or reject the suggested command. In the next example, the CLI recognizes two commands that match the text entered:
RP/0/RP1/CPU0:router#co<Tab> configure copy RP/0/RP1/CPU0:router#con<Tab> RP/0/RP1/CPU0:router#configure

Tip

If your keyboard does not have a Tab key, press Ctrl-I instead.

Identifying Command Syntax Errors


If an incorrect command is entered, an error message is returned with the caret (^) at the point of the error. In the following example, the caret appears where the character was typed incorrectly in the command:
RP/0/0/CPU0:router# configure termiMal ^ % Invalid input detected at '^' marker.

Note

The percent sign (%) indicates the line in which the error message occurred. To display the correct command syntax, enter the ? after the command:
RP/0/0/CPU0:router# configure ? exclusive Configure exclusively from this terminal terminal Configure from the terminal <cr>

Using the no Form of a Command


Almost every configuration command has a no form. Depending on the command, the no form may enable or disable a feature. For example, when configuring an interface, the no shutdown command brings up the interface, and the shutdown command shuts down the interface. The route ipv4 command creates a static route, and the no route ipv4 command deletes a route when entered with the same parameters as an existing route.

Cisco IOS XR Getting Started Guide

4-4

Chapter 4

CLI Tips, Techniques, and Shortcuts Displaying System Information with show Commands

The Cisco IOS XR software command reference publications provide the complete syntax for the configuration commands and describe what the no form of a command does. See the Related Documents section on page xv for more information.

Editing Command Lines that Wrap


The CLI provides a wraparound feature for commands that extend beyond a single line on the screen. When the cursor reaches the right margin, the command line shifts ten spaces to the left. The first ten characters of the line are not shown, but it is possible to scroll back and check the syntax at the beginning of the command. To scroll back, press Ctrl-B or the left arrow key repeatedly, or press Ctrl-A to return directly to the beginning of the line. In the following example, the ipv4 access-list command entry is too long to display on one line. When the cursor reaches the end of the line, the line is shifted to the left and redisplayed. The dollar sign ($) after the command prompt indicates that the line has been scrolled to the left and the beginning of the command is hidden.
RP/0/0/CPU0:router(config)# $s-list 101 permit tcp 172.31.134.5 255.255.255.0 172.31.135.0

In the next example, Ctrl-A is used to display the beginning of the command line, and the dollar sign at the end of the command line shows the command has been scrolled to the right and the end of the command is hidden.
RP/0/0/CPU0:router(config)# ipv4 access-list 101 permit tcp 172.31.134.5 255.255.255.0 17$

In the next example, the right arrow key has been used to scroll to the right. Notice that dollar sign symbols appear at both ends of the line, which indicates that command information is hidden from the beginning and end of the command.
RP/0/0/CPU0:router(config)# $ccess-list 101 permit tcp 172.31.134.5 255.255.255.0 172.31.$

By default, the Cisco IOS XR software uses a terminal screen 80 columns wide. To adjust for a different screen width, use the terminal width command in EXEC mode. Use line wrapping with the command history feature to recall and modify previous complex command entries.

Displaying System Information with show Commands


The show commands display information about the system and its configuration. The following sections describe some common show commands and provide techniques to manage the output from those commands:

Common show Commands, page 4-6 Browsing Display Output when the --More-- Prompt Appears, page 4-6 Halting the Display of Screen Output, page 4-7 Redirecting Output to a File, page 4-7 Narrowing Output from Large Configurations, page 4-8 Filtering show Command Output, page 4-9

Cisco IOS XR Getting Started Guide

4-5

Chapter 4 Displaying System Information with show Commands

CLI Tips, Techniques, and Shortcuts

Common show Commands


Some of the most common show commands are described in Table 4-2.
Table 4-2 Common show Commands in Cisco IOS XR Software

Command show version show configuration

Description Displays system information. Displays the uncommitted configuration changes made during a configuration session. Displays the current running configuration.

Command Mode EXEC mode EXEC or any configuration mode EXEC or any configuration mode

show running-config [command]

show tech-support

Collects a large amount of system information for EXEC mode troubleshooting. You can provide this output to technical support representatives when reporting a problem. Displays information about the router. EXEC mode EXEC mode

show platform

show environment [all | fans | leds | Displays hardware information for the system, including fans, power-supply | table | temperatures LEDs, power supply voltage and current, and temperatures. | voltages | l]

For more information on the use of these commands, see the Related Documents section on page xv.

Browsing Display Output when the --More-- Prompt Appears


When command output requires more than one screen, such as for the ?, show, or more command, the output is presented one screen at a time, and a --More-- prompt is displayed at the bottom of the screen. To display additional command output, do one of the following:

Press Return to display the next line. Press the space bar to display the next screen of output.

The following example shows one screen of data and the --More-- prompt:
RP/0/RP0/CPU0:router# show ? aaa adjacency aliases alphadisplay aps arm arp as-path-access-list asic-errors atc auto-rp bgp buffer-manager bundle calendar Show AAA configuration and operational data Adjacency information Display alias commands Shows the message being displayed on the alpha display SONET APS information IP ARM information ARP table List AS path access lists ASIC error information Attractor Cache related Auto-RP Commands BGP show commands Show all buffer manager memory related information Show hardware related information for Bundles. Display the system calendar

Cisco IOS XR Getting Started Guide

4-6

Chapter 4

CLI Tips, Techniques, and Shortcuts Displaying System Information with show Commands

cdp cef cetftp checkpoint cinetd clns clock commit --More--

CDP information Cisco Express Forwarding HFR control plane ethernet TFTP server Show checkpoint services cinetd daemon Display CLNS related information Display the system clock Show commit information

Tips

If you do not see the --More-- prompt, try entering a value for the screen length with the terminal length command in EXEC mode. Command output is not paused if the length value is set to zero. The following example shows how to set the terminal length:
RP/0/RP1/CPU0:router# terminal length 20

For information on searching or filtering CLI output, see the Filtering show Command Output section on page 4-9.

Halting the Display of Screen Output


To interrupt screen output and terminate a display, press Ctrl-C, as shown in the following example:
RP/0/RP0/CPU0:router# show running-config <Ctrl-C>

Redirecting Output to a File


By default, CLI command output is displayed on screen. CLI command output can be redirected to a user-specified file by entering a filename and location after the show command syntax. The following command syntax is used to redirect output to a file:
show

command | file filename

This feature enables you to save any show command output in a file for further analysis and reference. When you choose to redirect command output, consider the following guidelines:

If the full path of the file is not specified, the default directory for your account is used. You should always save your target configuration files to this location. If the saved output is to be used as a configuration file, the filename should end with the .cfg suffix for easy identification. This suffix is not required, but can help locate target configuration files. Example: myconfig.cfg

In the following example, a target configuration file is saved to the default user directory:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# show configure | file disk0:myconfig.cfg RP/0/RP0/CPU0:router(config)# abort RP/0/RP0/CPU0:router#

Cisco IOS XR Getting Started Guide

4-7

Chapter 4 Displaying System Information with show Commands

CLI Tips, Techniques, and Shortcuts

Narrowing Output from Large Configurations


Displaying a large running configuration can produce thousands of lines of output. To limit the output of a show command to only the items you want to view, enter an additional argument at the end of the show running-config command. You can also use a wildcard to display all instances for a feature.

Limiting show Command Output to a Specific Feature or Interface


Entering keywords and arguments in the show command limits the show output to a specific feature or interface. In the following example, only information about the IP route configuration is displayed:
RP/0/RP0/CPU0:router# show running-config route ipv4 route ipv4 0.0.0.0/0 10.21.0.1 route ipv4 0.0.0.0/0 pos0/1/0/1 10.21.0.1

In the following example, the configuration for a specific interface is displayed:


RP/0/RP0/CPU0:router# show running-config interface POS 0/1/0/1 interface pos0/1/0/1 ipv4 address 10.21.54.31 255.255.0.0 ip proxy-arp disable!

Using Wildcards to Display All Instances of an Interface


To display the configuration for all instances, enter the asterisk (*) wildcard character.

Note

See the Using Wildcards to Identify Interfaces in show Commands section on page 4-11 for more information. In the following example, a configuration for all Packet-over-SONET (PoS) interfaces is displayed:
RP/0/RP1/CPU0:router# show running-config interface pos * interface POS0/1/0/0 ipv4 address 10.2.3.4 255.255.255.0 pos crc 32 ! shutdown keepalive disable ! interface POS0/1/0/1 ipv4 address 10.2.3.5 255.255.255.0 pos crc 32 ! shutdown keepalive disable !

Cisco IOS XR Getting Started Guide

4-8

Chapter 4

CLI Tips, Techniques, and Shortcuts Displaying System Information with show Commands

interface POS0/1/0/2 ipv4 address 10.2.3.6 255.255.255.0 pos crc 32 ! shutdown keepalive disable ! interface POS0/1/0/3 ipv4 address 10.2.3.7 255.255.255.0 pos crc 32 ! shutdown keepalive disable ! --More--

Filtering show Command Output


Output from the show commands can generate a large amount of data. To display only a subset of information, enter the pipe character (|) followed by a keyword (begin, include, or exclude) and a regular expression. Table 4-3 shows the filtering options for the show command.
Table 4-3 show Command Filter Options

Command
show command | begin regular-expression

Description Begins unfiltered output of the show command with the first line that contains the regular expression. Displays output lines that do not contain the regular expression. Displays output lines that contain the regular expression. Writes the output lines that contain the regular expression to the specified file on the specified device.

show command | exclude regular-expression show command | include regular-expression show command | file disk0:myconfigfile

In the following example, the show interface command includes only lines in which the expression protocol appears:
RP/0/RP0/CPU0:router# show interface | include protocol Null0 is up, line protocol is up 0 drops for unrecognized upper-level protocol POS0/2/0/0 is administratively down, line protocol 0 drops for unrecognized upper-level protocol POS0/2/0/1 is administratively down, line protocol 0 drops for unrecognized upper-level protocol POS0/2/0/2 is administratively down, line protocol 0 drops for unrecognized upper-level protocol POS0/2/0/3 is administratively down, line protocol 0 drops for unrecognized upper-level protocol MgmtEthernet0/RP0/CPU0/0 is administratively down, down MgmtEthernet0/RP0/CPU0/0 is administratively down, down 0 drops for unrecognized upper-level protocol

is administratively down is administratively down is administratively down is administratively down line protocol is administratively line protocol is administratively

Cisco IOS XR Getting Started Guide

4-9

Chapter 4 Wildcards, Templates, and Aliases

CLI Tips, Techniques, and Shortcuts

Note

Filtering is available for submodes, complete commands, and anywhere that <cr> appears in the ? output.

Adding a Filter at the --More-- Prompt


You can specify a filter at the --More-- prompt of a show command output by entering a forward slash (/) followed by a regular expression. The filter remains active until the command output finishes or is interrupted (using Ctrl-Z or Ctrl-C). The following rules apply to this technique:

If a filter is specified at the original command or previous --More-- prompt, a second filter cannot be applied. The use of the keyword begin does not constitute a filter. The minus sign () preceding a regular expression displays output lines that do not contain the regular expression. The plus sign (+) preceding a regular expression displays output lines that contain the regular expression.

In the following example, the user adds a filter at the --More-- prompt to show only the lines in the remaining output that contain the regular expression ip.
RP/0/RP0/CPU0:router# show configuration running | begin line Building configuration... line console exec-timeout 120 120 ! logging trap --More-/ip filtering... ip route 0.0.0.0 255.255.0.0 pos0/2/0/0 interface pos0/2/0/0 ip address 172.19.73.215 255.255.0.0 end

Tip

On most systems, Ctrl-Z can be entered at any time to interrupt the output and return to EXEC mode. For more information, see Appendix D, Understanding Regular Expressions, Special Characters, and Patterns.

Wildcards, Templates, and Aliases


This section contains the following topics:

Using Wildcards to Identify Interfaces in show Commands, page 4-11 Creating Configuration Templates, page 4-12 Aliases, page 4-16 Keystrokes Used as Command Aliases, page 4-17

Cisco IOS XR Getting Started Guide

4-10

Chapter 4

CLI Tips, Techniques, and Shortcuts Wildcards, Templates, and Aliases

Using Wildcards to Identify Interfaces in show Commands


Wildcards (*) identify a group of interfaces in show commands. Table 4-4 provides examples of wildcard usage to identify a group of interfaces.
Table 4-4 Examples of Wildcard Usage

Wildcard Syntax * pos* pos0/1/* pos0/3/4.*

Description Specifies all interfaces Specifies all POS interfaces in the system Specifies all POS interfaces in rack 0, slot 1 Specifies all subinterfaces for POS0/3/4

Note

The wildcard (*) must be the last character in the interface name.

Example
In the following example, the configuration for all POS interfaces in rack 0, slot 1 is displayed:
RP/0/RP1/CPU0:router# show running-config interface pos0/1/* interface POS0/1/0/0 ipv4 address 10.2.3.4 pos crc 32 ! keepalive disable interface POS0/1/0/1 ipv4 address 10.2.3.5 pos crc 32 ! keepalive disable interface POS0/1/0/2 ipv4 address 10.2.3.6 pos crc 32 ! keepalive disable interface POS0/1/0/3 ipv4 address 10.2.3.7 pos crc 32 ! keepalive disable --More--

255.255.255.0

255.255.255.0

255.255.255.0

255.255.255.0

Cisco IOS XR Getting Started Guide

4-11

Chapter 4 Wildcards, Templates, and Aliases

CLI Tips, Techniques, and Shortcuts

In the following example, the state of all POS interfaces is displayed:


RP/0/RP1/CPU0:router# show interfaces pos* brief Intf Intf LineP Encap MTU BW Name State State Type (byte) (Kbps) -------------------------------------------------------------------------------PO0/1/0/0 up up HDLC 4474 2488320 PO0/1/0/1 up up HDLC 4474 2488320 PO0/1/0/2 up up HDLC 4474 2488320 PO0/1/0/3 up up HDLC 4474 2488320 PO0/1/0/4 up up HDLC 4474 2488320 PO0/1/0/5 up up HDLC 4474 2488320 PO0/1/0/6 up up HDLC 4474 2488320 PO0/1/0/7 up up HDLC 4474 2488320 PO0/1/0/8 up up HDLC 4474 2488320 PO0/1/0/9 up up HDLC 4474 2488320 PO0/1/0/10 up up HDLC 4474 2488320 PO0/1/0/11 up up HDLC 4474 2488320 PO0/1/0/12 up up HDLC 4474 2488320 PO0/1/0/13 up up HDLC 4474 2488320 PO0/1/0/14 up up HDLC 4474 2488320 PO0/1/0/15 up up HDLC 4474 2488320

Creating Configuration Templates


Configuration templates allow you to create a name that represents a group of configuration commands. After a template is defined, it can be applied to interfaces by you or other users. As networks scale to large numbers of nodes and ports, the ability to configure multiple ports quickly using templates can greatly reduce the time it takes to configure interfaces. The two primary steps in working with templates are creating templates and applying templates. The following procedure describes how to create a configuration template.

SUMMARY STEPS
1. 2. 3. 4. 5. 6.

configure template template-name [parameter] [config-commands] Enter the template definitions. end-template show running-config template template-name Apply the template.
a. configure b. apply-template template-name [parameter] c. show running-config

Cisco IOS XR Getting Started Guide

4-12

Chapter 4

CLI Tips, Techniques, and Shortcuts Wildcards, Templates, and Aliases

DETAILED STEPS

Command or Action
Step 1

Purpose Enters global configuration mode.

configure
Example:
Router# configure

Step 2

template template-name [parameter] [config-commands]


Example:
RP/0/RP0/CPU0:router(config)# template tmplt_1

Enters template configuration mode and creates a template.


template-name: Unique name for the template to be applied to the running configuration. parameter: (Optional) Actual values of the variables specified in the template definition. Up to five parameters can be specified within parentheses. Templates can be created with or without parameters. config-commands: (Optional) Global configuration commands to be added to the template definition. Any name in a command (such as the server name, group name, and so on) can be parameterized. This means that those parameters can be used in the template commands (starting with $) and replaced with real arguments when applied. To remove the template, use the no form of this command. Type the template command in global configuration mode.

Step 3

Enter the template definitions.


Example:
RP/0/RP0/CPU0:router(config-TPL)# interface pos0/2/0/4 RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.0.0.1 RP/0/RP0/CPU0:router(config-if)# exit

Step 4

end-template
Example:
RP/0/RP0/CPU0:router(config-TPL)# end-template

Ends the template definition session and exits template configuration mode.

When you end the template session, you are returned to global configuration mode.

Cisco IOS XR Getting Started Guide

4-13

Chapter 4 Wildcards, Templates, and Aliases

CLI Tips, Techniques, and Shortcuts

Command or Action
Step 5

Purpose Displays the details of the template.

show running-config template template-name


Example:
RP/0/RP0/CPU0:router# show running-config template tmplt_1

Step 6

Apply the template:


a. configure b. apply-template template-name [parameter] c. show running-config

Applies a defined template and its parameters to the running configuration of the system.

Type this command in global configuration mode. Only one template can by applied at a time. If the same template is applied multiple times, the most recent application overwrites the previous ones. Provide the exact number of parameters for the template. Templates are applied as a best effort operation; only valid changes are committed. If any command in the template fails, that command is discarded. To remove the template, use the no form of this command.

Example:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# apply-template tmplt_1 RP/0/RP0/CPU0:router(config)# commit RP/0/RP0/CPU0:router(config)# show running-config ... template tmplt_1 interface POS0/2/0/4 ipv4 address 10.0.0.1 255.255.255.0 ! end-template .. interface POS0/2/0/4 ipv4 address 10.0.0.1 255.255.255.0 !

RP/0/RP0/CPU0:router(config)# exit

Applying Configuration Templates


To apply a template, enter the apply-template template-name [parameter] command in global configuration mode. The following command applies the template tmplt_1:
RP/0/RP0/CPU0:router(config)# apply-template tmplt_1

The following apply command applies the template bar with two arguments:
RP/0/RP0/CPU0:router(config)# apply-template bar (mibtwister %wd_default_mem.tcl)

Cisco IOS XR Getting Started Guide

4-14

Chapter 4

CLI Tips, Techniques, and Shortcuts Wildcards, Templates, and Aliases

To display the results of the previously applied templates, enter the show running-config command:
RP/0/RP0/CPU0:router# show running-config hostname mibtwister #new hostname set by apply bar template bar (abc cde ) hostname $abc fault manager policy %wd_default_cpu.tcl system fault manager policy $cde system logging trap logging trap informational logging console debugging logging history size 1 logging history warnings logging monitor debugging logging buffered 16384 end-template template tmplt_1 interface preconfigure pos0/1/0/2 ipv4 address 10.2.3.4 255.255.255.0 ! end-template . . . fault manager policy %wd_default_cpu.tcl system fault manager policy %wd_default_mem.tcl system # substituted logging trap logging trap informational logging console debugging logging history size 1 logging history warnings logging monitor debugging logging buffered 16384 . . . interface preconfigure pos0/1/0/2 # set by apply tmplt_1 ipv4 address 10.2.3.4 255.255.255.0 ! . . .

Examples
In the following example, a simple template is defined. The template contents are then displayed with the show running-config template template-name command:
RP/0/RP0/CPU0:router(config)# template tmplt_1 RP/0/RP0/CPU0:router(config-TPL)# interface pos0/2/0/4 RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.2.3.4 255.255.255.0 RP/0/RP0/CPU0:router(config-if)# exit RP/0/RP0/CPU0:router(config-TPL)# end-template RP/0/RP0/CPU0:router(config)# exit RP/0/RP0/CPU0:router# show running-config template tmplt_1 interface pos0/2/0/4 ipv4 address 10.2.3.4 255.255.255.0 ! end-template interface pos0/2/0/4 ipv4 address 10.2.3.4 255.255.0.0

Cisco IOS XR Getting Started Guide

4-15

Chapter 4 Wildcards, Templates, and Aliases

CLI Tips, Techniques, and Shortcuts

In the following example, a template named bar with two parameters is defined:
RP/0/RP0/CPU0:router(config)# template bar (abc cde) RP/0/RP0/CPU0:router(config-TPL)# hostname $abc RP/0/RP0/CPU0:router(config-TPL)# fault manager policy %wd_default_cpu.tcl system RP/0/RP0/CPU0:router(config-TPL)# fault manager policy $cde system RP/0/RP0/CPU0:router(config-TPL)# logging trap RP/0/RP0/CPU0:router(config-TPL)# logging trap informational RP/0/RP0/CPU0:router(config-TPL)# logging console debugging RP/0/RP0/CPU0:router(config-TPL)# logging history size 1 RP/0/RP0/CPU0:router(config-TPL)# logging history warnings RP/0/RP0/CPU0:router(config-TPL)# logging monitor debugging RP/0/RP0/CPU0:router(config-TPL)# logging buffered 16384 RP/0/RP0/CPU0:router(config-TPL)# end-template RP/0/RP0/CPU0:router(config)# exit RP/0/RP0/CPU0:router#show running-config template bar template bar (abc cde) hostname $abc fault manager policy %wd_default_cpu.tcl system fault manager policy $cde system logging trap logging trap informational logging console debugging logging history size 1 logging history warnings logging monitor debugging logging buffered 16384 end-template

Note

Configuration commands in the template body can have variables beginning with the dollar sign ($). When the template is applied, variables beginning with $ can be substituted by real arguments.

Aliases
Cisco IOS XR software lets you define command line aliases for any physical or logical entity in a router. After you define the alias, it can be used in the CLI to reference the real entity. To create a command alias, enter the following command in global configuration mode: alias alias-name command-syntax Table 4-5 defines the alias command syntax.
Table 4-5 alias Command Syntax

Syntax alias-name command-syntax

Specifies that the Alias Is Created for Name of the command alias. An alias name can be a single word or multiple words joined by a dash (). Original command syntax. Valid abbreviations of the original command syntax can be entered for the command-syntax argument.

To delete all aliases in a command mode or a specific alias, enter the no form of the alias command.

Cisco IOS XR Getting Started Guide

4-16

Chapter 4

CLI Tips, Techniques, and Shortcuts Command History

In the following example, an alias named my-cookie is created for the Management Ethernet interface, and then the new alias is specified to enter interface configuration mode:
RP/0/0/CPU0:router(config)#alias my-cookie mgmtEth 0/0/CPU0/0

RP/0/0/CPU0:router(config) #interface my-cookie <cr> RP/0/0/CPU0:router(config) #interface mgmtEth 0/0/CPU0/0 RP/0/0/CPU0:router(config-if) #

After you enter a command with an alias, the router displays the command you entered with the alias value so that you can verify that alias value.

Keystrokes Used as Command Aliases


The system can be configured to recognize particular keystrokes (key combination or sequence) as command aliases. In other words, a keystroke can be set as a shortcut for executing a command. To enable the system to interpret a keystroke as a command, use the Ctrl-V or Esc, Q key combinations before entering the command sequence.

Command History
The Cisco IOS XR software lets you display a history of the most recently entered and deleted commands. You can also redisplay the command line while a console message is being shown. The following sections describe the command history functionality:

Recalling Previously Entered Commands, page 4-17 Recalling Deleted Entries, page 4-18 Redisplaying the Command Line, page 4-18

Note

To roll back to a previously committed configuration, see the Managing Configuration History and Rollback section on page 3-3.

Recalling Previously Entered Commands


The Cisco IOS XR software records the ten most recent commands issued from the command line in its history buffer. This feature is particularly useful for recalling long or complex commands or entries, including access lists. To recall commands from the history buffer, use one of the commands or key combinations listed in Table 4-6.

Cisco IOS XR Getting Started Guide

4-17

Chapter 4 Key Combinations

CLI Tips, Techniques, and Shortcuts

Table 4-6

Command History

Command or Key Combination Ctrl-P or the up arrow key Ctrl-N or the down arrow key

Purpose Recalls commands in the history buffer, beginning with the most recent command. Repeat the key sequence to recall successively older commands. Returns to more recent commands in the history buffer after recalling commands with Ctrl-P or the up arrow key. Repeat the key sequence to recall successively more recent commands.

Note

Use the terminal history command to set the number of command line entries the system holds for recall during a terminal session.

Recalling Deleted Entries


The Cisco IOS XR CLI also stores deleted commands or keywords in a history buffer. The buffer stores the last ten items that have been deleted using Ctrl-K, Ctrl-U, or Ctrl-X. Individual characters deleted using Backspace or Ctrl-D are not stored. Table 4-7 identifies the keystroke combinations used to recall deleted entries to the command line.
Table 4-7 Keystroke Combinations to Recall Deleted Entries

Command or Key Combination Ctrl-Y Esc, Y

Recalls the Most recent entry in the buffer (press the keys simultaneously). Previous entry in the history buffer (press the keys sequentially).

Note

The Esc, Y key sequence does not function unless the Ctrl-Y key combination is pressed first. If the Esc, Y is pressed more than ten times, the history cycles back to the most recent entry in the buffer.

Redisplaying the Command Line


If the system sends a message to the screen while a command is being entered, the current command line entry can be redisplayed using the Ctrl-L or Ctrl-R key combination.

Key Combinations
The following sections provide information on key combinations:

Key Combinations to Move the Cursor, page 4-19 Keystrokes to Control Capitalization, page 4-19 Keystrokes to Delete CLI Entries, page 4-20

Cisco IOS XR Getting Started Guide

4-18

Chapter 4

CLI Tips, Techniques, and Shortcuts Key Combinations

Key Combinations to Move the Cursor


Table 4-8 shows the key combinations or sequences you can use to move the cursor around on the command line to make corrections or changes. When you use cursor control keys, consider the following guidelines:
Table 4-8

Ctrl indicates the Control key, which must be pressed simultaneously with its associated letter key. Esc indicates the Escape key, which must be pressed first, followed by its associated letter key. Keys are not case sensitive.

Key Combinations Used to Move the Cursor

Keystrokes Left arrow or Ctrl-B

Function Back character

Moves the Cursor One character to the left.When you enter a command that extends beyond a single line, you can press the left arrow or Ctrl-B keys repeatedly to scroll back toward the system prompt and verify the beginning of the command entry, or you can press the Ctrl-A key combination. One character to the right. Back one word. Forward one word. To the beginning of the line. To the end of the command line.

Right arrow or Ctrl-F Esc, B Esc, F Ctrl-A Ctrl-E

Forward character Back word Forward word Beginning of line End of line

Keystrokes to Control Capitalization


Letters can be capitalized or uncapitalized using simple key sequences. Table 4-9 describes the keystroke combinations used to control capitalization.

Note

Cisco IOS XR commands are generally case insensitive and typically all in lowercase.

Table 4-9

Keystrokes Used to Control Capitalization

Keystrokes Esc, C Esc, L Esc, U

Purpose Capitalizes the letter at the cursor. Changes the word at the cursor to lowercase. Capitalizes letters from the cursor to the end of the word.

Cisco IOS XR Getting Started Guide

4-19

Chapter 4 Key Combinations

CLI Tips, Techniques, and Shortcuts

Keystrokes to Delete CLI Entries


Table 4-10 describes the keystrokes used to delete command line entries.
Table 4-10 Keystrokes for Deleting Entries

Keystrokes Delete or Backspace Ctrl-D Ctrl-K Ctrl-U or Ctrl-X Ctrl-W Esc, D

Deletes The character to the left of the cursor. The character at the cursor. All characters from the cursor to the end of the command line. All characters from the cursor to the beginning of the command line. The word to the left of the cursor. From the cursor to the end of the word.

Transposing Mistyped Characters


To transpose mistyped characters, use the Ctrl-T key combination.

Cisco IOS XR Getting Started Guide

4-20

C H A P T E R

Managing Cisco IOS XR Software Packages


The Cisco IOS XR software comprises modular packages that provide boot and feature functionality. This chapter describes the concepts and tasks necessary to manage Cisco IOS XR software packages.

Contents
This chapter contains the following sections:

Overview of Software Packages, page 5-1 Selecting and Obtaining Software Packages, page 5-16 Information About Package Management, page 5-18 Package Management Procedures, page 5-22 Configuration Examples for Managing Packages, page 5-37

Overview of Software Packages


This section provides the following information on software packages:

Available Packages, page 5-1 Standard PIE Filenames and Version Numbers, page 5-11 Software Maintenance Update PIE Filenames and Version Numbers, page 5-13

Available Packages
Cisco IOS XR software comprises modular packages. Each package contains the components to perform a specific set of router functions, such as routing, security, or line card support. The Cisco IOS XR Unicast Routing Core Bundle provides six packages for use on every router. Four optional packages provide additional features. These packages are described later in this chapter. Figure 5-1 shows the available Cisco IOS XR software packages. These packages are distributed in Package Installation Envelope (PIE) files. See the Where to Place Installable PIE Files section on page 5-16 for information on obtaining PIE files.

Cisco IOS XR Getting Started Guide

5-1

Chapter 5 Overview of Software Packages

Managing Cisco IOS XR Software Packages

Figure 5-1

Cisco IOS XR Software Packages

Manageability
XML, ORB, Alarms Management

Security
IPSec, Encryption Decryption

MPLS
MPLS, UCP

Multicast
PIM, MFIP, IGMP

Forwarding
FIB, ARP, QoS, and other forwarding components

Admin
Resource management for racks and switch fabric

Base
Interface manager, system database, configuration management, and other slow changing components Included in the Cisco IOS XR Unicast Routing Core Bundle

OS
Kernel, file system, memory management, and other slow changing core components

Routing
RIB, BGP, IS-IS, OSPF, RPL

Line card
116631

Line card drivers

Cisco IOS XR Getting Started Guide

5-2

Chapter 5

Managing Cisco IOS XR Software Packages Overview of Software Packages

Cisco IOS XR Unicast Routing Core Bundle


Table 5-1 describes the required core packages that are delivered in the Cisco IOS XR Unicast Routing Core Bundle.
Table 5-1 Required Packages Included in the Cisco IOS XR Unicast Routing Core Bundle

Package Name OS Basic operating system

Features

1 GB flash DOSFAT File system support Flash disk support Initial system bring-up from disk0: QNET QNX flash file system Spinning media support System bring-up System bring-up from disk1: System bring-up from ROM Monitor (ROMMON) using TFTP Admin planelogical router (LR) plane isolation Admin plane support Control Fast Ethernet (FE) support Control Gigabit Ethernet (GE) support dLRSC election Designated shelf controller (DSC) election Fabric card online insertion and removal (OIR) Fabric manager Fabric plane management Fabric statistics Fabric topology management CRS-1 platform support Cisco XR 12000 Series Router support for Cisco XR 12404, Cisco XR 12406, Cisco XR 12410, and Cisco XR 12416 routers LR infrastructure LR plane support Management GE support Owner LR support

Admin Basic software required to install packages and manage the router

Cisco IOS XR Getting Started Guide

5-3

Chapter 5 Overview of Software Packages

Managing Cisco IOS XR Software Packages

Table 5-1

Required Packages Included in the Cisco IOS XR Unicast Routing Core Bundle

Package Name Base Basic infrastructure needed to boot to the CLI prompt

Features

AAA Services BCDL BGP TTL 255 Hack Dependency checker DLL upgrade GSP Hitless software upgrade or downgrade using PIE files Interface manager Maintain and display counters for each entry in the internal Forwarding Information Base (FIB) Maintain and display internal FIB upon user request MD5 or one-way encryption support Netio NetioDLL Restart Packet manager Password management PFI QSM Rate limiting router addressed and originated packetshardcoded Role-based authorization Scoped restarts Support for routing inbound packets using Layer 3 information Support for routing inbound packets using Layer 4 information Support forwarding to target route processor (RP) and distributed route processor (DRP) SysDBHitless downgrade or upgrade Syslog over IPv4 transport Syslog over IPv61 transport Syslog support TACACS+ support Version manager (including data translator)

Cisco IOS XR Getting Started Guide

5-4

Chapter 5

Managing Cisco IOS XR Software Packages Overview of Software Packages

Table 5-1

Required Packages Included in the Cisco IOS XR Unicast Routing Core Bundle

Package Name Forwarding

Features

(X) access control lists (ACLs) Quality of service (QoS) and class of service (CoS) using MQC Queueing (ingress and egress) Policing (ingress and egress) Diagnostic and network management support ARP Class-based marking (ingress and egress) for discard class, multicast traffic, EXP, QoS group, v4 DSCP, and v4 precedence CLNS services dCEF support DHCP relay DNS client support FTP client and FTP client support High-level data link control (HDLC) (Cisco) IPv4 IPv61 (excluding IPSec and mobility) Layer 3 loopback, policing (dual-rate three-color policer and single-rate three-color policer), load balancing through CEF, and load balancing through CEF (IPv61 forwarding services) MDRR support NTP support with external source PPP support Random Early Detection (RED)based on precedence DSCP EXP Sockets Label Information Base (LIB) support Telnet support TFTP support Trace route support Weighted Random Early Detection (WRED)based on bytes or packets or time

Cisco IOS XR Getting Started Guide

5-5

Chapter 5 Overview of Software Packages

Managing Cisco IOS XR Software Packages

Table 5-1

Required Packages Included in the Cisco IOS XR Unicast Routing Core Bundle

Package Name Line Card

Features

Alarms and (performance monitoring) PM Automatic Protection Switching (APS) during line card (LC) failure APS during LC OIR APS and MSP GR-253 G-783 Annex A/G-841 (no Annex B) Cisco IOS-like APS and MSP Bellcore GR-253 (as applicable) Dynamic mapping of queues to interfaces Hierarchical QoS (on cards that support this) ITU-T G.957 (as applicable) Layer 1 loopback Loopback support (for each subinterface and for each port) OC-192 OC-48 Optical power monitoring Pointer activity monitoring SONET and Synchronous Digital Hierarchy (SDH) alarm recognition and processing SONET and SDH header byte visibility and manipulation SONET and SDH concatenated Standards-compliant SONET and SDH interface Stratum3 and G.813 clocking Maximum number of egress (CoS) queues as supported by hardware Maximum number of ingress queues as supported by the hardware Maximum number of interfaces as supported by hardware Maximum prefix table size as supported by hardware Synchronization: local (internal) or loop timed (recovered from network); Stratum 3 (4.6 pmm) clock accuracy

Cisco IOS XR Getting Started Guide

5-6

Chapter 5

Managing Cisco IOS XR Software Packages Overview of Software Packages

Table 5-1

Required Packages Included in the Cisco IOS XR Unicast Routing Core Bundle

Package Name Routing Routing protocols (BGP, OSPF, and IS-IS), RIB, and routing policy engine

Features

MP-BGP v4 OSPFv2 and OSPFv3 IS-IS Static routes Route policy language (RPL) BTSH Conditional route injection (conditional advertisement) Exponential backoff shortest path first (SPF) algorithm support Extended community Filter prefixes on a per-peer basis for inbound and outbound prefix advertisement Graceful restart with NSF (Cisco implementation and IS-IS) MD5 authentication MPLS TE supportintra-area Multipath support for eBGP Multiple RIB table support for AFI and SAFI Name-based community set Next-hop propagation Prioritized RIB update RIB standby capable RIB support redistribution Route dampening Route redistribution (IS-IS and OSPFv3) Route map Show advertised routes

1. IPv6 is not supported on the Cisco XR 12000 Series Router.

Cisco IOS XR Getting Started Guide

5-7

Chapter 5 Overview of Software Packages

Managing Cisco IOS XR Software Packages

Optional Individual Packages


Table 5-2 describes the optional packages that can be activated individually.
Table 5-2 Optional Packages

Package Name Multicast

Features

Auto-RP Bidirectional Protocol Independent Multicast (PIM) Dynamic registration using Internet Group Management Protocol (IGMP) Explicit tracking of hosts, groups, and channels for IGMPv3 MBGP MSDP Multicast NSF Multicast Reverse Path Forwarding (RPF)loose mode Out-of-resource handling PIM-SM PIM-SSM Source Specific Multicast with IGMP v3

Cisco IOS XR Getting Started Guide

5-8

Chapter 5

Managing Cisco IOS XR Software Packages Overview of Software Packages

Table 5-2

Optional Packages (continued)

Package Name Multiprotocol Label Switching (MPLS)

Features

MPLS forwarding and load balancing MPLS traffic engineering (MPLS TE) Label distribution protocol (LDP)
LDP core (RFC 3036) (including link and targeted neighbors) LDP graceful restart (draft-ieft-mpls-ldp-graceful-restart02.txt) LDP high availability (HA) (restart automatic switchover) LDP MIBs (draft-ieft-mpls-ldp0mib-08.txt) LDP support for Layer 3 load balancing LDP support on Packet-over-SONET (PoS) interfaces

Resource Reservation Protocol (RSVP)


RSVP authentication, authorization, and accounting (AAA) CLI RSVP core RSVP extensions for OUNI RSVP graceful restart and hellos RSVP HAnonstop forwarding (NSF) and hitless software upgrade RSVP refresh reduction

UNI
UNI-C AAA CLI UNI-C core UNI-C HANSF and hitless software upgrade UNI-C hierarchical SONET alarms suppression UNI-C line protocol state control UNI-C local path restoration UNI-C node recovery support

LMPstatic configuration Fast reroute (FRR) with link, node, and bandwidth protection XML schema support, configuration, and operation

Cisco IOS XR Getting Started Guide

5-9

Chapter 5 Overview of Software Packages

Managing Cisco IOS XR Software Packages

Table 5-2

Optional Packages (continued)

Package Name Manageability

Features

Alarms managementconfiguration, operation, and correlation support Configuration editor and manager Accounting and statistics management Performance management Border Gateway Protocol (BGP) IPv61 Fault manager Network Time Protocol (NTP) configuration and operation Control point and network managementgeneric requirements Terminal services enhancements Enhanced command-line interface (CLI) Extensible markup language (XML) interface and schemas Craft Works Interface (CWI) Common Object Request Broker Architecture (CORBA) support Simple Network Management Protocol (SNMP) v1, v2c, and v3 support MIB support. For a complete list of supported MIBs, go to the following link: http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml Client and server support Secure socket layer (SSL) Control packet policing IPSec Client and server support (Secure Shell [SSH] and SFTP) Enhanced password security IPv61 (SSH and SFTP) MD5 PKI Random number generator Selective packet discard SHTTP support Software authentication SSHv1 and SSHv2 support v3 and TLSv1 support

Security

1. IPv6 is not supported on the Cisco XR 12000 Series Router.

Cisco IOS XR Getting Started Guide

5-10

Chapter 5

Managing Cisco IOS XR Software Packages Overview of Software Packages

Package Installation Envelope Files


PIE files are nonbootable files that can be used to upgrade or add software packages to the router. A PIE file may contain a single package or a set of packages (called a composite package). Because the files are nonbootable, they must be installed and activated on a running router. PIE files have a .pie extension. When a PIE file contains software for a specific bug fix, it is called a Software Maintenance Update (SMU).

Standard PIE Filenames and Version Numbers


Standard PIE filenames have two formats: one for composite-package PIEs and one for single-package PIEs. A composite-package file is a PIE file that contains multiple packages. The format for a composite-package filename on Cisco CRS-1s is:

Note

Hyphens in the composite-package filename are part of the filename, as shown following list. comp-platform-composite_name.pie-major.minor.maintenance The format for a composite-package filename on Cisco XR 12000 Series Routers is: platform-composite_name.pie-major.minor.maintenance The comp prefix indicates that the file is a composite of multiple packages. The format for single-package PIEs on Cisco CRS-1s is: platform-package_type.-p.pie-major.minor.maintenance The format for single-package PIEs on Cisco XR 12000 Series Routers is: platform-package_type.pie-major.minor.maintenance The filename components for all of the packages are described in Table 5-3.

Note

For Cisco XR 12000 Series Routers, single-package PIEs actually contain separate PIE files for the PRP and line cards. Although the Cisco XR 12000 Series Router single-package PIEs contain two PIEs, they are called single-package PIEs because the enclosed PIEs provide the features for only one feature package.

Cisco IOS XR Getting Started Guide

5-11

Chapter 5 Overview of Software Packages

Managing Cisco IOS XR Software Packages

Table 5-3

Composite- and Single-Package Filename Components

Component platform

Description Identifies the platform for which the software package is designed.

For packages designed for CRS-1 routers, the platform designation is hfr. For packages designed for Cisco XR 12000 Series Router, the platform designation is c12k. The only composite PIE file at this time is named mini and includes all packages described in the Cisco IOS XR Unicast Routing Core Bundle section on page 5-3.

composite_name

Identifies a specific composite package.

package_type

Identifies the type of package the file supports (package_type applies only to single-package PIEs). Package types include:

fwdg for the Forwarding package lc for the Line Card package mcast for the Multicast package mgbl for the Manageability package mpls for the MPLS package k9sec for the Security package rout for the Routing package A major release occurs when there is a major architectural change to the product (for example, a major new capability is introduced). All packages operating on the router must be at the same major release level. A major release is the least frequent release and may require a router reboot.

major

Identifies the major release of this package.

Cisco IOS XR Getting Started Guide

5-12

Chapter 5

Managing Cisco IOS XR Software Packages Overview of Software Packages

Table 5-3

Composite- and Single-Package Filename Components (continued)

Component minor

Description Identifies the minor release of this package.

A minor release contains one or more of the following:


New features Bug fixes

The minor release version does not have to be identical for all software packages operating on the router, but the operating packages must be certified by Cisco as compatible with each other. A minor release may require a router reboot.

maintenance

Identifies the maintenance release of this package.


A maintenance release contains a collection of bug fixes for a package. The maintenance release version does not have to be identical for all software packages operating on the router, but the major and minor versions of the maintenance release must match those of the package being updated. A maintenance release does not usually require a router reboot.

Software Maintenance Update PIE Filenames and Version Numbers


An SMU is a PIE file that contains fixes for a specific defect. A composite SMU is a PIE file that contains SMUs for more than one package. SMUs are installed using the same procedures as other PIE files. SMUs are created to respond to immediate issues and do not include new features. Typically, SMUs do not have a large impact on router operations. SMU versions are synchronized to the package major, minor, and maintenance versions they upgrade.

Cisco IOS XR Getting Started Guide

5-13

Chapter 5 Overview of Software Packages

Managing Cisco IOS XR Software Packages

SMUs are not an alternative to maintenance releases. They provide quick resolution of immediate issues. All bugs fixed by SMUs are integrated into the maintenance releases. The format for a single-package SMU filename is: platform-package_type-major.minor.maintenance.ddts.pie The format for a composite-package SMU filename is: comp-platform-composite_name.ddts.pie The comp prefix indicates that the file is a composite file containing multiple updates. The other filename components are described in Table 5-4.
Table 5-4 SMU Single- and Composite-Package Filename Components

Component platform

Description Identifies the platform for which the software package is designed.

For packages designed for CRS-1 routers, the platform designation is either hfr or CRS-1. For packages designed for Cisco XR 12000 Series Router, the platform designation is c12k. The composite name is a name or number that is unique to the SMU.

composite_name

Identifies a specific composite package.

ddts

Identifies a Distributed Defect Tracking System (DDTS) number that describes the problem this SMU addresses.
Note

DDTS is the method used to track known bugs and the resolutions or workarounds for those issues.

package_type

Identifies the type of package the file supports (package_type applies only to single-package PIEs). Package types include:

fwdg for the Forwarding package lc for the Line Card package mcast for the Multicast package mgbl for the Manageability package mpls for the MPLS package k9sec for the Security package rout for the Routing package

Cisco IOS XR Getting Started Guide

5-14

Chapter 5

Managing Cisco IOS XR Software Packages Overview of Software Packages

Table 5-4

SMU Single- and Composite-Package Filename Components (continued)

Component major

Description Identifies the major release of this package.

A major release occurs when there is a major architectural change to the product (for example, a major new capability is introduced). All packages operating on the router must be at the same major release level. A major release is the least frequent release and may require a router reboot. A minor release contains one or more of the following:
New features Bug fixes

minor

Identifies the minor release of this package.

The minor release version does not have to be identical for all software packages operating on the router, but the operating packages must be certified by Cisco as compatible with each other. A minor release may require a router reboot.

maintenance

Identifies the maintenance release of this package.


A maintenance release contains a collection of bug fixes for a package. The maintenance release version does not have to be identical for all software packages operating on the router, but the major and minor versions of the maintenance release must match the those of the package being updated. A maintenance release does not usually require a router reboot.

In the following example, the SMU for the base package version 2.0.0 fixes DDTS CSCec98765: SMU base-2.0.0.CSCec98765-1.0.0 SMU Filename hfr-base-2.0.0.CSCec98765.pie

In the following example, the SMU comp-001.CSCec98766 provides changes to multiple packages, as specified in DDTS CSCec98766: SMU comp-001.CSCec98766 SMU Filename comp-hfr-001.CSCec98766.pie

Cisco IOS XR Getting Started Guide

5-15

Chapter 5 Selecting and Obtaining Software Packages

Managing Cisco IOS XR Software Packages

Note

The composite name usually is 001, which means the SMU is the first SMU for that DDTS. In rare cases in which the same DDTS requires multiple composite SMUs, a second composite version number is released as 002. In the previous example, a second composite SMU comp-002.CSCec98766 would be created for DDTS CSCec98766.

Selecting and Obtaining Software Packages


The following sections provide details on the information available to help you select and obtain software packages:

Obtaining Cisco IOS XR Software and Version Information from Cisco Where to Place Installable PIE Files

Obtaining Cisco IOS XR Software and Version Information from Cisco


To obtain Cisco IOS XR software and version information, use the Cisco IOS XR Software Selector tool at the following website: http://www.cisco.com/cgi-bin/Software/IOXPlanner/planner-tool/ioxplanner.cgi? The following packages can be downloaded and installed without interrupting the router:

Cisco IOS XR Unicast Routing Core Bundle Cisco IOS XR Unicast Routing Package Cisco IOS XR MPLS Package Cisco IOS XR Manageability Package Cisco IOS XR Multicast Package Cisco IOS XR Security Package

Note

The Cisco IOS XR IP/MPLS Core Software and the Cisco IOS XR IP/MPLS Core Software 3DES package must be installed from ROM Monitor, and the installation process does interrupt router operation. For more information on installing these software packages from ROM Monitor, see Appendix A, Router Recovery and Management with ROM Monitor. The Cisco IOS XR Software Selector tool allows you to browse for your software upgrade from a single interface. You can display and select software by package name, release, and platform. The tool also includes XML schemas. Choosing a platform, release, or software feature automatically limits the choices based on your selection, until you arrive at your preferred software.

Where to Place Installable PIE Files


After you download files, those files must be placed in a location that is accessible for router upgrades. PIE files can be installed from a removable flash disk or a TFTP, an FTP, or an rcp file server (see Figure 5-2).

Cisco IOS XR Getting Started Guide

5-16

Chapter 5

Managing Cisco IOS XR Software Packages Selecting and Obtaining Software Packages

Figure 5-2

Where to Locate and Store PIE Installation Files

RP

Console AUX

HDD

The hard disk drive stores nonfunctional files, such as system logs, temporary files, and user files

Flash disk0: (internal)

PC Card (disk1:)

Flash disk1: (removable)

Active software and configurations


CNTL ETH 0 CNTL ETH 1

Archive of installation files

Network TFTP, FTP, or RCP file server (archive of PIE and .vm files)

MGMT ETH

Status

Note

Files with the .vm extension are bootable installation files used only to replace all current Cisco IOS XR software. These files are installed from ROMMON and cause significant router downtime. We recommend installing or upgrading software packages using only PIE files, as described in this document. See Appendix A, Router Recovery and Management with ROM Monitor for information.

Flash disk1: Archive of Installation PIE Files


Flash disk 1 (disk1:) is optional on Cisco CRS-1s and on Cisco XR 12000 Series Routers. When it is installed, flash disk 1 can be used to store PIE files, which can then be used to add new software to flash disk 0 (disk0:). See the Obtaining Cisco IOS XR Software and Version Information from Cisco section on page 5-16 for information on obtaining a list of available PIE files.

Cisco IOS XR Getting Started Guide

116548

Primary

5-17

Chapter 5 Information About Package Management

Managing Cisco IOS XR Software Packages

Note

Flash disk 0 (disk0:) is required and used by the system, and disk0: should never be manipulated by the user. In addition, the hard disk is used to store system files, such as logs and user files. It should also not be used to store installation PIE files.

Network Server: Downloading Updated PIE Files


Installable PIE software packages can also be downloaded from a TFTP, an FTP, or an rcp server to the archive on disk1:. Consult your system administrator for the location and availability of your network server. For information on the supported download protocols and command syntax to copy or install packages, see the Upgrading, Downgrading, and Installing Packages section on page 5-26.

Information About Package Management


This section describes the following concepts for managing Cisco IOS XR software packages:

Overview of Package Management, page 5-18 Upgrading Packages, page 5-20 Downgrading Packages, page 5-20 Impact of Package Version Changes, page 5-21 Impact of Package Activation and Deactivation, page 5-21 Controlling install Command Operation, page 5-26 Activation and Deactivation Prerequisites, page 5-22

Overview of Package Management


Package management processes include the following:

Viewing which packages and package versions are in use Adding or removing optional packages Upgrading or downgrading installed packages Removing packages that are no longer in use Rolling back the selected package set to a previous package set

The general procedure for adding optional packages, upgrading packages, or downgrading packages on the router is as follows:
1. 2. 3. 4.

Copy the PIE file to the router. Add the package to the router. Activate the package on the router. Commit the current set of packages.

Figure 5-3 illustrates key steps in the package management process.

Cisco IOS XR Getting Started Guide

5-18

Chapter 5

Managing Cisco IOS XR Software Packages Information About Package Management

Figure 5-3

Process to Add, Activate, and Commit Cisco IOS XR Software Packages

Archive of PIE files Flash disk1: Inactive Software Flash disk0: Install Activate Install Commit Install Deactivate Active Software Configuration Committed Software Configuration

Install Add

TFTP, FTP, or RCP file server

When you are adding an optional package, upgrading a package, or downgrading a package and the package version you want to use is not available on the router, you must copy the appropriate PIE file to the router. You can copy the files to the router by inserting a flash disk with the appropriate files in the slot for flash disk1: , or you can copy files to the router from a file server. Although you can transfer PIE files to flash disk1: or flash disk0:, the recommended approach is to store PIE files on flash disk1:. Flash disk1: serves as the archive for PIE files that are no longer in use or have yet to be added. Flash disk0: serves as the storage location for all files that are ready for activation.

Tip

Before copying PIE files to the router, check to see if the required PIE files are on flash disk1:. After the required PIE file is on the router, the next step is to use the install add command to unpack the PIE file and move the package software to a storage device, which is usually flash disk0:. On routers with primary and standby RPs, the package is also added to the standby RP so that the standby RP is prepared to take over if the primary RP fails. The add process produces package software that is ready for activation. When you activate a software package with the install activate command, the router starts using the package version you have activated. If you are activating an optional package that has not been previously activated, the package is activated on all cards. If you are activating a newer (upgrade) or an older (downgrade) version of a previously activated package, you can choose to activate the package on all cards or on specific cards. When a package is activated during an upgrade or a downgrade, the previously active package version is deactivated. The final step in adding, upgrading, or downgrading a package is to commit the current set of packages to the router configuration. When a router is reloaded, it loads the last committed set of packages. If different packages have been activated and not committed, those packages are not loaded. To ensure that recently activated packages become part of the committed package set, enter the install commit command. Although the term commit sounds final, the Cisco IOS XR software provides the flexibility to roll back the selected package set to previously saved package sets. Each time a package is activated or deactivated, a rollback point is created that defines the package set that is active after the package activation or deactivation. The software also creates a rollback point for the last committed package set. If you find that you prefer a previous package set over the currently active package set, you can use the install rollback command to make a previously active package set active again.

Cisco IOS XR Getting Started Guide

116634

5-19

Chapter 5 Information About Package Management

Managing Cisco IOS XR Software Packages

Upgrading Packages
To upgrade a package that is currently active on the router, activate a newer version of the same package for one or more cards for which an older version is already active (see Figure 5-4). The older version of the same software package is deactivated automatically. These actions are permitted only after the package compatibility checks and API version compatibility checks have passed. Deactivated packages are not removed from the storage device. To delete an inactive package from the disk, enter the install remove command. See the Removing Inactive Packages from the Router section on page 5-37 for more information.

Caution

Upgrading or downgrading a software package can cause a process to restart or a new process to start. Use the test option to preview the impact of the package activation.
Figure 5-4 Example of a Maintenance Release Package Upgrade

MPLS 2.0.0 Routing 2.0.0 Forwarding 2.0.0 Base 2.0.0

MPLS 2.0.0 Routing 2.0.1 Forwarding 2.0.0 Base 2.0.0


116630

Downgrading Packages
To downgrade a software package, activate an older version on one or more cards for which that package is already active. The newer version of the same software package is deactivated automatically. These actions are performed only after the package compatibility checks and API version compatibility checks have passed. Deactivated packages are not removed from the storage device. To delete an inactive package from the disk, enter the install remove command. See the Removing Inactive Packages from the Router section on page 5-37 for more information.

Cisco IOS XR Getting Started Guide

5-20

Chapter 5

Managing Cisco IOS XR Software Packages Information About Package Management

Impact of Package Version Changes


Each package upgrade has a different impact on the operation of the router, depending on the type of package and whether the upgrade is for a major, minor, or maintenance release. The following resources can provide more information on the impact of a package version change:

See the Standard PIE Filenames and Version Numbers section on page 5-11 for more information on the typical impact for major, minor, and maintenance releases. For specific information regarding the impact of an upgrade, consult the release notes for the package release, and test the impact of the package activation by adding the test option to the install activate command. The IOS XR Software Selector tool also contains information on package version compatibility. See the Selecting and Obtaining Software Packages section on page 5-16 for information regarding online compatibility resources.

Impact of Package Activation and Deactivation


Activation or deactivation of a package can have an immediate impact on the system. The system can be affected in the following ways:

When a new package is activated, any new CLI commands for the package are added to the system. The router need not be restarted or reloaded. When a package is deactivated, the commands associated with the features being deactivated are removed from the system and are no longer available to the user. During a software package deactivation, upgrade, or downgrade, any incompatible configurations are removed from the running configuration and saved to a file. Incompatible configurations are those configurations that are not supported by the new version of the software package.

Note

You must address any issues that result from the removed configuration and reapply the configuration, if necessary.

New processes may be started. Running processes may be stopped or restarted. All processes in the cards may be restarted. Restarting processes in the cards is equivalent to a soft reset. The cards may reload. No impact: no processes in the card are affected.

Tip

When activating and deactivating packages, use the test option to test the effects of a command without impacting the running system. After the activation or deactivation process completes, enter the show install log command to display the process results.

Cisco IOS XR Getting Started Guide

5-21

Chapter 5 Package Management Procedures

Managing Cisco IOS XR Software Packages

Activation and Deactivation Prerequisites


The following prerequisites must be met for a package to be activated or deactivated.

All cards should be installed and operating properly. For example, you should not activate or deactivate packages while cards are booting, while cards are being upgraded or replaced, or when you anticipate an automatic switchover activity. Initial activation of any package must always be performed for the default set of supported card types. If a ROM Monitor upgrade is required for the software package, the upgrade must be completed before the package is activated. For ROM Monitor upgrade information and procedures, see Appendix B, Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers. Although more than one version of a software package can be added to a storage device, only one version of a package can be active for any card. The package must be compatible with the card for which it is being activated. Some packages require the activation or deactivation of other packages. The package being activated must be compatible with the current active software set. While a software package is being activated, other requests are not allowed to execute on the system. Each installation request is assigned a requestID, which can be used later to review the events. Package activation is complete when the following message is displayed:
Install 1: Activation operation successful.

Activation is performed only after the package compatibility checks and API version compatibility checks have passed. If a conflict is found, an on-screen error message is displayed.

Package Management Procedures


Review the concepts in the Information About Package Management section on page 5-18 before performing the following tasks. The following sections describe package management tasks:

Displaying the Active Packages for All Cards, page 5-23 Displaying the Active Packages for a Single Card, page 5-25 Displaying the Committed Package Versions for Each Card, page 5-25 Upgrading, Downgrading, and Installing Packages, page 5-26 Rolling Back to the Last Committed Package Set, page 5-34 Displaying Noncommitted Rollback Points, page 5-34 Rolling Back to a Noncommitted Rollback Point, page 5-35 Committing the Active Package Set, page 5-36 Deactivating a Package, page 5-37 Removing Inactive Packages from the Router, page 5-37 Activating and Testing a Package on the Router: Example, page 5-38

Cisco IOS XR Getting Started Guide

5-22

Chapter 5

Managing Cisco IOS XR Software Packages Package Management Procedures

Displaying the Active Packages for All Cards


In the following example, the active packages for all cards in a Cisco CRS-1 system are shown:
RP/0/RP1/CPU0:Router# show install active Node 0/1/SP [SP] Boot Image: /disk0/hfr-os-mbi-3.2.00/sp/mbihfr-sp.vm Active Packages: disk0:comp-hfr-mini-3.2.00 Node 0/1/CPU0 [LC] Boot Image: /disk0/hfr-os-mbi-3.2.00/lc/mbihfr-lc.vm Active Packages: disk0:hfr-mcast-3.2.00 disk0:hfr-mpls-3.2.00 disk0:comp-hfr-mini-3.2.00 Node 0/RP1/CPU0 [RP] Boot Image: /disk0/hfr-os-mbi-3.2.00/mbihfr-rp.vm Active Packages: disk0:hfr-mgbl-3.2.00 disk0:hfr-mcast-3.2.00 disk0:hfr-mpls-3.2.00 disk0:hfr-k9sec-3.2.00 disk0:comp-hfr-mini-3.2.00 Node 0/SM0/SP [SP] Boot Image: /disk0/hfr-os-mbi-3.2.00/sp/mbihfr-sp.vm Active Packages: disk0:comp-hfr-mini-3.2.00 Node 0/SM1/SP [SP] Boot Image: /disk0/hfr-os-mbi-3.2.00/sp/mbihfr-sp.vm Active Packages: disk0:comp-hfr-mini-3.2.00

In the preceding example, the active packages for each node are on disk0:, and for all nodes, the composite package comp-hfr-mini-3.2.00 is active. Where additional packages are shown, those are optional packages that have been added after the initial loading of the Cisco IOS XR Unicast Routing Core Bundle. The show install active detail command displays all information that appears without the detail option, and it displays the active packages within each composite package. In the next example, the active packages for all cards in a Cisco XR 12000 Series Router are shown using the detail option:
RP/0/0/CPU0:router# show install active detail Node 0/0/CPU0 [RP] Boot Image: /disk0/c12k-rp-os-mbi-3.2.00/mbiprp-rp.vm Active Packages: disk0:c12k-mini-3.2.00 disk0:c12k-rp-rout-3.2.00 disk0:c12k-rp-lc-3.2.00 disk0:c12k-rp-fwdg-3.2.00 disk0:c12k-rp-admin-3.2.00 disk0:c12k-rp-base-3.2.00 disk0:c12k-rp-os-mbi-3.2.00

Cisco IOS XR Getting Started Guide

5-23

Chapter 5 Package Management Procedures

Managing Cisco IOS XR Software Packages

Node 0/3/CPU0 [LC(E3-OC3-POS-8)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00 disk0:c12k-lc-lc-3.2.00 disk0:c12k-lc-fwdg-3.2.00 disk0:c12k-lc-admin-3.2.00 disk0:c12k-lc-base-3.2.00 disk0:c12k-lc-os-mbi-3.2.00 Node 0/4/CPU0 [LC(E3-GE-4)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00 disk0:c12k-lc-lc-3.2.00 disk0:c12k-lc-fwdg-3.2.00 disk0:c12k-lc-admin-3.2.00 disk0:c12k-lc-base-3.2.00 disk0:c12k-lc-os-mbi-3.2.00 Node 0/5/CPU0 [LC(E3-GE-4)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00 disk0:c12k-lc-lc-3.2.00 disk0:c12k-lc-fwdg-3.2.00 disk0:c12k-lc-admin-3.2.00 disk0:c12k-lc-base-3.2.00 disk0:c12k-lc-os-mbi-3.2.00 Node 0/6/CPU0 [LC(E3-OC48-POS)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00 disk0:c12k-lc-lc-3.2.00 disk0:c12k-lc-fwdg-3.2.00 disk0:c12k-lc-admin-3.2.00 disk0:c12k-lc-base-3.2.00 disk0:c12k-lc-os-mbi-3.2.00 Node 0/7/CPU0 [LC(E3-GE-4)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00 disk0:c12k-lc-lc-3.2.00 disk0:c12k-lc-fwdg-3.2.00 disk0:c12k-lc-admin-3.2.00 disk0:c12k-lc-base-3.2.00 disk0:c12k-lc-os-mbi-3.2.00 Node 0/8/CPU0 [LC(E3-OC12-POS-4)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00 disk0:c12k-lc-lc-3.2.00 disk0:c12k-lc-fwdg-3.2.00 disk0:c12k-lc-admin-3.2.00 disk0:c12k-lc-base-3.2.00 disk0:c12k-lc-os-mbi-3.2.00

Cisco IOS XR Getting Started Guide

5-24

Chapter 5

Managing Cisco IOS XR Software Packages Package Management Procedures

Displaying the Active Packages for a Single Card


To display the active packages for a single card, enter the show install active command with the location option. The following example shows the active packages on an RP in a Cisco XR 12000 Series Router:
RP/0/0/CPU0:router# show install active location 0/0/cpu0 Node 0/0/CPU0 [RP] Boot Image: /disk0/c12k-rp-os-mbi-3.2.00/mbiprp-rp.vm Active Packages: disk0:c12k-mini-3.2.00

Displaying the Committed Package Versions for Each Card


Committed packages are packages that are persistent across router reloads. If you install and activate a package, it remains active until the next router reload. If you install, activate, and commit a package, the package remains active across router reloads until the package is deactivated or replaced with another committed package. Enter the show install committed command to verify that the desired set of packages is committed. In the following example, the committed packages are shown:
RP/0/0/CPU0:router# show install committed Node 0/0/CPU0 [RP] Boot Image: /disk0/c12k-rp-os-mbi-3.2.00/mbiprp-rp.vm Active Packages: disk0:c12k-mini-3.2.00 Node 0/3/CPU0 [LC(E3-OC3-POS-8)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00 Node 0/4/CPU0 [LC(E3-GE-4)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00 Node 0/5/CPU0 [LC(E3-GE-4)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00 Node 0/6/CPU0 [LC(E3-OC48-POS)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00 Node 0/7/CPU0 [LC(E3-GE-4)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00

Cisco IOS XR Getting Started Guide

5-25

Chapter 5 Package Management Procedures

Managing Cisco IOS XR Software Packages

Node 0/8/CPU0 [LC(E3-OC12-POS-4)] Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: disk0:c12k-mini-3.2.00

As with the show install active command, the show install committed command may display a composite package that represents all packages in the Cisco IOS XR Unicast Routing Core Bundle.

Upgrading, Downgrading, and Installing Packages


The processes for upgrading, downgrading, and installing optional packages are introduced in the Information About Package Management section on page 5-18. The following sections describe features and procedures you can use to upgrade, downgrade, and install optional packages:

Controlling install Command Operation, page 5-26 Supported File Transfer Protocols, page 5-27 Copying Package Files from a Network Server to the Router, page 5-27 Adding Packages that are Resident on the Router, page 5-28 Adding Files from a Network Server, page 5-29 Activating a Package for All Appropriate Cards, page 5-30 Activating a Package for a Single Card, page 5-32 Adding and Activating Package Files in One Step from a Network Server, page 5-33

Controlling install Command Operation


The install command is used in different forms to perform many package management tasks, such as adding, activating, and committing packages. Only one install command can run at a time. By default, the CLI prompt is returned to the screen before the installation operation is complete, which allows you to enter other noninstall commands. If additional installation requests are attempted before the first operation is complete, they are not executed. To determine if an install command is currently running, enter the show install request command. To delay the return of the CLI prompt until an installation operation is complete, enter the install command with the synchronous option. For example: install add pie-file to device synchronous install activate device:package synchronous

Note

The install add and install activate commands must be executed in admin mode and are described later in this chapter.

Cisco IOS XR Getting Started Guide

5-26

Chapter 5

Managing Cisco IOS XR Software Packages Package Management Procedures

Supported File Transfer Protocols


PIE files can be copied from a file server to the router or directly installed from a network server using TFTP, FTP, SFTP, or rcp protocols (see Table 5-5).
Table 5-5 Download Protocols Supported by Cisco IOS XR Software

Name Trivial File Transfer Protocol

Description TFTP is a simplified version of FTP that allows files to be transferred from one computer to another over a network, usually without the use of client authentication (for example, username and password).
Note

Some Cisco IOS XR images may be larger than 32 MB, and the TFTP services provided by some vendors may not support a file this large. If you do not have access to a TFTP server that supports files larger than 32 MB, download the software image using FTP or rcp.

File Transfer Protocol Remote Copy Protocol SSH File Transfer Protocol

FTP is part of the TCP/IP protocol stack and requires a username and password. The rcp protocol uses TCP to ensure the reliable delivery of data, and rcp downloads require a usernames. SFTP is part of the SSHv2 feature in the Security package and provides for secure file transfers. For more information, see the Cisco IOS XR System Security Configuration Guide.

Copying Package Files from a Network Server to the Router


The commands listed in Table 5-6 show how to copy package files to the router from three types of network file servers.
Table 5-6 Commands for Copying Package Files to the Router

Server Type TFTP

Command and Example The following command syntax is used: copy tftp://hostname_or_ipaddress/directory-path/pie-name target-device Example:
RP/0/RP0/CPU0:router# copy tftp://10.1.1.1/images/comp-hfr-full.pie disk1:

FTP

The following command syntax is used: copy ftp://username:password@hostname_or_ipaddress/directory-path/pie-name target-device Example:


RP/0/RP0/CPU0:router# copy ftp://john:secret@10.1.1.1/images/comp-hfr-full.pie disk1:

rcp

The following command syntax is used: copy rcp://username@hostname_or_ipaddress/directory-path/pie-name target-device Example:


RP/0/RP0/CPU0:router# copy rcp://john@10.1.1.1/images/comp-hfr-full.pie disk1:

Cisco IOS XR Getting Started Guide

5-27

Chapter 5 Package Management Procedures

Managing Cisco IOS XR Software Packages

Table 5-7 describes the command variables for copying and installing packages from a network server.
Table 5-7 Command Variables for Copying and Installing Packages from a Network Server

Variable hostname_or_ipaddress pie-name username password directory-path

Description Host name or IP address of the server that stores the source file. Name of the PIE file (package) to install. See the Available Packages section on page 5-1 for descriptions of the available PIE files. Required for FTP and rcp only and must be a valid username on the FTP or rcp server. Required for FTP only. If a password is not provided, the networking device accepts anonymous FTP. The specified directory should be a directory under the home directory of the user. In the rcp and FTP examples in this section, the file being downloaded is in a subdirectory called images in the home directory of the user john.
Note

For FTP and rcp services, directory-path is the directory relative to the username home directory. If you want to specify an absolute path for the directory, you must add a / following the server address. disk0: PIE files are installed on flash disk0: with the install add command. disk0: is used only for installed and active software. disk1: PIE files can be copied to flash disk1: with the copy command. disk1: is used to store an archive of installation PIE files. Files can be copied to disk1: and then installed on disk0:.

target-device

Adding Packages that are Resident on the Router


After package files have been copied to the router, you can use the install add command to unpack PIE files and copy the enclosed software to disk0: on the primary RP. This process does not impact router operations. The following command syntax is used in admin EXEC mode: install add pie-file to device The following example shows how to add the contents of a PIE file on disk0: to disk0:
RP/0/0/CPU0:router(admin)# install add disk0:c12k-mgbl.pie-3.2.00.1i to disk0: Install: The idle timeout on this line will be suspended for synchronous install operations Install: Starting install operation. Do not insert or remove cards until the ope ration completes. RP/0/0/CPU0:router(admin)# Install: Now operating in asynchronous mode. Do not attempt subsequent install o perations until this operation is complete. Install 1: [ 0%] Install operation 'add /disk0:c12k-mgbl.pie-3.2.00.1i to disk0 :' assigned request id: 1 Install 1: [ 1%] Downloaded the package to the router Install 1: [ 1%] Verifying the package Install 1: [ 1%] Verification of the package successful [OK] Install 1: [ 95%] Going ahead to install the package... Install 1: [ 95%] [OK] Install 1: [ 95%] Add of '/disk0:c12k-mgbl.pie-3.2.00.1i' completed. Install 1: [ 95%] Add successful. Install 1: [ 95%] Downloading added packages to remote nodes. Install 1: [100%] Successfully downloaded added packages to remote nodes. Install 1: [100%] The following package(s) and/or SMU(s) are now available to be activated:

Cisco IOS XR Getting Started Guide

5-28

Chapter 5

Managing Cisco IOS XR Software Packages Package Management Procedures

Install 1: [100%] disk0:c12k-mgbl-3.2.00 Install 1: [100%] Please carefully follow the instructions in the release notes when activating any software Install 1: [100%] Idle timeout on this line will now be resumed for synchronous install operations

Tip

Make a note of the device and package names of the added package or packages. You must enter the device and package names to activate a package. In the preceding example, the device and package names for the added package are as follows: disk0:c12k-k9sec-3.2.00.

Note

Multiple versions of a software package can be added to the storage device without impacting the running configuration, but only one version of a package can be activated for a card.

Adding Files from a Network Server


When you add a file from a network server, the PIE file is unpacked and its contents are stored on the local device. The commands listed in Table 5-8 show how to add package files to the router from three types of network file servers.
Table 5-8 Syntax for Copying and Adding Package Files to the Router

Server Type TFTP

Command and Example The following command syntax is used in admin EXEC mode: install add tftp://hostname_or_ipaddress/directory-path/pie-name to target-device Example:
RP/0/0/CPU0:router(admin)# install add tftp://10.1.1.1/images/hfr-k9sec-p.pie to disk0:

FTP

The following command syntax is used in admin EXEC mode: install add ftp://username:password@hostname_or_ipaddress/directory-path/pie-name to target-device Example:
RP/0/0/CPU0:router(admin)# install add ftp://john:secret@10.1.1.1/images/hfr-k9sec-p.pie to disk0:

rcp

The following command syntax is used in admin EXEC mode: install add rcp://username@hostname_or_ipaddress/directory-path/pie-name to target-device Example:
RP/0/0/CPU0:router(admin)# install add rcp://john@10.1.1.1/images/gsr-k9sec-p.pie to disk0:

Cisco IOS XR Getting Started Guide

5-29

Chapter 5 Package Management Procedures

Managing Cisco IOS XR Software Packages

The following example shows how to add the Security package from a TFTP server to a Cisco XR 12000 Series Router:
RP/0/0/CPU0:router(admin)# install add tftp://10.1.1.1/software/c12k-k9sec.pie-3.2.00.1i to disk0: Install: The idle timeout on this line will be suspended for synchronous install operations Install: Starting install operation. Do not insert or remove cards until the ope ration completes. RP/0/0/CPU0:router(admin)# Install: Now operating in asynchronous mode. Do not attempt subsequent install o perations until this operation is complete. Install 1: [ 0%] Install operation 'add tftp://10.1.1.1/software/c12k-k9sec.pie-3.2.00.1i to disk0:' assigned request id: 1 Install 1: [ 1%] Downloading PIE file from /tftp://10.1.1.1/software/c12k-k9sec.pie-3.2.00.1i Install 1: [ 1%] Transferred 1320473 Bytes Install 1: [ 1%] Downloaded the package to the router Install 1: [ 1%] Verifying the package Install 1: [ 1%] Verification of the package successful [OK] Install 1: [ 95%] Going ahead to install the package... Install 1: [ 95%] [OK] Install 1: [ 95%] Add of '/tftp://10.1.1.1/software/c12k-k9sec.pie-3.2.00.1i' completed. Install 1: [ 95%] Add successful. Install 1: [ 95%] Downloading added packages to remote nodes. Install 1: [100%] Successfully downloaded added packages to remote nodes. Install 1: [100%] The following package(s) and/or SMU(s) are now available to be activated: Install 1: [100%] disk0:c12k-k9sec-3.2.00 Install 1: [100%] Please carefully follow the instructions in the release notes when activating any software Install 1: [100%] Idle timeout on this line will now be resumed for synchronous install operations

Tip

Make a note of the device and package names of the added package or packages. You must enter the device and package names to activate a package. In the preceding example, the device and package names for the added package are disk0:c12k-k9sec-3.2.00.

Activating a Package for All Appropriate Cards


By default, packages are activated for all cards supported by that package. To activate a package on all router cards to which it applies, use the following command syntax in admin EXEC mode: install activate device: package

Cisco IOS XR Getting Started Guide

5-30

Chapter 5

Managing Cisco IOS XR Software Packages Package Management Procedures

Replace device with the name of a router storage device, such as disk0:, and replace package with the name of the installed package. Notice that the installed package name is different from the PIE file name and is displayed when the PIE file is added with the install add command. To see the installed packages that are available, enter the dir command for the device on which the packages are installed. For example:
RP/0/0/CPU0:router# dir disk0: Directory of disk0: 2 3 564 566 2047 2092 2260 2796 3281 6344 6818 7175 7298 4 8014 8045 8047 8048 67072 67168 67360 8099 8144 8126 drwx drwx drwx drwx drwx drwx drwx drwx drwx drwx drwx drwx drwx drwx drwx dr-x drwx drwx -rwx -rwx -rwx drwx drwx drwx 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 4440 54027072 126 16384 16384 16384 Tue Fri Fri Fri Fri Fri Fri Fri Fri Fri Fri Fri Fri Tue Thu Fri Tue Tue Fri Fri Fri Wed Fri Fri Oct Nov Nov Nov Nov Nov Nov Nov Nov Nov Nov Nov Nov Oct Nov Nov Oct Oct Nov Nov Nov Nov Nov Nov 19 12 12 12 12 12 12 12 12 12 12 12 12 19 11 12 19 19 12 12 12 10 12 12 17:07:44 13:29:48 15:38:59 13:31:30 13:31:34 13:31:50 13:32:32 13:32:44 13:36:56 13:37:34 13:38:08 13:38:20 13:39:08 17:21:00 09:36:16 14:21:28 17:24:24 17:24:24 15:39:04 10:47:48 15:39:04 23:37:40 14:10:12 15:38:59 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 LOST.DIR c12k-lc-os-mbi-3.2.00 instdb c12k-lc-base-3.2.00 c12k-lc-admin-3.2.00 c12k-lc-fwdg-3.2.00 c12k-lc-lc-3.2.00 c12k-rp-os-mbi-3.2.00 c12k-rp-base-3.2.00 c12k-rp-admin-3.2.00 c12k-rp-fwdg-3.2.00 c12k-rp-lc-3.2.00 c12k-rp-rout-3.2.00 shutdown config aaa usr var sam_certdb c12k-mini.vm-3.2.00.1i sam_crldb dumper c12k-rp-k9sec-3.2.00 c12k-rp-mgbl-3.2.00

1024507904 bytes total (807059456 bytes free)

The package being activated must be compatible with the currently active software to operate. When an activation is attempted, the system runs an automatic compatibility check to ensure the package is compatible with the other active software on the router. The activation is permitted only after all compatibility checks have passed.

Tip

When activating packages, use the test option to test the effects of a command without impacting the running system. After the activation process completes, enter the show install log command to display the process results. To view an example of an activation with the test option and the information you can display, see Activating and Testing a Package on the Router: Example section on page 5-38. The following example shows the activation of the Security package on a Cisco XR 12000 Series Router:
RP/0/0/CPU0:router(admin)# install activate disk0:c12k-rp-k9sec-3.2.00 Install: The idle timeout on this line will be suspended for synchronous install operations Install: Starting install operation. Do not insert or remove cards until the ope ration completes. RP/0/0/CPU0:router(admin)# Install: Now operating in asynchronous mode. Do not attempt subsequent install o perations until this operation is complete.

Cisco IOS XR Getting Started Guide

5-31

Chapter 5 Package Management Procedures

Managing Cisco IOS XR Software Packages

Install 3: [ 0%] Install operation 'activate disk0:c12k-rp-k9sec-3.2.00' assign ed request id: 3 Install 3: [ 1%] Performing Inter-Package Card/Node/Scope Version Dependency Ch ecks Install 3: [ 1%] [OK] Install 3: [ 1%] Checking API compatibility in software configurations... Install 3: [ 1%] [OK] Install 3: [ 10%] Updating software configurations. Install 3: [ 10%] RP,DRP: Install 3: [ 10%] Activating c12k-rp-k9sec-3.2.00 Install 3: [ 10%] Checking running configuration version compatibility with newl y activated software ... Install 3: [ 10%] No incompatibilities found between the activated software and router running configuration. Install 3: [ 10%] Node 0/0/CPU0: 6 c12k-rp-k9sec processes affected (0 updated, 6 added, 0 removed, 0 impacted) Install 3: [ 55%] Downloading packages to impacted nodes Install 3: [ 55%] Successfully downloaded packages to impacted nodesRP/0/0/CPU0: Nov 12 14:23:21.188 : instdir[181]: %INSTMGR-6-SOFTWARE_CHANGE_START : Software change transaction 3 is BEGINNING... Install 3: [ 55%] Performing software change

This product contains cryptographic features and is subject to United States and local country laws governing import, export, transfer and use. Delivery of Cisco cryptographic products does not imply third-party authority to import, export, distribute or use encryption. Importers, exporters, distributors and users are responsible for compliance with U.S. and local country laws. By using this product you agree to comply with applicable laws and regulations. If you are unable to comply with U.S. and local laws, return this product immediately. A summary of U.S. laws governing Cisco cryptographic products may be found at: http://www.cisco.com/wwl/export/crypto/tool/stqrg.html If you require further assistance please contact us by sending email to export@cisco.com.

RP/0/0/CPU0:Nov 12 14:24:01.249 : instdir[181]: %INSTMGR-6-SOFTWARE_CHANGE_END : Software change transaction 3 is COMPLETE. Install 3: [100%] Performing software change Install 3: [100%] Activation operation successful. Install 3: [100%] NOTE: The changes made to software configurations will not be Install 3: [100%] persistent across RP reloads. Use the command 'install commit' Install 3: [100%] to make changes persistent. Install 3: [100%] Idle timeout on this line will now be resumed for synchronous install operations

Activating a Package for a Single Card


To activate a package or an SMU for a specific card (node), enter the install activate command with the location option. The following command syntax is used in admin EXEC mode: install activate device:package location nodeID

Cisco IOS XR Getting Started Guide

5-32

Chapter 5

Managing Cisco IOS XR Software Packages Package Management Procedures

The following example shows the activation of the routing package on a single card:
RP/0/0/CPU0:router(admin)# install activate disk0:hfr-rout-1.0.0 location 0/2/CPU0

Tip

When activating packages, use the test option to test the effects of a command without impacting the running system. After the activation process completes, enter the show install log command to display the process results. To view an example of an activation with the test option and the information you can display, see the Activating and Testing a Package on the Router: Example section on page 5-38.

Adding and Activating Package Files in One Step from a Network Server
Packages can be added to the router and activated with a single command by attaching the activate option to the install add command. The commands listed in Table 5-9 show how to add and activate package files on the router from three types of network file servers.
Table 5-9 Syntax for Adding and Activating Package Files on the Router

Server Type TFTP

Command and Example The following command syntax is used in admin EXEC mode: install add tftp://hostname_or_ipaddress/directory-path/pie-name to target-device activate Example:
RP/0/RP0/CPU0:router(admin)# install add tftp://10.1.1.1/images/hfr-k9sec-p.pie to disk0: activate

FTP

The following command syntax is used in admin EXEC mode: install add ftp://username:password@hostname_or_ipaddress/directory-path/pie-name to target-device activate Example:
RP/0/RP0/CPU0:router(admin)# install add ftp://john:secret@10.1.1.1/images/hfr-k9sec-p.pie to disk0: activate

rcp

The following command syntax is used in admin EXEC mode: install add rcp://username@hostname_or_ipaddress/directory-path/pie-name to target-device activate Example:
RP/0/RP0/CPU0:router(admin)# install add rcp://john@10.1.1.1/images/gsr-k9sec-p.pie to disk0: activate

Tip

When activating packages, use the test option to test the effects of a command without impacting the running system. After the activation process completes, enter the show install log command to display the process results. To view an example of an activation with the test option and the information you can display, see the Activating and Testing a Package on the Router: Example section on page 5-38.

Cisco IOS XR Getting Started Guide

5-33

Chapter 5 Package Management Procedures

Managing Cisco IOS XR Software Packages

Rolling Back to the Last Committed Package Set


To roll back to the last committed package set, enter the install rollback committed command in admin EXEC mode.

Tip

To display the committed package versions, enter the show install committed command. In the following example, the system is rolled back to the last committed package set:
RP/0/0/CPU0:router(admin)# install rollback committed Install: The idle timeout on this line will be suspended for synchronous install operations Install: Starting install operation. Do not insert or remove cards until the ope ration completes. RP/0/0/CPU0:router(admin)# Install: Now operating in asynchronous mode. Do not attempt subsequent install o perations until this operation is complete. Install 5: [ 0%] Install operation 'rollback committed' assigned request id: 5 Install 5: [ 10%] Updating software configurations. Install 5: [ 10%] RP,DRP: Install 5: [ 10%] Deactivating c12k-rp-k9sec-3.2.00 Install 5: [ 10%] Checking running configuration version compatibility with newl y activated software ... Install 5: [ 10%] No incompatibilities found between the activated software and router running configuration. Install 5: [ 10%] Node 0/0/CPU0: 6 c12k-rp-k9sec processes affected (0 updated, 0 added, 6 removed, 0 impacted) Install 5: [ 55%] Downloading packages to impacted nodes Install 5: [ 55%] Successfully downloaded packages to impacted nodesRP/0/0/CPU0: Nov 14 08:36:46.502 : instdir[181]: %INSTMGR-6-SOFTWARE_CHANGE_START : Software change transaction 5 is BEGINNING... P/0/0/CPU0:Nov 14 08:37:25.920 : instdir[181]: %INSTMGR-6-SOFTWARE_CHANGE_END : Software change transaction 5 is COMPLETE. [2KInstall 5: [100%] Performing software change Install 5: [100%] Rollback operation successful. Install 5: [100%] NOTE: The changes made to software configurations will not be Install 5: [100%] persistent across RP reloads. Use the command 'install commit' Install 5: [100%] to make changes persistent. Install 5: [100%] Idle timeout on this line will now be resumed for synchronous install operations

Displaying Noncommitted Rollback Points


A noncommitted rollback point is created every time a software package is activated or deactivated. Beginning with Release 3.0, you can roll back the router to noncommitted rollback points. To display the eligible noncommitted rollback points, enter the show install rollback ? command as follows:
RP/0/0/CPU0:router# show install rollback ? 0 5 ID of the rollback point to show package information for ID of the rollback point to show package information for

Cisco IOS XR Getting Started Guide

5-34

Chapter 5

Managing Cisco IOS XR Software Packages Package Management Procedures

In this example, the valid noncommitted rollback points are 0 and 5. To display the package versions associated with one of these rollback points, enter the show install rollback command with the rollback point number as follows:
RP/0/0/CPU0:router# show install rollback 5 Node 0/0/CPU0 [RP] Boot Image: /c12k-rp-os-mbi-3.2.00/mbiprp-rp.vm Active Packages: mem:c12k-rp-k9sec-3.2.00 mem:c12k-mini-3.2.00 Node 0/3/CPU0 [LC(E3-OC3-POS-8)] Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: mem:c12k-mini-3.2.00 Node 0/4/CPU0 [LC(E3-GE-4)] Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: mem:c12k-mini-3.2.00 Node 0/5/CPU0 [LC(E3-GE-4)] Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: mem:c12k-mini-3.2.00 Node 0/6/CPU0 [LC(E3-OC48-POS)] Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: mem:c12k-mini-3.2.00 Node 0/7/CPU0 [LC(E3-GE-4)] Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: mem:c12k-mini-3.2.00 Node 0/8/CPU0 [LC(E3-OC12-POS-4)] Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucode Active Packages: mem:c12k-mini-3.2.00

Rolling Back to a Noncommitted Rollback Point


Beginning in Release 3.0, you can roll back the system to noncommitted rollback points, which are described in the Displaying Noncommitted Rollback Points section on page 5-34. To roll back to a noncommitted rollback point, enter the install rollback command in admin EXEC mode with the rollback point number.

Note

If you roll back to the most recent noncommitted rollback point (with the highest number), you do not need to reload the router. You can repeat the rollback process one rollback point at a time without reloading if you always choose the most recent rollback point. However, if you choose a rollback point that is older than the most recent point, you must enter the install rollback command with the reload option, which reloads the router and interrupts traffic.

Cisco IOS XR Getting Started Guide

5-35

Chapter 5 Package Management Procedures

Managing Cisco IOS XR Software Packages

Tip

To display the noncommitted rollback points, enter the show install rollback ? command. In the following example, the system is rolled back to noncommitted rollback point 0:
RP/0/0/CPU0:router(admin)# install rollback 0 Install: The idle timeout on this line will be suspended for synchronous install operations Install: Starting install operation. Do not insert or remove cards until the ope ration completes. RP/0/0/CPU0:router(admin)# Install: Now operating in asynchronous mode. Do not attempt subsequent install o perations until this operation is complete. Install 8: [ 0%] Install operation 'rollback 0' assigned request id: 8 Install 8: [ 10%] Updating software configurations. Install 8: [ 10%] RP,DRP: Install 8: [ 10%] Deactivating c12k-rp-k9sec-3.2.00 Install 8: [ 10%] Checking running configuration version compatibility with newl y activated software ... Install 8: [ 10%] No incompatibilities found between the activated software and router running configuration. Install 8: [ 10%] Node 0/0/CPU0: 6 c12k-rp-k9sec processes affected (0 updated, 0 added, 6 removed, 0 impacted) Install 8: [ 55%] Downloading packages to impacted nodes Install 8: [ 55%] Successfully downloaded packages to impacted nodes Install 8: [100%] Performing software change Install 8: [100%] Rollback operation successful. Install 8: [100%] NOTE: The changes made to software configurations will not be Install 8: [100%] persistent across RP reloads. Use the command 'install commit' Install 8: [100%] to make changes persistent. Install 8: [100%] Idle timeout on this line will now be resumed for synchronous install operations

Committing the Active Package Set


To make the current active package set persistent across router reloads, enter the install commit command in admin EXEC mode. The following example shows the commitment of the active software on a Cisco XR 12000 Series Router:
RP/0/0/CPU0:router(admin)# install commit Install: The idle timeout on this line will be suspended for synchronous install operations Install 6: [ 1%] Install operation 'commit' assigned request id: 6 Install 6: [100%] Committing uncommitted changes in software configuratons. Install 6: [100%] Commit operation successful. Install 6: [100%] Idle timeout on this line will now be resumed for synchronous install operations

Note

If the system is reloaded before the current active software is made persistent with the install commit command, the previously committed software set is used.

Cisco IOS XR Getting Started Guide

5-36

Chapter 5

Managing Cisco IOS XR Software Packages Configuration Examples for Managing Packages

Deactivating a Package
When you deactivate a package, the package features are unavailable to the router. The package is still installed and can be activated later. To deactivate a package, enter the install deactivate command in admin EXEC mode, as shown in the following example:
RP/0/0/CPU0:router(admin)# install deactivate disk0:c12k-rp-mgbl-3.90 Install: The idle timeout on this line will be suspended for synchronous install operations Install: Starting install operation. Do not insert or remove cards until the ope ration completes. RP/0/0/CPU0:router(admin)# Install: Now operating in asynchronous mode. Do not attempt subsequent install o perations until this operation is complete. Install 8: [ 0%] Install operation 'deactivate disk0:c12k-rp-mgbl-3.2.00' assig ned request id: 8 Install 8: [ 1%] Package 'disk0:c12k-rp-mgbl-3.2.00' is not active and cannot b e deactivated. Install 8: [ 1%] Idle timeout on this line will now be resumed for synchronous install operations

Removing Inactive Packages from the Router


To remove a package or an SMU from the router, you must first deactivate the package and commit the new active software set so it does not include the package. The three steps to remove inactive software are as follows:
1. 2. 3.

install deactivate package install commit install remove package

Packages can be removed only if they are deactivated from all cards. A package cannot be deactivated if that package is required by another active package. When a deactivation is attempted, the system runs an automatic check to ensure that the package is not required by other active packages. The deactivation is permitted only after all compatibility checks have passed.

Tip

To preview the impact of a deactivation, enter the test option with the install deactivate command to display the results of the action without impacting the router.

Configuration Examples for Managing Packages


This section provides the following package management examples:

Activating and Testing a Package on the Router: Example, page 5-38

Cisco IOS XR Getting Started Guide

5-37

Chapter 5 Configuration Examples for Managing Packages

Managing Cisco IOS XR Software Packages

Activating and Testing a Package on the Router: Example


To preview the impact of a package activation, enter the install activate command in admin EXEC mode with the test option. The test option displays the results of the operation without impacting the router. This option also assigns a request ID to the action, which can be used with the show install log requestID command to display the details of the test operation. For example:
RP/0/0/CPU0:router(admin)# install activate disk0:c12k-rp-mgbl-3.2.00 test Install: The idle timeout on this line will be suspended for synchronous install operations Install: Starting install operation. Do not insert or remove cards until the ope ration completes. RP/0/0/CPU0:router(admin)# Install: Now operating in asynchronous mode. Do not attempt subsequent install o perations until this operation is complete. Install 6: [ 0%] Install operation 'activate disk0:c12k-rp-mgbl-3.2.00 test' as signed request id: 6 Install 6: [ 1%] WARNING! No changes will occur due to 'test' option. Install 6: [ 1%] WARNING! The following is the predicted output for this instal l command. Install 6: [ 1%] Performing Inter-Package Card/Node/Scope Version Dependency Ch ecks Install 6: [ 1%] [OK] Install 6: [ 1%] Checking API compatibility in software configurations... Install 6: [ 1%] [OK] Install 6: [ 10%] Updating software configurations. Install 6: [ 10%] RP: Install 6: [ 10%] Activating c12k-rp-mgbl-3.2.00 Install 6: [ 10%] WARNING! No incompatible configuration will be removed due to the 'test' option Install 6: [ 10%] Checking running configuration version compatibility with newl y activated software ... Install 6: [ 10%] No incompatibilities found between the activated software and router running configuration. Install 6: [ 10%] Node 0/0/CPU0: 5 c12k-rp-mgbl processes affected (0 updated, 5 added, 0 removed, 0 impacted) Install 6: [ 10%] Activation operation successful. Install 6: [ 10%] NOTE: The changes made to software configurations will not be Install 6: [ 10%] persistent across RP reloads. Use the command 'install commit' Install Install Install install 6: [ 10%] to make changes persistent. 6: [ 10%] WARNING! No changes have occured due to 'test' option. 6: [ 10%] Idle timeout on this line will now be resumed for synchronous operations

RP/0/0/CPU0:router(admin)# show install log 6 Request id 6 by lab at Thu Dec 02 06:38:24 2004: 1 package activated: disk0:c12k-rp-mgbl-3.2.00 test Summary: Node 0/0/CPU0: 5 c12k-rp-mgbl processes affected (0 updated, 5 added, 0 removed, 0 impacted)

Cisco IOS XR Getting Started Guide

5-38

Chapter 5

Managing Cisco IOS XR Software Packages Configuration Examples for Managing Packages

Status Information Logs: WARNING! No changes will occur due to 'test' option. WARNING! The following is the predicted output for this install command. Performing Inter-Package Card/Node/Scope Version Dependency Checks [OK] Checking API compatibility in software configurations... [OK] Updating software configurations. RP: Activating c12k-rp-mgbl-3.2.00 WARNING! No incompatible configuration will be removed due to the 'test' option Checking running configuration version compatibility with newly activate d software ... No incompatibilities found between the activated software and router run ning configuration. Node 0/0/CPU0: 5 c12k-rp-mgbl processes affected (0 updated, 5 added, 0 removed, 0 impacted) Activation operation successful. NOTE: The changes made to software configurations will not be persistent across RP reloads. Use the command 'install commit' to make changes persistent. WARNING! No changes have occured due to 'test' option. Installation changes: Installation changes on node 0/0/CPU0: Adding executable: monitor_interface Adding and starting process: pm_collector Adding and starting process: pm_server Adding and starting process: snmppingd Adding executable: xml_demo_agent Adding and starting process: xmlagent Adding file: sh_ciscosensormib_ns_cfg__api.configinfo Adding file: sh_emweb_ns_cfg__api.configinfo Adding file: sh_frucontrolmib_ns_cfg__api.configinfo Adding file: sh_perfmgmt_ns_cfg__api.configinfo Adding file: sh_xmlagent_ns_cfg__api.configinfo Adding file: comm.jar Adding file: comm.jar.nonwindows Adding file: craft.html Adding file: cwi.xml Adding file: cwi_desktop.jar Adding file: cwi_help.zip Adding file: cwi_if.jar Adding file: cwi_ne.jar Adding file: cwi_tools.jar Adding file: javax.comm.properties Adding file: launcher.jar Adding file: libSerial.so.linux Adding file: librxtxSerial.jnilib.mac Adding file: orb.jar Adding file: win32com.dll.win Adding file: md5_manifest Adding DLL: libhttperr.dll Adding DLL: libpm_error.dll Adding DLL: libtaoorbutils.dll Adding DLL: libxmlcfgmgrdebug.dll Adding DLL: libxmlcfgmgrerror.dll Adding DLL: libxmlcfgmgrops.dll Adding DLL: libxmlclierror.dll Adding DLL: libxmlcliops.dll Adding DLL: libxmlmdadebug.dll

Cisco IOS XR Getting Started Guide

5-39

Chapter 5 Configuration Examples for Managing Packages

Managing Cisco IOS XR Software Packages

Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding Adding

DLL: libxmlmdaerror.dll DLL: libxmlmdaops.dll DLL: libxmlmdatrans.dll DLL: libxmlservice.dll DLL: libxmlserviceerror.dll DLL: libxmltarcfg.dll DLL: libbulkfilemib.dll DLL: libciscoassetmib.dll DLL: libciscosensormib.dll DLL: libfrucontrolmib.dll DLL: libftpclientmib.dll DLL: libpingmib.dll file: crs-mgbl--1.info file: crs-mgbl--10.info file: crs-mgbl--11.info file: crs-mgbl--12.info file: crs-mgbl--13.info file: crs-mgbl--14.info file: crs-mgbl--15.info file: crs-mgbl--16.info file: crs-mgbl--2.info file: crs-mgbl--3.info file: crs-mgbl--4.info file: crs-mgbl--5.info file: crs-mgbl--6.info file: crs-mgbl--7.info file: crs-mgbl--8.info file: crs-mgbl--9.info file: bulkfile.mib file: ciscoasset.mib file: ciscosensor.mib file: frucontrol.mib file: ftpclient.mib file: ping.mib file: bulkfilemib_cmds.parser file: cfg_emorb_cmds.parser file: cfg_emorb_xmlagent.parser file: cfg_perfmgmt.parser file: ciscoassetmib_cmds.parser file: ciscosensormib_cmds.parser file: frucontrolmib_cmds.parser file: ftpclientmib_cmds.parser file: http_cfg_cmds.parser file: http_debug_cmds.parser file: oper_perfmgmt.parser file: pingmib_cmds.parser file: xml_cfgmgr_debug.parser file: xml_cli_debug.parser file: xml_infra_debug.parser file: xml_mda_debug.parser file: sh_mgbl_ns_cfg__api.partitioninfo and starting process: emweb file: manageability_perf_cfg_common.schema file: manageability_perf_enable_monitor_cfg.schema file: manageability_perf_enable_stats_cfg.schema file: manageability_perf_enable_thresh_cfg.schema file: manageability_perf_oper.schema file: manageability_perf_stats_cfg.schema file: manageability_perf_thresh_cfg.schema file: httpd.startup file: pingmib.startup file: pm_collector.startup file: pm_server.startup

Cisco IOS XR Getting Started Guide

5-40

Chapter 5

Managing Cisco IOS XR Software Packages Configuration Examples for Managing Packages

Adding file: xmlagent.startup Replacing file: package_compatibility Installation impact details: Output format: <Level> (<Impact>:<Note>) <Name> <Type>[package:component] Level : the distance from the process along the DLL dependency chai n Impact acted: C modified; A added; R removed; I impacted by its dependencies Note : blank, or one of these annotations: d duplicate (this DLL has already been listed previously for this pr ocess) s self-managing (this server self-manages changes in its dependencie s Name : the name of this server or DLL Type : "server" or "DLL" Package : the Package containing this server or DLL Component: the source code component containing this server or DLL Node class: RP 1 node(s): 0/0/CPU0 5 New Servers to be started 0 (A: ) pm_collector nageability-perf] 0 (A: ) pm_server nageability-perf] 0 (A: ) snmppingd mp-pingmib] 0 (A: ) xmlagent neric-xmlagent] 0 (A: ) emweb web] : a one character indication of how this server or DLL is imp

server [c12k-rp-mgbl:ma server [c12k-rp-mgbl:ma server [c12k-rp-mgbl:sn server [c12k-rp-mgbl:ge server [c12k-rp-mgbl:em

Cisco IOS XR Getting Started Guide

5-41

Chapter 5 Configuration Examples for Managing Packages

Managing Cisco IOS XR Software Packages

Cisco IOS XR Getting Started Guide

5-42

C H A P T E R

Managing the Router Hardware


This chapter describes the command-line interface (CLI) techniques and commands used to manage and configure the hardware components of a router running the Cisco IOS XR software.

Contents
This chapter contains the following sections:

Displaying Hardware Status, page 6-1 RP Redundancy and Switchover, page 6-8 Reloading, Shutting Down, or Power Cycling a Node, page 6-12 Using Controller Commands to Manage Hardware Components, page 6-15 Formatting Hard Drives, Flash Drives, and Other Storage Devices, page 6-16 Removing and Replacing Cards, page 6-16

Displaying Hardware Status


The following sections describe how to display different types of hardware status information:

Displaying Hardware Version Information, page 6-1 Displaying Software and Hardware Information, page 6-3 Displaying Node IDs and Status, page 6-3 Displaying Router Environment Information, page 6-5 Displaying RP Redundancy Status, page 6-8

Displaying Hardware Version Information


The show diag command displays detailed information on the hardware components for each node. This information includes the card serial number and the ROMMON software version. The syntax for the show diag command is: show diag [nodeID | details | summary]

Cisco IOS XR Getting Started Guide

6-1

Chapter 6 Displaying Hardware Status

Managing the Router Hardware

Tip

For information on the software version, use the show version command. In the following example, the show diag command displays information for all nodes:
RP/0/RP0/CPU0:Router# show diag NODE 0/0/SP : MSC(SP) MAIN: type 500060, 0800-019840-1033 rev 01 dev 010cd8 HW version 0.0 S/N SAD07290129 PCA: 0073-007648-04 rev 08 Board State : IOS-XR RUN PLD: Motherboard: 0xf425, Processor: 0x0000, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.15(20040603:013227) [CRS-1 ROMMON]

NODE 0/0/CPU0 : MSC(16OC48-POS/DPT) MAIN: type 500060, 0800-019840-1033 rev 01 dev 010cd8 HW version 0.0 S/N SAD07290129 PCA: 0073-007648-04 rev 08 Board State : IOS-XR RUN PLD: Motherboard: 0x0025, Processor: 0xda13, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.15(20040603:013406) [CRS-1 ROMMON]

NODE 0/2/SP : 4OC192-POS/DPT PLIM PRESENT NODE 0/3/SP : MSC(SP) MAIN: type 500060, 0800-025021-259 rev 01 dev 000000 HW version 0.0 S/N SAD074907X6 PCA: 0073-007648-06 rev 11 Board State : IOS-XR RUN PLD: Motherboard: 0xfa25, Processor: 0x0000, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.15(20040603:013227) [CRS-1 ROMMON]

NODE 0/3/CPU0 : MSC(16OC48-POS/DPT) MAIN: type 500060, 0800-025021-259 rev 01 dev 000000 HW version 0.0 S/N SAD074907X6 PCA: 0073-007648-06 rev 11 Board State : IOS-XR RUN PLD: Motherboard: 0x0025, Processor: 0xda13, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.15(20040603:013406) [CRS-1 ROMMON]

NODE 0/RP0/CPU0 : RP MAIN: type 100000, 0000-000000-00 rev 01 dev 000000 HW version 0.0 S/N SAD07150223 PCA: 0073-007641-04 rev 05 Board State : IOS-XR RUN PLD: Motherboard: 0x0018, Processor: 0xda13, Power: 0x001f MONLIB: QNXFFS Monlib Version 2.1 ROMMON: Version 1.15(20040603:013406) [CRS-1 ROMMON]

Note

Line cards in Cisco CRS-1s are called modular services cards (MSCs). The show diag command output is different for Cisco CRS-1s and Cisco XR 12000 Series Routers.

Cisco IOS XR Getting Started Guide

6-2

Chapter 6

Managing the Router Hardware Displaying Hardware Status

In the following example, the show diag command displays information for a single node:
RP/0/RP0/CPU0:router# show diag 0/2/cpu0 RACK 0 SLOT 2 : MSC(16OC48-POS/DPT) MAIN: type 500060, 0000-000000-00 rev 00 dev 000000 HW version 0.0 S/N SAD0719013M PCA: 0073-007648-04 rev 07 Board State : IOS-XR RUN PLD: Motherboard: 0x0024, Processor: 0xda12, Power: 0xf100 MONLIB: QNXFFS Monlib Version 2.1 ROMMON: Version 1.15(20040120:002937) [CRS-1 ROMMON]

Displaying Software and Hardware Information


The show version command displays a variety of system information, including the hardware and software versions, router uptime, boot settings (including the configuration register), and active software. The syntax for the show version command is: show version The following is sample output from the show version command:
RP/0/RP0/CPU0:router# show version Cisco IOS-XR Software, Version 1.0.0 Copyright (c) 2004 by cisco Systems, Inc. ROM: System Bootstrap, Version 1.15(20040120:002852) , router uptime is 2 days, 1 hour, 59 minutes System image file is "tftp://223.0.0.0/usr/comp-hfr-full.vm-1.0.0 cisco CRS-16/S (7450) processor with 2097152K bytes of memory. 7450 processor at 650Mhz, Implementation , Revision 4 Packet over SONET network interface(s) 4 SONET/SDH Port controller(s) 1 Ethernet/IEEE 802.3 interface(s) 2043k bytes of non-volatile configuration memory. 1000592k bytes of ATA PCMCIA card at disk 0 (Sector size 512 bytes). Configuration register is 0x0 Package active on node 0/2/SP: hfr-admin, V 1.0.0, Cisco Systems, at mem:hfr-admin-1.0.0 Built on Fri Mar 5 19:12:26 PST 2004 --More--

Displaying Node IDs and Status


The show platform command displays the operation and configuration status of router nodes. This command also displays the card type that hosts each node and the node IDs for all nodes. To display information on a single node, enter the command with a node ID. The syntax for the show platform command on Cisco CRS-1s is: show platform [nodeID]

Cisco IOS XR Getting Started Guide

6-3

Chapter 6 Displaying Hardware Status

Managing the Router Hardware

The syntax for the show platform command on Cisco XR 12000 Series Routers is: show platform The following example displays the status for all nodes in a Cisco CRS-1:
RP/0/RP0/CPU0:router# show platform Node Type PLIM State Config State ----------------------------------------------------------------------------0/0/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/0/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/2/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/2/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/RP0/CPU0 RP(Standby) N/A IOS-XR RUN PWR,NSHUT,MON 0/RP1/CPU0 RP(Active) N/A IOS-XR RUN PWR,NSHUT,MON 0/SM0/SP FC/S(SP) N/A IOS-XR RUN PWR,NSHUT,MON

Note

Line cards in Cisco CRS-1s are called modular services cards (MSCs). The show platform command output is different for Cisco CRS-1s and Cisco XR 12000 Series Routers. The nodeID appears in the rack/slot/module notation, and the nodeID components are as follows:

The rack number in a single-chassis system is always 0. The slot is the number of the physical slot in which the card is installed. The module identifies a system hardware component.

Table 6-1 summarizes the nodeID for each type of card in a Cisco CRS-1 system, and Table 6-2 summarizes the nodeID for each type of card in a Cisco XR 12000 Series Router.
Table 6-1 Node ID Components on Cisco CRS-1 Routers

Card Type (the card type to which you are issuing commands) Route processor MSC PLIM Cisco CRS-1 SPA Interface Processor (SIP)-800 1-Port OC-192c/STM-64c PoS XFP SPA 4-Port OC-3c/STM-1 PoS SPA 8-Port Gigabit Ethernet SPA Switch fabric module Alarm cards Fan controller cards

Rack (always 0 in a single-chassis system) 0 0 0 0 0

Slot (the physical slot in which the card is installed) RP0 and RP1 07 (8-slot chassis) 015 (16-slot chassis) 07 (8-slot chassis) 015 (16-slot chassis) 07 (8-slot chassis) 015 (16-slot chassis) 07 (8-slot chassis) 015 (16-slot chassis)

Module (the entity on the card that executes the commands) CPU0 SP CPU0 CPU0 0-5 (SPA module number on the Cisco CRS-1 SIP-800)

0 0 0

SF0SF3 (8-slot chassis) SM0SM7 (16-slot chassis) AM0AM1 (16-slot chassis) FC0FC1 (16-slot chassis)

service processor (SP) SP SP

Cisco IOS XR Getting Started Guide

6-4

Chapter 6

Managing the Router Hardware Displaying Hardware Status

Table 6-2

Node ID Components on Cisco XR 12000 Series Routers

Card Type (the card type to which you are issuing commands) Route processor

Rack (always 0 in a single-chassis system) 0

Slot (the logical slot number reported in command displays) 0151, 2 015
1

Module (the entity on the card that executes the commands) CPU0 CPU0 CPU0

Cisco XR 12000 and 12000 Series 0 line cards Cisco XR 12000 and 12000 Series 0 SPA Interface Processor (SIP)-600 0 1-Port 10-Gigabit Ethernet SPA 5-Port Gigabit Ethernet SPA 10-Port Gigabit Ethernet SPA 1-Port OC-192c/STM-64c PoS/RPR SPA Clock and scheduler cards (CSCs) 0 0 Switch fabric cards (SFCs) Consolidated switch fabric (CSF) 0 card
1. Depends on router model.

0151

0151

0-1 (SPA module number on the Cisco XR12000 and 12000 Series SIP-600 )

CSC 0 and 13 SFC 0, 1, 2, 3, and 4 Dedicated slot 175


3, 4

CPU0 CPU0 CPU0

2. RP pairs can be in any adjacent slot pairs as long as the even-numbered slot is the smaller slot number. For example, an RP pair can be installed in slots 0 and 1, 2 and 3, or 14 and 15. 3. Not used on Cisco XR 12404 routers. 4. Total number of SFC slots depends on router model. 5. Used only on Cisco XR 12404 routers.

Displaying Router Environment Information


The show environment command displays hardware information for the system, including fan speeds, LED indications (Cisco CRS-1s only), power supply voltage and current information, and temperatures. The syntax for the show environment command is: show environment [all | fans | leds | power-supply | table | temperatures | voltages]

Cisco IOS XR Getting Started Guide

6-5

Chapter 6 Displaying Hardware Status

Managing the Router Hardware

You can use the show environment command options to limit the detail in the command display. The following example shows the full environment status report:
RP/0/0/CPU0:router# show environment Temperature Information --------------------------------------------R/S/I 0/0/* 0/3/* 0/4/* 0/5/* 0/6/* 0/7/* 0/8/* Modules Sensor host host host host host host host host host host host host host host Inlet Hot Inlet Hot Inlet Hot Inlet Hot Hot Inlet Inlet Hot Inlet Hot Temp. (deg C) 23.0 23.0 24.0 33.0 24.5 31.5 23.5 30.5 31.5 22.5 20.0 29.5 20.5 32.0

Threshold Information --------------------------------------------R/S/I Modules Sensor Minor (Lo/Hi) --/ 55 --/ 66 --/ ---/ ---/ -2950/3500 4800/5150 4700/5300 --/ 55 --/ 66 --/ ---/ ---/ ---/ -4800/5200 4700/5300 --/ 55 --/ 66 --/ ---/ ---/ ---/ ---/ ---/ -4700/5300 Major (Lo/Hi) --/ 60 --/ 69 --/ ---/ ---/ -2900/3600 4700/5200 4500/5500 --/ 60 --/ 69 --/ ---/ ---/ ---/ -4700/5300 4600/5400 --/ 60 --/ 69 --/ ---/ ---/ ---/ ---/ ---/ -4600/5400 Critical (Lo/Hi) --/ ---/ ---/ ---/ ---/ ---/ ---/ ---/ ---/ 70 --/ 75 --/ ---/ ---/ ---/ -4600/5400 4500/5500 --/ 70 --/ 75 --/ ---/ ---/ ---/ ---/ ---/ -4500/5500

0/0/*

0/3/*

0/4/*

host host host host host host host host host host host host host host host host host host host host host host host host host

InletTemp HotTemp PLIM_V4_1.6V PLIM_V5_1.8V PLIM_V3_2.5V 3.3V 5V Mbus5V InletTemp HotTemp PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V 3.3V 5V Mbus5V InletTemp HotTemp PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V PLIM_V6_1.5V 5V 3.3V Mbus5V

Cisco IOS XR Getting Started Guide

6-6

Chapter 6

Managing the Router Hardware Displaying Hardware Status

0/5/*

0/6/*

0/7/*

0/8/*

host host host host host host host host host host host host host host host host host host host host host host host host host host host host host host host host host

InletTemp HotTemp PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V PLIM_V6_1.5V 5V 3.3V Mbus5V HotTemp InletTemp PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V 3.3V Mbus5V InletTemp HotTemp PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V PLIM_V6_1.5V 5V 3.3V Mbus5V InletTemp HotTemp PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V 3.3V 5V Mbus5V

--/ 55 --/ 66 --/ ---/ ---/ ---/ ---/ ---/ -4700/5300 --/ 66 --/ 55 --/ ---/ ---/ ---/ -4700/5300 --/ 55 --/ 66 --/ ---/ ---/ ---/ ---/ ---/ -4700/5300 --/ 55 --/ 66 --/ ---/ ---/ ---/ -4800/5200 4700/5300

--/ 60 --/ 69 --/ ---/ ---/ ---/ ---/ ---/ -4600/5400 --/ 69 --/ 60 --/ ---/ ---/ ---/ -4600/5400 --/ 60 --/ 69 --/ ---/ ---/ ---/ ---/ ---/ -4600/5400 --/ 60 --/ 69 --/ ---/ ---/ ---/ -4700/5300 4600/5400

--/ 70 --/ 75 --/ ---/ ---/ ---/ ---/ ---/ -4500/5500 --/ 75 --/ 70 --/ ---/ ---/ ---/ -4500/5500 --/ 70 --/ 75 --/ ---/ ---/ ---/ ---/ ---/ -4500/5500 --/ 70 --/ 75 --/ ---/ ---/ ---/ -4600/5400 4500/5500

Voltage Information --------------------------------------------R/S/I 0/0/* Modules Sensor host host host host host host host host host host host host host host host host host host host PLIM_V4_1.6V PLIM_V5_1.8V PLIM_V3_2.5V 3.3V 5V Mbus5V PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V 3.3V 5V Mbus5V PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V PLIM_V6_1.5V 5V 3.3V Mbus5V Voltage (mV) 1612 1804 2504 3296 5048 5048 1496 1788 2492 3284 5000 5024 1500 1796 2488 1508 4976 3288 5048 Margin nominal nominal nominal nominal nominal n/a nominal nominal nominal nominal nominal n/a nominal nominal nominal nominal nominal nominal n/a

0/3/*

0/4/*

Cisco IOS XR Getting Started Guide

6-7

Chapter 6 RP Redundancy and Switchover

Managing the Router Hardware

0/5/*

0/6/*

0/7/*

0/8/*

host host host host host host host host host host host host host host host host host host host host host host host host host

PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V PLIM_V6_1.5V 5V 3.3V Mbus5V PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V 3.3V Mbus5V PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V PLIM_V6_1.5V 5V 3.3V Mbus5V PLIM_V3_1.5V PLIM_V8_1.8V PLIM_V7_2.5V 3.3V 5V Mbus5V

1504 1792 2488 1504 4976 3284 4984 1496 1792 2476 3300 5016 1504 1796 2484 1504 4976 3276 4984 1496 1792 2492 3280 5000 5024

nominal nominal nominal nominal nominal nominal n/a nominal nominal nominal nominal n/a nominal nominal nominal nominal nominal nominal n/a nominal nominal nominal nominal nominal n/a

Displaying RP Redundancy Status


The show redundancy command displays the redundancy status of the route processors (RPs). This command also displays the boot and switch-over history for the RPs. The syntax for the show redundancy command is: show redundancy In the following example, the show redundancy command displays the redundancy status for a redundant RP pair:
RP/0/RP0/CPU0:router# show redundancy This node (0/RP0/CPU0) is in ACTIVE role Partner node (0/RP1/CPU0) is in STANDBY role Standby node in 0/RP1/CPU0 is ready Reload and boot info ---------------------RP reloaded Fri Apr 9 03:44:28 2004: 16 hours, 51 minutes ago This node booted Fri Apr 9 06:19:05 2004: 14 hours, 16 minutes ago Last switch-over Fri Apr 9 06:53:18 2004: 13 hours, 42 minutes ago Standby node boot Fri Apr 9 06:54:25 2004: 13 hours, 41 minutes ago Standby node last not ready Fri Apr 9 20:35:23 2004: 0 minutes ago Standby node last ready Fri Apr 9 20:35:23 2004: 0 minutes ago There have been 2 switch-overs since reload

RP Redundancy and Switchover


Two RPs can be installed in slots RP0 and RP1 of a line card chassis to form a redundant set (see Figure 6-1). RP redundancy is enabled by default in the Cisco IOS XR software.

Cisco IOS XR Getting Started Guide

6-8

Chapter 6

Managing the Router Hardware RP Redundancy and Switchover

Figure 6-1

Redundant Set of RPs Installed in Slots RP0 and RP1 in a 16-Slot Chassis

A0

A1

A2

AM0

B0

B1

B2

AM1 Line card Line card


116536

PLIM

PLIM

PLIM

PLIM FC0 FC1 PLIM

PLIM PLIM

PLIM PLIM

PL0 PL1 PL2 PL3

PL4 PL5 PL6 PL7

PLIM

PLIM

PLIM

PLIM RP0 RP1 PLIM

PL PL PL8 PL9 10 11

PL PL PL PL 12 13 14 15

Note: Illustration not to scale

Determining the Primary RP


During system startup, the first RP to boot with a valid Cisco IOS XR software boot package becomes the active primary RP. The primary RP can be in either slot RP0 or slot RP1. You can tell which RP is the primary RP in the following ways:

The primary RP can be identified by the green Primary LED on the faceplate of the card. The primary RP is indicated when the Primary LED is on. The slot of the primary RP is indicated in the CLI prompt. For example:
RP/0/RP1/CPU0:router#

In this example, the prompt indicates that you are communicating with the primary RP in slot RP1. See CLI Prompt section on page 2-11 for a complete description of the CLI prompt.

Enter the show redundancy command in EXEC mode to display a summary of the primary and standby RP status.

Role of the Standby RP


The second RP to boot automatically becomes the standby RP. While the primary RP manages the system and communicates with the user interface, the redundant standby RP maintains a complete backup of the software and configurations for all cards in the system. If the primary RP fails or goes off line for any reason, the standby RP immediately takes control of the system.

PLIM

PLIM

Cisco IOS XR Getting Started Guide

6-9

Chapter 6 RP Redundancy and Switchover

Managing the Router Hardware

Summary of Redundancy Commands


RP redundancy is enabled by default in the Cisco IOS XR software, but you can use the commands described in Table 6-3 to display the redundancy status of the cards or force a manual switchover.
Table 6-3 RP Redundancy Commands

Command show redundancy redundancy switchover show platform

Description Displays the redundancy status of the RPs. This command also displays the boot and switch-over history for the RPs. Forces a manual switchover to the standby RP. This command works only if the standby RP is installed and in the ready state. Displays the status for all cards in the system, including the redundancy status of the RP cards.

Automatic Switchover
Automatic switchover from the primary RP to the standby RP occurs only if the primary RP encounters a serious system error, such as the loss of a mandatory process or a hardware failure. When an automatic switchover occurs, the RPs respond as follows:

If a standby RP is installed and ready for switchover, the standby RP becomes the active primary RP. The original primary RP attempts to reboot. If the standby RP is not in ready state, then both RPs reboot. The first RP to boot successfully assumes the role of primary RP.

RP Redundancy During RP Reload


The reload command causes the primary RP to reload the Cisco IOS XR software. When an RP reload occurs, the RPs respond as follows:

If a standby RP is installed and ready for switchover, the standby RP becomes the active primary RP. The original primary RP reboots and becomes the standby RP. If the standby RP is not in the ready state, then both RPs reboot. The first RP to boot successfully assumes the role of primary RP.

Caution

You should not use the reload command to force an RP switchover because the result could be a significant loss of router operations. Instead, use the redundancy switchover command to fail over to the standby RP, then use the hw-module location nodeID reload command to reload the RP. See the Reloading, Shutting Down, or Power Cycling a Node section on page 6-12 for more information.

Cisco IOS XR Getting Started Guide

6-10

Chapter 6

Managing the Router Hardware RP Redundancy and Switchover

Manual Switchover
You can force a manual switchover from the primary RP to the standby RP using the redundancy switchover command. If a standby RP is installed and ready for switchover, the standby RP becomes the active primary RP. The original primary RP becomes the standby RP. In the following example, partial output for a successful redundancy switchover operation is shown:
RP/0/RP0/CPU0:router# show redundancy This node (0/RP0/CPU0) is in ACTIVE role Partner node (0/RP1/CPU0) is in STANDBY role Standby node in 0/RP1/CPU0 is ready . . . RP/0/RP0/CPU0:router# redundancy switchover Initializing DDR SDRAM...found 2048 MB Initializing ECC on bank 0 . . . Turning off data cache, using DDR for first time Initializing NVRAM... Testing a portion of DDR SDRAM ...done Reading ID EEPROMs ... Initializing SQUID ... Initializing PCI ... PCI0 device[1]: Vendor ID 0x10ee Configuring MPPs ... Configuring PCMCIA slots ... --More--

Cisco IOS XR Getting Started Guide

6-11

Chapter 6 Reloading, Shutting Down, or Power Cycling a Node

Managing the Router Hardware

If the standby RP is not in ready state, the switchover operation is not allowed. In the following example, partial output for a failed redundancy switchover attempt is shown:
RP/0/0/CPU0:router(admin)#show redundancy Redundancy information for node 0/0/CPU0: ========================================== Node 0/0/CPU0 is in ACTIVE role Partner node (0/1/CPU0) is in UNKNOWN role Reload and boot info ---------------------RP reloaded Thu Apr 21 16:48:48 2005: 4 hours, 49 minutes ago Active node booted Thu Apr 21 16:48:48 2005: 4 hours, 49 minutes ago There have been 0 switch-overs since reload RP/0/0/CPU0:router# redundancy switchover Switchover disallowed: Standby node is not ready.

Communicating with a Standby RP


The primary RP automatically synchronizes all system software, settings, and configurations with the standby RP. Under normal operating conditions, users communicate only with the active primary RP, as indicated in the CLI prompt. Users do not communicate directly with the standby RP. It is possible to connect a terminal directly to the Console port of the standby RP to place the card in ROM Monitor bootstrap mode or to load software directly to the standby RP. For more information on these techniques, see Appendix A, Router Recovery and Management with ROM Monitor, and Chapter 5, Managing Cisco IOS XR Software Packages.

Reloading, Shutting Down, or Power Cycling a Node


Use the commands described in this section to reload the Cisco IOS XR software on the primary RP or on any specified node in the system. This section also describes the commands used to administratively shut down a node and power a node on or off. Table 6-4 summarizes the commands described in this section.
Table 6-4 Commands to Reload, Shut Down, or Power Cycle a Node

Command hw-module location nodeID power disable

Description This command must be entered in admin configuration mode and administratively turns the power off for a Cisco XR 12000 Series Router node. The changes do not take effect until you enter the commit command. To power on a node, use the no form of this command.
Note

This command applies only to Cisco XR 12000 Series Routers and cannot be used to disable power on the RP from which the command is entered.

hw-module location nodeID reload

This command works in EXEC mode and reloads the Cisco IOS XR software on a specific node or all nodes. To specify all nodes, enter all for the nodeID. The node reloads with the current running configuration and active software set for that node.

Cisco IOS XR Getting Started Guide

6-12

Chapter 6

Managing the Router Hardware Reloading, Shutting Down, or Power Cycling a Node

Table 6-4

Commands to Reload, Shut Down, or Power Cycle a Node (continued)

Command hw-module location nodeID shutdown

Description This command must be entered in admin configuration mode and administratively shuts down a specified node on a Cisco XR 12000 Series Router. Nodes that are shut down still have power, but cannot load or operate Cisco IOS XR software. To return a node to the up state, use the no form of this command.
Note

This command applies only to Cisco XR 12000 Series Routers and cannot be used to shut down the RP from which the command is entered.

reload

Causes the primary RP to reload the Cisco IOS XR software according to the configuration register setting (for example, 0x0 to enter ROMMON bootstrap mode, 0x2 to reload the RP to EXEC mode). See the Reloading the Primary RP section on page 6-13 for more information. Displays the configuration register setting for the router.

show variables boot

Use this command in admin EXEC mode. The configuration register setting determines how the router boots during a system reset. The most common configuration register settings are:
0x2: The primary RP loads the Cisco IOS XR software and default

configuration on the next system boot. After logging in, the user can access EXEC mode.
0x0: The primary RP enters the bootstrap ROM Monitor (rommon B1>) on

the next system boot.

Reloading the Primary RP


The reload command causes the primary RP to reload the Cisco IOS XR software according to the configuration register setting. This setting determines how the primary RP acts when reloaded. This section contains instructions to reload the Cisco IOS XR software and return to EXEC mode. For instructions to use the reload command for entering ROM Monitor bootstrap mode, see Appendix A, Router Recovery and Management with ROM Monitor.

Caution

Because the reload command causes the primary RP to go offline and either reload Cisco IOS XR software or enter ROM Monitor mode, the router experiences a loss of service unless a redundant standby RP is installed and in ready state. To display the status of the standby RP, type the show redundancy command in EXEC mode.

Cisco IOS XR Getting Started Guide

6-13

Chapter 6 Reloading, Shutting Down, or Power Cycling a Node

Managing the Router Hardware

SUMMARY STEPS
1. 2. 3. 4.

show redundancy admin show variables boot (Optional) Set the configuration register value to 0x2:
a. config-register 0x2 b. commit c. end

5.

reload

DETAILED STEPS

Command or Action
Step 1

Purpose Displays the RP redundancy status.

show redundancy
Example:
RP/0/RP0/CPU0:router# show redundancy

If a standby RP is in ready redundancy state, the reload command also causes the router to gracefully fail over to the standby RP.

Step 2

admin
Example:
RP/0/RP0/CPU0:router# admin

Enters admin EXEC mode.

Step 3

show variables boot


Example:
RP/0/RP0/CPU0:router(admin)# show variables boot

Displays the configuration register setting.


Enter this command in admin EXEC mode. For normal operations, the configuration register setting is 0x2, which causes the primary RP to reload the Cisco IOS XR software. Verify that the configuration register setting is 0x2. If it is not, complete Step 3 to reset the configuration register to 0x2. For instructions on how to enter ROM Monitor bootstrap mode, see Appendix A, Router Recovery and Management with ROM Monitor.

Note

Cisco IOS XR Getting Started Guide

6-14

Chapter 6

Managing the Router Hardware Using Controller Commands to Manage Hardware Components

Command or Action
Step 4

Purpose Sets the configuration register to 0x2.

(Optional) Set the configuration register value to 0x2:


a. config-register 0x2 b. commit c. end

This step is necessary only if the register is not set to 0x2 in the running configuration.

Example:
RP/0/RP0/CPU0:router(admin)# config-register 0x2 RP/0/RP0/CPU0:router(config)# commit RP/0/RP0/CPU0:router(config)# end

Step 5

reload

Reloads the primary RP according to the configuration register setting.


Example:
RP/0/RP0/CPU0:router# reload

If the setting is 0x2, then the RP reloads the Cisco IOS XR software. If the standby RP is in ready redundancy state, the router fails over to the standby RP. If a standby RP is not installed or not in a ready state, the router experiences a loss of service while the primary RP is reloading the Cisco IOS XR software.

Administratively Shutting Down or Powering On or Off a Node


A Cisco XR 12000 Series Router node can be administratively shut down by entering the hw-module location nodeID shutdown command in admin configuration mode. A node that is shut down still has power, but cannot load or run the Cisco IOS XR software. You can also administratively turn power off for a node using the hw-module location nodeID power disable command in admin configuration mode.

Note

These commands apply only to Cisco XR 12000 Series Routers and cannot be used to disable power for the RP from which the command is entered. For more information on the use of these commands, see the Cisco IOS XR Interface and Hardware Component Command Reference.

Using Controller Commands to Manage Hardware Components


The controllers and show controllers commands are used to manage and display settings for various hardware components, including the switch fabric management, Ethernet control plane, and interface manager. These commands are primarily diagnostic and related to driver-level details. The information available with these commands varies widely and is hardware specific. For information on the use of these commands, see the Cisco IOS XR Interface and Hardware Component Command Reference.

Cisco IOS XR Getting Started Guide

6-15

Chapter 6 Formatting Hard Drives, Flash Drives, and Other Storage Devices

Managing the Router Hardware

Formatting Hard Drives, Flash Drives, and Other Storage Devices


To format a storage device on the router, use the format command in EXEC mode.
Caution

Formatting a storage device deletes all data on that device. The following command syntax is used: format filesystem: [monlib-filename] [recover] Table 6-5 describes the format command syntax.
Table 6-5 format command Syntax Description

Variable filesystem monlib-filename

Description Specifies the memory device to format, followed by a colon. The supported file systems are bootflash:, harddisk:, disk0:, and disk1:. (Optional) Names the ROM Monitor library file (monlib file) to use for formatting the bootflash. The default monlib file is the one bundled with the system software.
Note

The monlib file is used by ROMMON for accessing the file system on the medium.

recover

(Optional) Recovers any sector read errors on a flash disk (disk0: or disk1:).

In the following example, the format command is used to format the hard disk:
RP/0/RP0/CPU0:router# format harddisk:

For information on the use of these commands, see the Cisco IOS XR System Management Command Reference.

Removing and Replacing Cards


This section describes card replacement issues and procedures for the following tasks:

Removing Line Cards, MSCs, or PLIMs, page 6-17 Replacing an MSC, page 6-18 Replacing a Line Card or PLIM with the Same Media Type and Port Count, page 6-18 Replacing a Line Card or PLIM with the Same Media Type and a Different Port Count, page 6-18 Replacing a Line Card or PLIM with a Different Media Type, page 6-19 Removing and Replacing Cisco CRS-1 Switch Fabric Cards, page 6-19 Removing and Replacing CSC and SFC Cards, page 6-22 Removing and Replacing CSFC Cards, page 6-27 Adding a Standby PRP to a Cisco 12000 Series Router, page 6-28

Cisco IOS XR Getting Started Guide

6-16

Chapter 6

Managing the Router Hardware Removing and Replacing Cards

Removing Line Cards, MSCs, or PLIMs


Line cards, modular services cards (MSCs), and physical layer interface modules (PLIMs) are designed for online insertion and removal (OIR). On Cisco XR 12000 Series Routers, a line card is a single card that contains all service processing functions and physical line interfaces. On Cisco CRS-1s, the service processing functions are provided on the MSC, and the physical line interface is provided on a separate card that connects the physical lines to the MSC. The OIR feature allows you to remove and replace cards without removing power to the card or chassis. Removing a card interrupts all traffic passing through the card, but it does not remove the card configuration. When you remove a card, the configuration remains for all interfaces, but the interfaces do not appear in the output of the show interfaces command. You can view interface configurations by entering the show running-config command. The following example shows how the configuration appears when a card is removed:
RP/0/0/CPU0:router# show running-config Building configuration... hostname router router ospf 3269 area 0 interface POS0/3/0/0 cost 20 ! interface preconfigure POS0/3/0/0 ipv4 address 10.10.50.1 255.255.255.0 ! interface preconfigure POS0/3/0/1 description POS0/3/0/1 shutdown ! interface preconfigure POS0/3/0/2 description POS0/3/0/2 shutdown ! interface preconfigure POS0/3/0/3 description POS0/3/0/3 shutdown !

In this example, the MSC in slot 3 is removed, and the interface configuration for all four interfaces changes to interface preconfigure. However, the router ospf reference to a slot 3 interface does not change. If you replace a PLIM with another PLIM that uses the same media type and port count, the configuration becomes active on the replacement card. To remove the configuration for a slot after a card is removed, use the no interface preconfigure command to remove all interface configuration statements for that card in the running configuration. In addition, search the configuration for any references to the removed interfaces, such as the outer ospf reference to slot 3 in the preceding example. To remove the configuration for a slot when a card is installed, use the no interface command to remove all interface configuration statements for that card in the running configuration. In addition, search the configuration for any references to the removed interfaces. Each PLIM supports a specific media type (PoS or Ethernet, for example) and port count. If you replace a PLIM with one that supports a different media type or port count, you should review the configuration and revise it to support the replacement PLIM.

Cisco IOS XR Getting Started Guide

6-17

Chapter 6 Removing and Replacing Cards

Managing the Router Hardware

Replacing an MSC
When you replace an MSC, the guidelines in the Removing Line Cards, MSCs, or PLIMs section on page 6-17 apply. Because only one type of MSC exists, no special procedures are required for card removal and replacement.

Replacing a Line Card or PLIM with the Same Media Type and Port Count
When you replace a line card or PLIM with a card that is of the same media type and has the same port count as the replaced card, the guidelines in the Removing Line Cards, MSCs, or PLIMs section on page 6-17 apply. Because the replacement card is of the same media type and port count, no special procedures are required for card removal and replacement.

Replacing a Line Card or PLIM with the Same Media Type and a Different Port Count
When you replace a line card or PLIM with a card that is of the same media type with a different port count, the guidelines in the Removing Line Cards, MSCs, or PLIMs section on page 6-17 apply. If the new card has a greater port count than the replaced card, the configuration applies to the corresponding lower port numbers, and the ports that did not exist on the replaced card have no configuration and come up in the shutdown state. If the new card supports fewer ports, the existing configuration for the corresponding number of ports on the new card set is applied. The previous configuration for the removed ports remains in interface preconfigure state, as shown in the following example:
RP/0/0/CPU0:router# show running-config Building configuration... hostname rtp-gsr1 interface POS0/3/0/0 ipv4 address 10.10.50.1 255.255.255.0 ! interface preconfigure POS0/3/0/1 description POS0/3/0/1 shutdown ! interface preconfigure POS0/3/0/2 description POS0/3/0/2 shutdown ! interface preconfigure POS0/3/0/3 description POS0/3/0/3 shutdown !

In the preceding example, a four-port card has been replaced with a single-port card. The configuration from port 1 on the four-port card is applied to the single port on the replacement card, and the remaining port configurations change to interface preconfigure. To remove the configuration for the missing interfaces, use the no interface preconfigure command. In addition, search for and remove any configuration references to the removed interfaces. Whenever you replace a line card or PLIM with the same media type and a different port count, review the running configuration in the router and revise the configuration as necessary.

Cisco IOS XR Getting Started Guide

6-18

Chapter 6

Managing the Router Hardware Removing and Replacing Cards

Replacing a Line Card or PLIM with a Different Media Type


When you replace a line card or PLIM with a card that is of a different media type (for example, if you replace a PoS PLIM with an Ethernet PLIM), the guidelines in the Removing Line Cards, MSCs, or PLIMs section on page 6-17 apply. Review the running configuration in the router and revise the configuration as necessary for the new media type.

Removing and Replacing Cisco CRS-1 Switch Fabric Cards


To prevent traffic loss, we recommend that you shut the power down on a switch fabric card before you remove it. If a switch fabric card is removed with power on, the card is not harmed, but some traffic may be lost. When the replacement card is inserted, you can restore the power to the slot and bring up the replacement card. This section describes how to properly remove and replace switch fabric modules for upgrades or repairs.

Note

The process of removing and replacing cards while the router power is on is called online insertion and removal (OIR). This procedure removes power to a specific slot before the switch fabric card is replaced. The power remains on for all other slots.

Tip

For more information about switch fabric cards, see the hardware documentation listed in the Related Documents section on page xv. Before you remove a switch fabric card, be sure to monitor the down flags, as noted in the Purpose column. Down flags reflect the internal status of the fabric plane. The down flag states are as follows:

PThe plane has been administratively shut down by a user. pThe plane has been shut down by internal fabric software. mMulticast traffic has been shut down.

Note

This procedure does not apply when starting the router for the first time or after a power cycle or reload.

Prerequisites
You should have a working knowledge of Cisco IOS XR software and have sufficient permissions to configure the software. You must log in as root-system before starting the procedure. To confirm your login status, use the show user group command:
RP/0/RP0/CPU0:router# show user group Username: lab User group root-system User group cisco-support

Cisco IOS XR Getting Started Guide

6-19

Chapter 6 Removing and Replacing Cards

Managing the Router Hardware

To confirm your login status including root, use the show user all | include root command:
RP/0/RP0/CPU0:router# show user all | include root User group root-system Task: root-system Task: root-lr

: READ : READ

WRITE WRITE

EXECUTE EXECUTE

NOTIFY NOTIFY

SUMMARY STEPS
1. 2. 3. 4. 5. 6. 7. 8. 9.

show platform admin configure show controller fabric plane all controller fabric plane plane_number shut show controller fabric plane all no hw-module node fabric_card power commit end Remove and replace the switch fabric card.

10. hw-module node fabric_card power 11. commit 12. end 13. no controller fabric plane plane_number shut 14. show controller fabric plane all

DETAILED STEPS

Command or Action
Step 1
show platform

Purpose Displays all cards on the router.

Example:
RP/0/RP0/CPU0:router# show platform

Allows you to identify a fabric card (identified with an SM prefix). The number following the SM prefix identifies the corresponding fabric plane, as follows:
Fabric

Board
SM0 SM1 SM2 Step 2
admin configure

Fabric # 0 1 2

Enters admin configuration mode.

Example:
RP/0/RP0/CPU0:router# admin configure

Cisco IOS XR Getting Started Guide

6-20

Chapter 6

Managing the Router Hardware Removing and Replacing Cards

Command or Action
Step 3
show controller fabric plane all

Purpose Displays the status of each fabric plane.

Example:
RP/0/RP0/CPU0:router(admin-config)# show controller fabric plane all

Step 4

controller fabric plane plane_number shut

Shuts down the fabric plane.

Example:
RP/0/RP0/CPU0:router(admin-config)# controller fabric plane 1 shut

Step 5

show controller fabric plane all

Displays the status of each fabric plane.

Example:
RP/0/RP0/CPU0:router(admin-config)# show controller fabric plane all

The down flag of the show controller fabric plane command display should read P, which indicates that the down flag has been administratively shut down.

Step 6

no hw-module node fabric_card power

Shuts down the fabric card.

Example:
RP/0/RP0/CPU0:router(config)# no hw-module node 0/SM1/SP power

The down flag of the show controller fabric plane command display should read pPm.

Step 7

commit

Commits the target configuration to the router running configuration.

Example:
RP/0/RP0/CPU0:router(config)# commit

Step 8

end

Ends the configuration session and returns to EXEC mode.

Example:
RP/0/RP0/CPU0:router(config)# end

Step 9 Step 10

Remove and replace the switch fabric card.


hw-module node fabric_card power

Replaces the physical card. Brings up the new fabric card.

Example:
RP/0/RP0/CPU0:router(config)# hw-module node 0/SM1/SP power

Monitor the down flag of the plane until it reads P; then wait for 1 minute before proceeding to Step 13.

Step 11

commit

Commits the target configuration to the router running configuration.

Example:
RP/0/RP0/CPU0:router(config)# commit

Step 12

end

Ends the configuration session and returns to EXEC mode.

Example:
RP/0/RP0/CPU0:router(config)# end

Cisco IOS XR Getting Started Guide

6-21

Chapter 6 Removing and Replacing Cards

Managing the Router Hardware

Command or Action
Step 13
no controller fabric plane plane_number shut

Purpose Brings up the new fabric plane.

Example:
RP/0/RP0/CPU0:router(admin-config)# no controller fabric plane 0 shut

The Admin State and Oper State fields should read UP. The Down Flags field should not display a value.

Step 14

show controller fabric plane all

Displays the fabric plane status.

Example:
RP/0/RP0/CPU0:router(admin)# show controller fabric plane all

Examples
show controller fabric plane Command: Example

The following example shows the display for the show controller fabric plane all command:
RP/0/RP0/CPU0:router(admin-config)# show controller fabric plane all Plane Admin Oper Down Total Down Id State State Flags Bundles Bundles -------------------------------------------------------------0 UP UP 0 0 1 UP UP 0 0

Removing and Replacing CSC and SFC Cards


On Cisco XR 12000 Series Routers that use clock and scheduler cards (CSCs) and switch fabric cards (SFCs), the CSCs and SFCs work together to provide the switch fabric for the router. Although some router cards can be removed without software preparation, it is best to shut down and remove the power from a CSC or an SFC slot before removing a card. When the new card is inserted, you can restore the power to the slot and bring up the replacement card. This section describes how to properly remove and replace CSCs and SFCs for repairs.

Prerequisites
You should have a working knowledge of Cisco IOS XR software and have sufficient permissions to configure the software.

Cisco IOS XR Getting Started Guide

6-22

Chapter 6

Managing the Router Hardware Removing and Replacing Cards

You must log in as root-system before starting the procedure. To confirm your login status, use the show user group command:
RP/0/RP0/CPU0:router# show user group Username: lab User group root-system User group cisco-support

To confirm your login status including root, use the show user all | include root command:
RP/0/RP0/CPU0:router# show user all | include root User group root-system Task: root-system Task: root-lr

: READ : READ

WRITE WRITE

EXECUTE EXECUTE

NOTIFY NOTIFY

SUMMARY STEPS
1. 2. 3. 4. 5. 6. 7. 8. 9.

admin configure do show platform hw-module location slot shutdown hw-module location slot power disable commit do show platform Remove and replace the CSC or SFC. no hw-module location slot power disable commit

10. do show platform 11. no hw-module location slot shutdown 12. commit 13. do show platform

DETAILED STEPS

Command or Action
Step 1
admin configure

Purpose Enters admin configuration mode.

Example:
RP/0/0/CPU0:router# admin configure

Step 2

do show platform

Displays the state of all cards on the router.

Example:
RP/0/0/CPU0:router(admin-config)# do show platform

Allows you to identify the CSC or SFC you want to replace. Note the node ID (in the first column) for the card you want to replace. You need to enter this ID later in this procedure.

Cisco IOS XR Getting Started Guide

6-23

Chapter 6 Removing and Replacing Cards

Managing the Router Hardware

Command or Action
Step 3
hw-module location slot shutdown

Purpose Configures a slot to shut down when the configuration is committed.

Example:
RP/0/0/CPU0:router(admin-config)# hw-module location 0/16/CPU0 shutdown

Caution

Shut down only one CSC or SFC from the combined set of CSCs and SFCs at a time. For example, shut down one CSC or one SFC, but do not shut down two CSCs, two or more SFCs, or cards of both types at the same time. When shutting down a CSC, shutdown the standby CSC.

Step 4

hw-module location slot power disable

Configures a slot to power down when the configuration is committed.

Example:
RP/0/0/CPU0:router(admin-config)# hw-module location 0/16/CPU0 power disable

Step 5

commit

Commits the target configuration to the router running configuration.


Note

Example:
RP/0/0/CPU0:router(admin-config)# commit

You do not need to enter the end or exit command or press Ctrl-Z to exit admin configuration mode until the end of this procedure. If you exit admin configuration mode, you must reenter this mode to complete the procedure. Allows you to verify that the CSC or SFC you want to replace is shut down and the power is off.

Step 6

do show platform

(Optional) Displays the state of all cards on the router.

Example:
RP/0/0/CPU0:router(admin-config)# do show platform

Step 7 Step 8

Remove and replace the CSC or SFC.


no hw-module location slot power disable

Replaces the physical card. Configures a slot to power up when the configuration is committed.

Example:
RP/0/0/CPU0:router(admin-config)# no hw-module location 0/16/CPU0 power disable

Step 9

commit

Commits the target configuration to the router running configuration.

Example:
RP/0/0/CPU0:router(admin-config)# commit

Step 10

do show platform

(Optional) Displays the state of all cards on the router.

Example:
RP/0/0/CPU0:router(admin-config)# do show platform

Allows you to verify that the replacement CSC or SFC has power on.

Cisco IOS XR Getting Started Guide

6-24

Chapter 6

Managing the Router Hardware Removing and Replacing Cards

Command or Action
Step 11
no hw-module location slot shutdown

Purpose Configures a slot to start when the configuration is committed.

Example:
RP/0/0/CPU0:router(admin-config)# no hw-module location 0/16/CPU0 shutdown

Step 12

commit

Commits the target configuration to the router running configuration.

Example:
RP/0/0/CPU0:router(admin-config)# commit

Step 13

do show platform

(Optional) Displays the state of all cards on the router.

Example:
RP/0/0/CPU0:router(admin-config)# do show platform

Allows you to verify that the replacement CSC or SFC has power and has been brought up.

Examples
Replacing a CSC: Example

The following example shows commands to change a CSC:


RP/0/0/CPU0:router# admin configure RP/0/0/CPU0:router(admin-config)# do show platform Node Type PLIM State Config State ----------------------------------------------------------------------------0/0/CPU0 PRP(Active) N/A IOS-XR RUN PWR,NSHUT,MON 0/3/CPU0 L3LC Eng 3 OC3-POS-8 IOS-XR RUN PWR,NSHUT,MON 0/4/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/5/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/6/CPU0 L3LC Eng 3 OC48-POS IOS-XR RUN PWR,NSHUT,MON 0/7/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/8/CPU0 L3LC Eng 3 OC12-POS-4 IOS-XR RUN PWR,NSHUT,MON 0/16/CPU0 CSC10 N/A PWD PWR,NSHUT,MON 0/17/CPU0 CSC10(P) N/A PWD PWR,NSHUT,MON 0/18/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/19/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/20/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/21/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/22/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/24/CPU0 ALARM10 N/A PWD PWR,NSHUT,MON 0/25/CPU0 ALARM10 N/A PWD PWR,NSHUT,MON 0/29/CPU0 GSR16-BLOWER N/A PWD PWR,NSHUT,MON RP/0/0/CPU0:router(admin-config)# hw-module location 0/16/CPU0 shutdown RP/0/0/CPU0:router(admin-config)# hw-module location 0/16/CPU0 power disable RP/0/0/CPU0:router(admin-config)# commit

Cisco IOS XR Getting Started Guide

6-25

Chapter 6 Removing and Replacing Cards

Managing the Router Hardware

Primary Clock is CSC_1 Fabric Clock is Non Redundant Bandwidth Mode : Full Bandwidth RP/0/0/CPU0:router(admin-config)# do show platform Node Type PLIM State Config State ----------------------------------------------------------------------------0/0/CPU0 PRP(Active) N/A IOS-XR RUN PWR,NSHUT,MON 0/3/CPU0 L3LC Eng 3 OC3-POS-8 IOS-XR RUN PWR,NSHUT,MON 0/4/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/5/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/6/CPU0 L3LC Eng 3 OC48-POS IOS-XR RUN PWR,NSHUT,MON 0/7/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/8/CPU0 L3LC Eng 3 OC12-POS-4 IOS-XR RUN PWR,NSHUT,MON 0/16/CPU0 CSC10 N/A Admin Down NPWR,SHUT,MON 0/17/CPU0 CSC10(P) N/A PWD PWR,NSHUT,MON 0/18/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/19/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/20/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/21/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/22/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/24/CPU0 ALARM10 N/A PWD PWR,NSHUT,MON 0/25/CPU0 ALARM10 N/A PWD PWR,NSHUT,MON 0/29/CPU0 GSR16-BLOWER N/A PWD PWR,NSHUT,MON

Replace the CSC or SFC at this point.


RP/0/0/CPU0:router(admin-config)# no hw-module location 0/16/CPU0 power disable RP/0/0/CPU0:router(admin-config)# commit

Primary Clock is CSC_1 Fabric Clock is Redundant Bandwidth Mode : Full Bandwidth RP/0/0/CPU0:router(admin-config)# do show platform Node Type PLIM State Config State ----------------------------------------------------------------------------0/0/CPU0 PRP(Active) N/A IOS-XR RUN PWR,NSHUT,MON 0/3/CPU0 L3LC Eng 3 OC3-POS-8 IOS-XR RUN PWR,NSHUT,MON 0/4/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/5/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/6/CPU0 L3LC Eng 3 OC48-POS IOS-XR RUN PWR,NSHUT,MON 0/7/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/8/CPU0 L3LC Eng 3 OC12-POS-4 IOS-XR RUN PWR,NSHUT,MON 0/16/CPU0 CSC10 N/A Admin Down PWR,SHUT,MON 0/17/CPU0 CSC10(P) N/A PWD PWR,NSHUT,MON 0/18/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/19/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/20/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/21/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/22/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/24/CPU0 ALARM10 N/A PWD PWR,NSHUT,MON 0/25/CPU0 ALARM10 N/A PWD PWR,NSHUT,MON 0/29/CPU0 GSR16-BLOWER N/A PWD PWR,NSHUT,MON RP/0/0/CPU0:router(admin-config)# no hw-module location 0/16/CPU0 shutdown RP/0/0/CPU0:router(admin-config)# commit

Cisco IOS XR Getting Started Guide

6-26

Chapter 6

Managing the Router Hardware Removing and Replacing Cards

RP/0/0/CPU0:router(admin-config)# do show platform Node Type PLIM State Config State ----------------------------------------------------------------------------0/0/CPU0 PRP(Active) N/A IOS-XR RUN PWR,NSHUT,MON 0/3/CPU0 L3LC Eng 3 OC3-POS-8 IOS-XR RUN PWR,NSHUT,MON 0/4/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/5/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/6/CPU0 L3LC Eng 3 OC48-POS IOS-XR RUN PWR,NSHUT,MON 0/7/CPU0 L3LC Eng 3 GE-4 IOS-XR RUN PWR,NSHUT,MON 0/8/CPU0 L3LC Eng 3 OC12-POS-4 IOS-XR RUN PWR,NSHUT,MON 0/16/CPU0 CSC10 N/A PWD PWR,NSHUT,MON 0/17/CPU0 CSC10(P) N/A PWD PWR,NSHUT,MON 0/18/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/19/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/20/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/21/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/22/CPU0 SFC10 N/A PWD PWR,NSHUT,MON 0/24/CPU0 ALARM10 N/A PWD PWR,NSHUT,MON 0/25/CPU0 ALARM10 N/A PWD PWR,NSHUT,MON 0/29/CPU0 GSR16-BLOWER N/A PWD PWR,NSHUT,MON

Removing and Replacing CSFC Cards


On Cisco XR 12404 routers, which use consolidated switch fabric cards (CSFCs), you must power off the router before changing a CSFC card. For more information about removing and replacing CSFCs, see the hardware documentation listed in the Related Documents section on page xv.

Cisco IOS XR Getting Started Guide

6-27

Chapter 6 Removing and Replacing Cards

Managing the Router Hardware

Adding a Standby PRP to a Cisco 12000 Series Router


A second PRP card can be added to a Cisco 12000 Series Router for redundancy. To add a standby PRP, boot the card from ROMMON mode with the minimum boot image (MBI) software package. This will bring up the PRP so it can be recognized by the DSC. The new standby PRP will download the appropriate software and configurations from the DSC, and reboot. This section provides instructions to boot the standby RP after it is installed in the chassis. See the Related Documents section on page -xv for more information on installing PRP cards.

Prerequisites

The standby PRP must be installed in a slot next to the primary PRP. For example, the PRPs can be installed in slot 0and slot 1, slot 2 and slot 3, slot 4 and slot 5, slot 6 and slot 7, slot 8 and slot 9, etc.. MBI software package mbiprp-rp.vm. This package is used to boot any PRP other than the DSC, including the standby PRP and PRPs in non-owner LRs. ROMMON version bfprp_romupgrade-1.14.0.91 or higher Boothelper version c12kprp-boot-mz.120-30.S or higher The boothelper must be stored as the first file in the bootflash, or the ROMMON variable must be set to point to the boothelper. To set the ROMMON variable, enter the following command in ROM Monitor mode: BOOTLDR=bootflash:/c12kprp-boot-mz.120-30.S Each PRP must have at least 1024 MB of memory installed. The PRP-1 ships with 512 MB, and the PRP-2 ships with 1024 MB of memory. Upgrade the memory in your PRP if necesary. Flashdisks:
The recommended flashdisk setup for all PRPs is two 512MB Sandisk Flashdisk in PCMCIA

slot 0 and slot 1. The minimum requirement is one 512MB Sandisk flashdisk installed in slot 0 on every physical PRP cards in the system. PRP cards use the flashdisk to store the Cisco IOS XR software and running configurations.
The same flashdisk size must be used in all PRPs in the 12000 series router. Each flash disk must be formatted by the Cisco IOS XR software before use. To format a disk,

insert the disk into a running PRP and enter the command format disknumber:. Example: format disk0:.

Summary Steps
1.

On the standby PRP:


a. Attach a terminal to the console port, and place the PRP in ROM Monitor mode. b. unset TURBOBOOT c. unset BOOT d. sync e. boot tftp://server/directory/filename

2. 3.

Wait for boot process to complete. On the primary PRP (DSC):


a. show platform b. show redundancy

Cisco IOS XR Getting Started Guide

6-28

Chapter 6

Managing the Router Hardware Removing and Replacing Cards

DETAILED STEPS

Command or Action
Step 1

Purpose Refer to Appendix A, Router Recovery and Management with ROM Monitor for more information. Clears the TURBOBOOT variable. The TURBOBOOT variable is only used on the DSC.

On the standby PRP, attach a terminal to the console port, and place the PRP in ROM Monitor mode.
unset TURBOBOOT

Step 2

Example:
rommon># unset turboboot

Step 3

unset BOOT

Clears the boot variable.

Example:
rommon># unset BOOT

Step 4

sync

Saves the changes.

Example:
rommon># sync

Step 5

boot tftp://server/directory/filename

Retrieves the file from the TFTP server and installs it on disk0:.

Example:
rommon># boot tftp://192.168.1.1/dir/mbiprp-rp.vm

Step 6

Wait for boot process to complete.

The standby PRP will boot and all ROMMON variables (such as confreg and BOOT) will be set. Once the standby PRP is recognized by the DSC, the appropriate software will download and the standby PRP card will reload the Cisco IOS XR software from disk. Displays the standby PRP card in the screen output.

Step 7

On the primary PRP (DSC):


show platform

Example:
RP/0/0/CPU0:router# show platform

Step 8

On the primary PRP (DSC):


show redundancy

Displays the redundancy status of the standby PRP card.

Example:
RP/0/0/CPU0:router# show redundancy

Cisco IOS XR Getting Started Guide

6-29

Chapter 6 Removing and Replacing Cards

Managing the Router Hardware

Cisco IOS XR Getting Started Guide

6-30

C H A P T E R

Troubleshooting the Cisco IOS XR Software


This chapter describes the tools and procedures used to identify the source of hardware and software problems. This information can be used to resolve an issue or see more specific troubleshooting guides for help on a specific topic. This chapter also provides instructions on gathering data for further analysis by Cisco customer support representatives.

Contents
This chapter contains the following sections:

Additional Sources for Information, page 7-1 Basic Troubleshooting Commands, page 7-2 Understanding Processes and Threads, page 7-7 Configuration Error Messages, page 7-14 Memory Warnings in Configuration Sessions, page 7-15 Interfaces Not Coming Up, page 7-21

Additional Sources for Information


For additional information on troubleshooting, see the following sources:

If the Cisco IOS XR software does not start and display the EXEC mode prompt, see Appendix A, Router Recovery and Management with ROM Monitor. The Technical Assistance Center (TAC) home page, containing 30,000 pages of searchable technical content, including links to products, technologies, solutions, technical tips, and tools. Registered Cisco.com users can log in from this page to access even more content. http://www.cisco.com/public/support/tac/home.shtml The Related Documents section on page xv.

Cisco IOS XR Getting Started Guide

7-1

Chapter 7 Basic Troubleshooting Commands

Troubleshooting the Cisco IOS XR Software

Basic Troubleshooting Commands


The following sections describe some basic techniques used to determine connectivity to another device and display information on the configuration and operation of a router.

Using show Commands to Display System Status and Configuration, page 7-2 Using the ping Command, page 7-3 Using the traceroute Command, page 7-3 Using debug Commands, page 7-4

Using show Commands to Display System Status and Configuration


Use show commands to check the status of various Cisco IOS XR software subsystems and services. All show commands (except show configuration) are entered in EXEC mode. Table 7-1 lists some of the common show commands. To display a complete list of the available show commands, enter the show ? command to access the on-screen help system.
Table 7-1 Common show Commands in Cisco IOS XR Software

Command show variables boot show configuration show context (and show exception) show controller show debug

Description Displays the boot variables.


Note

This command must be entered in admin EXEC mode.

Displays the uncommitted configuration changes made during a configuration session. This command can be entered in any configuration mode. Displays context information about all recent reloads. Displays hardware controller information. Displays debug flags enabled from the current terminal.

show environment [all | fans | leds | Displays hardware information for the physical components and systems, including power-supply | table | temperatures fans, LEDs, power supply voltage and current information, and temperatures. | voltages | l] show exception show install show interfaces show logging show memory show platform show process blocked show redundancy show running-config [command] Displays all exception dump configurations. Displays installed and active software packages. Displays interface status and configuration. Displays the contents of logging buffers. Displays memory statistics. Displays information about node status on the router. Displays blocked processes. Display the status of the primary (active) route processor (RP) and the standby (redundant) RP. Displays the current running configuration. This command can be entered in either configuration or EXEC mode.

Cisco IOS XR Getting Started Guide

7-2

Chapter 7

Troubleshooting the Cisco IOS XR Software Basic Troubleshooting Commands

Table 7-1

Common show Commands in Cisco IOS XR Software (continued)

Command show tech-support

Description Collects a large amount of system information for troubleshooting. The output should be provided to technical support representatives when a problem is reported. Because of the impact the command can have on a running system, it is reserved for users assigned to the cisco-support task ID. Allows you to get a dump of all unsolicited debug messages that contained traceback information (that is, a list of program counters back from the line of code generating the message) along with the dynamic link library (DLL) information necessary to decode the traceback. Displays the username for the current logged-in user. Use this command to also display the groups and associated task IDs assigned to the account. Displays basic system information.

show tracebacks

show user [group | tasks | all] show version

Using the ping Command


Use the ping command to diagnose network connectivity. Enter a hostname or an IP address as an argument to this command. The ping command sends an echo request packet to an address, then awaits a reply. Ping output can help you evaluate path-to-host reliability, delays over the path, and whether the host can be reached or is functioning. Each exclamation point (!) indicates receipt of a reply. A period (.) indicates the network server timed out while waiting for a reply. Other characters may appear in the ping output display, depending on the protocol type.

Examples
In the following example, a successful ping attempt is shown:
RP/0/RP0/CPU0:router# ping 10.233.233.233 Type escape sequence to abort. Sending 5, 100-byte ICMP Echos to 10.233.233.233, timeout is 2 seconds: !!!!! Success rate is 100 percent (5/5), round-trip min/avg/max = 1/2/7 ms In the following example, an unsuccessful ping attempt is shown: RP/0/RP0/CPU0:router# ping 10.1.1.1 Type escape sequence to abort. Sending 5, 100-byte ICMP Echos to 10.1.1.1, timeout is 2 seconds: ..... Success rate is 0 percent (0/5)

Using the traceroute Command


Use the traceroute command to discover the routes that packets take when traveling to their destination. Enter a hostname or an IP address as an argument to this command.

Cisco IOS XR Getting Started Guide

7-3

Chapter 7 Basic Troubleshooting Commands

Troubleshooting the Cisco IOS XR Software

This command works by taking advantage of the error messages generated by routers when a datagram exceeds its time-to-live (TTL) value. The traceroute command starts by sending probe datagrams with a TTL value of 1, causing the first router to discard the probe datagram and send back an error message. The traceroute command sends several probes at each TTL level and displays the round-trip time for each. The traceroute command sends one probe at a time. Each outgoing packet may result in one or two error messages. A time exceeded error message indicates that an intermediate router has seen and discarded the probe. A destination unreachable error message indicates that the destination node has received the probe and discarded it because it could not deliver the packet. If the timer times out before a response comes in, the traceroute command prints an asterisk (*). The traceroute command terminates when the destination responds, the maximum TTL is exceeded, or the user interrupts the trace with the escape sequence.

Examples
In the following example, the route for an IP address is displayed:
RP/0/RP0/CPU0:router# traceroute 10.233.233.233 Type escape sequence to abort. Tracing the route to 10.233.233.233 1 2 172.25.0.2 11 msec 2 msec 1 msec 192.255.254.254 1 msec * 2 msec

Using debug Commands


Debug commands are used to diagnose and resolve network problems. Use debug commands to troubleshoot specific problems or during troubleshooting sessions. Use debug commands to turn on or off debugging for a specific service or subsystem. When debugging is turned on for a service, a debug message is generated each time the debugging code section is entered. The following sections provide information on debugging:

Displaying a List of Debug Features, page 7-5 Enabling Debugging for a Feature, page 7-5 Disabling Debugging for a Service, page 7-6 Displaying Debugging Status, page 7-5

Caution

Debug commands can generate a very large amount of output and can render the system unusable. Use debug to troubleshoot specific problems or during specific troubleshooting sessions on systems that are not in production.

Cisco IOS XR Getting Started Guide

7-4

Chapter 7

Troubleshooting the Cisco IOS XR Software Basic Troubleshooting Commands

Displaying a List of Debug Features


To display a list of the available debug features, enter the debug mode and enter a ? for on-screen help. For example:
RP/0/RP0/CPU0:router# debug RP/0/RP0/CPU0:router(debug)# ? aaa adjacency adjacency aib alarm-logger arm arp asic-errors asic-scan --More-AAA Authentication, Authorization and Accounting Adjacency debug platform AIB information AIB information Turn on alarm debugging IP Address Repository Manager IP ARP transactions Debug ASIC erors Debug Asic Scan

Enabling Debugging for a Feature


To enable debugging for a feature, enter the debug command and then enable the feature for debugging. For example:
RP/0/RP0/CPU0:router# debug RP/0/RP0/CPU0:router(debug)# aaa all RP/0/RP0/CPU0:router(debug)# exit

You can also enter the complete command from EXEC mode, as shown in the following example:
RP/0/RP0/CPU0:router# debug aaa all

Displaying Debugging Status


Enter the show debug command to display the debugging features enabled for your terminal session. The terminal session is labeled tty and represents your connection to the router through a specific port, which might be the console port, auxiliary port, or Management Ethernet interface. In the following example, the command display indicates that debugging is enabled for two features (AAA and ipv4 io icmp) from a terminal session on the console port of RP1:
RP/0/RP0/CPU0:router# show debug #### debug flags set from tty 'con0_RP1_CPU0' aaa all flag is ON ipv4 io icmp flag is ON RP/0/RP0/CPU0:router# no debug aaa all RP/0/RP0/CPU0:router# show debug #### debug flags set from tty 'con0_RP1_CPU0' ipv4 io icmp flag is ON #### ####

The preceding example is for a Cisco CRS-1. On a Cisco XR 12000 Series Router, the slot number of the tty ID is 0 or 1 instead of RP0 or RP1.

Cisco IOS XR Getting Started Guide

7-5

Chapter 7 Basic Troubleshooting Commands

Troubleshooting the Cisco IOS XR Software

Enter the show debug condition command to display the conditional debugging status. For example:
RP/0/RP0/CPU0:router# show debug conditions #### debug conditions set from tty 'con0_RP1_CPU0' #### interface condition is ON for interface 'POS0/2/0/1'

Disabling Debugging for a Service


Use the no form of the debug command or the undebug command to turn off debugging for a service or subsystem. In the following example, the no debug command disables debugging for the AAA feature:
RP/0/RP0/CPU0:router# no debug aaa all RP/0/RP0/CPU0:router# show debug #### debug flags set from tty 'con0_RP1_CPU0' ipv4 io icmp flag is ON ####

You can also turn off debugging from the undebug mode, as shown in the following example:
RP/0/RP0/CPU0:router# undebug RP/0/RP0/CPU0:router(undebug)# aaa all RP/0/RP0/CPU0:router(undebug)# exit

Disabling Debugging for All Services Started at the Active Terminal Session
Use the undebug all or no debug all command to turn off all debugging started by the active terminal session. For example, if you enter either of these commands while connected to the router through the console port on the active RP, all debug sessions started from that console port are disabled. In the following example, debugging for all services is disabled and then verified:
RP/0/RP0/CPU0:router# undebug all RP/0/RP0/CPU0:router# show debug No matching debug flags set

Disabling Debugging for All Services Started at All Terminal Sessions


Use the undebug all all-tty command to turn off debugging for all services that have been started from all terminal sessions. For example if you enter this command while connected to the router through the console port on the active RP, all debug sessions started from all ports are disabled. In the following example, debugging for all services and ports is disabled and then verified:
RP/0/0/CPU0:router# undebug all all-tty RP/0/0/CPU0:router# show debug No matching debug flags set

Cisco IOS XR Getting Started Guide

7-6

Chapter 7

Troubleshooting the Cisco IOS XR Software Understanding Processes and Threads

Understanding Processes and Threads


To achieve high availability and performance, the Cisco IOS XR software is built on a modular system of processes. Each process provides specific functionality for the system and runs in a protected memory space to ensure problems with one process cannot impact the entire system. Multiple instances of a process can run on a single node, and multiple threads of execution can run on each process instance. Table 7-2 provides a summary of terms for processes and threads in the Cisco IOS XR software.
Table 7-2 Process and Thread Syntax and Descriptions

Term Process

CLI Syntax

Description

A process is a group of threads that share a protected memory space. Processes run independently of other processes and can be individually started, restarted, or executable-name stopped. In the command-line interface (CLI) syntax, the process name (or executable-name) identifies all instances of a process on a node. Usage example: To change the core-dumping options for all instances of a process, specify the executable-name of the process.

Process name

Process instance

JID job-ID

Multiple instances of a process can run simultaneously on a node. In the CLI, the process instance is shown as the job ID. Usage example: To change the core-dumping options for only a single instance of a process, specify the job-ID of the process instance.

Thread

TID thread-ID

A thread is a unit of execution within a process. Multiple threads can run inside each instance of a process (known as multithreading). Each thread is assigned a thread ID number.

Under normal operating conditions, processes are managed automatically by the Cisco IOS XR software. Processes are started, stopped, or restarted as required by the running configuration of the router. In addition, processes are checkpointed to optimize performance during process restart and automatic switchover. Figure 7-1 illustrates how the Cisco IOS XR software manages the operations of processes and acts as a message, passing bus to coordinate interactions between processes. In this way, processes can run independently, but still communicate and cooperate with other processes. If a process needs to be stopped or restarted, it affects only that process and related processes and threads.

Cisco IOS XR Getting Started Guide

7-7

Chapter 7 Understanding Processes and Threads

Troubleshooting the Cisco IOS XR Software

Figure 7-1

Modular Process Architecture in Cisco IOS XR Software

"Message passing bus Processes OS

etc... Microkernel
116545

Process manager

Processes

Commands Used to Display Process and Thread Details


Table 7-3 describes some of the commands used to display information on the processes and threads running on a router. For complete details on the commands and options related to process and thread management, see the Cisco IOS XR System Management Command Reference.
Table 7-3 Commands to Display Process and Thread Information

Command monitor processes

Description Displays the ten most active processes and the current CPU usage. The output from this command continually refreshes until quit (enter the q-key to quit). Displays interactive, auto-updating process and thread statistics in a full-screen mode. Displays information about active processes. Displays process aborts. Displays details for reply, send, and mutually exclusive (mutex) blocked processes. Displays process boot information. Displays CPU use for each process. Displays process data for dynamically created processes. Displays process automatic switchover information. Displays the process log.

monitor threads show processes show processes abort show processes blocked show processes boot show processes cpu show processes dynamic show processes failover show processes log

Cisco IOS XR Getting Started Guide

7-8

Chapter 7

Troubleshooting the Cisco IOS XR Software Understanding Processes and Threads

Table 7-3

Commands to Display Process and Thread Information (continued)

Command show processes memory show processes startup

Description Shows memory use for each process. Shows process data for processes created at startup.

Examples
The following examples show the output and heading descriptions for commands commonly used to display information on processes and process memory usage:

show processes Command, page 7-9 show processes process-name Command, page 7-10 show processes memory Command, page 7-11 monitor processes Command, page 7-12

show processes Command


To display the running processes and information, such as the name, ID number, and state of the processes, enter the show processes command in EXEC mode. Table 7-4 describes the column heading output.
Table 7-4 Column Heading Descriptions for show processes Output

Output Heading JID TID

Description Job IDIn the CLI, the process instance is shown as the job ID (multiple instances of a process can run simultaneously on a node). Thread IDA thread is a unit of execution within a process. Multiple threads can run inside each instance of a process (known as multithreading). Each thread is assigned a thread ID number.

LastCPU Stack pri state HR:MM:SS:MSEC NAME

CPU number on which the process was last running. The value is 0 or 1. For a single processor node, the value is 0. Size of the memory stack of the process. Process priority. Process state. Time the process has run since starting. Process name.

Cisco IOS XR Getting Started Guide

7-9

Chapter 7 Understanding Processes and Threads

Troubleshooting the Cisco IOS XR Software

The following is sample output from the show processes command:


RP/0/RP0/CPU0:router# show processes JID TID LastCPU Stack pri state 1 1 0 0K 0 Ready 1 2 1 0K 0 Running 1 3 1 0K 10 Receive 1 4 1 0K 10 Receive 1 5 0 0K 63 Receive 1 6 1 0K 63 Receive 1 7 0 0K 63 Receive 1 8 0 0K 10 Receive 1 9 1 0K 10 Receive 1 10 1 0K 10 Receive 1 11 1 0K 10 Receive 1 15 0 0K 10 Receive 1 18 1 0K 10 Receive 1 20 1 0K 10 Receive 1 21 1 0K 10 Receive 1 22 0 0K 10 Running 1 23 1 0K 10 Receive 1 25 0 0K 10 Receive --More-HR:MM:SS:MSEC NAME 1:57:41:0542 procnto-600-smp-cisco-instr 1:57:37:0022 procnto-600-smp-cisco-instr 0:00:05:0723 procnto-600-smp-cisco-instr 0:00:00:0001 procnto-600-smp-cisco-instr 0:00:00:0000 procnto-600-smp-cisco-instr 0:00:00:0000 procnto-600-smp-cisco-instr 0:00:00:0000 procnto-600-smp-cisco-instr 0:00:01:0885 procnto-600-smp-cisco-instr 0:00:03:0416 procnto-600-smp-cisco-instr 0:00:00:0001 procnto-600-smp-cisco-instr 0:00:04:0861 procnto-600-smp-cisco-instr 0:00:02:0020 procnto-600-smp-cisco-instr 0:00:03:0278 procnto-600-smp-cisco-instr 0:00:00:0732 procnto-600-smp-cisco-instr 0:00:02:0692 procnto-600-smp-cisco-instr 0:00:03:0788 procnto-600-smp-cisco-instr 0:00:11:0785 procnto-600-smp-cisco-instr 0:00:04:0037 procnto-600-smp-cisco-instr

show processes process-name Command


The show processes process-name command displays detailed information about a process. Table 7-5 describes the heading output.
Table 7-5 Heading Descriptions for show processes process-name Output

Output Heading JID

Description Job IDThis remains constant over process restarts. In the CLI, the process instance is shown as the job ID (multiple instances of a process can run simultaneously on a node).

PID Executable path Instance Version ID Respawn Respawn count Max. spawns per minute Last started Process state Started on config

Process IDThis changes when process is restarted. Path for the process executable. Instance of the process. More than one instance of a process may run at a given time (each instance may have more than one thread). API version. ON or OFFDetermines if this process restarts automatically in case of failure. Number of times this process has been (re)started (that is, the first start makes this count 1). Number of respawns not to be exceeded in 1 minute. If this number is exceeded, stop restarting. Date and time the process was last started. Current state of the process. Configuration command that started (or would start) this process.

Cisco IOS XR Getting Started Guide

7-10

Chapter 7

Troubleshooting the Cisco IOS XR Software Understanding Processes and Threads

Table 7-5

Heading Descriptions for show processes process-name Output

Output Heading core Max. core

Description Memory segments to include in a core file. Number of times to dump a core file0 = infinity.

The following is sample output from the show processes command:


RP/0/RP0/CPU0:router# show processes ospf Job Id: 261 PID: 139453 Executable path: /hfr-rout-0.44.0/bin/ospf Instance #: 1 Version ID: 00.00.0000 Respawn: ON Respawn count: 1 Max. spawns per minute: 12 Last started: Wed Mar 17 07:46:26 2004 Process state: Run Package state: Normal Started on config: cfg/gl/ipv4-ospf/proc/100/ord_a/routerid core: TEXT SHAREDMEM MAINMEM Max. core: 0 Mandatory: ON Placement: ON startup_path: /pkg/startup/ospf.startup Process cpu time: 0.410 user, 0.183 kernel, 0.593 total JID TID LastCPU Stack pri state HR:MM:SS:MSEC NAME 261 1 0 40K 10 Receive 0:00:00:0397 ospf 261 2 1 40K 10 Receive 0:00:00:0003 ospf 261 3 0 40K 10 Receive 0:00:00:0007 ospf 261 4 1 40K 10 Condvar 0:00:00:0000 ospf --More--

show processes memory Command


The show processes memory command displays details of memory usage for a given process or all processes, as shown in the following example. Table 7-6 describes the column heading output.
Table 7-6 Column Heading Descriptions for show process memory Output

Output Heading JID

Description Job ID. In the CLI, the process instance is shown as the job ID (multiple instances of a process can run simultaneously on a node). Size of text region (process executable). Size of data region (initialized and uninitialized variables). Size of process stack. Size of dynamically allocated memory. Process name.

Text Data Stack Dynamic Process

Cisco IOS XR Getting Started Guide

7-11

Chapter 7 Understanding Processes and Threads

Troubleshooting the Cisco IOS XR Software

The following is sample output from the show processes memory command:
RP/0/RP0/CPU0:router# show processes memory JID Text 55 28672 164 143360 317 167936 122 512000 265 57344 254 40960 63 8192 314 4096 341 495616 259 53248 189 32768 69 77824 348 323584 347 323584 346 323584 345 323584 344 323584 261 323584 --More-Data 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 Stack 69632 20480 45056 77824 57344 143360 24576 36864 40960 28672 32768 110592 40960 40960 40960 40960 40960 40960 Dynamic 17072128 13238272 10526720 9797632 5877760 3084288 2314240 1699840 1576960 1490944 1425408 1421312 1392640 1392640 1392640 1392640 1392640 1392640 Process eth_server hfr_fgid_server syslogd bgp parser_server netio nvram sysdb_svr_local wdsysmon nvgen_server hd_drv qnet ospf ospf ospf ospf ospf ospf

monitor processes Command


This command shows the top ten processes of CPU usage. The display refreshes every 10 seconds. Table 7-7 describes the heading output. To change the monitor processes command to display parameters or terminate the display and return to the system prompt, see the interactive display characters described in Table 7-8.
Table 7-7 Heading Descriptions for monitor process Output

Output Heading JID

Description Job ID. In the CLI, the process instance is shown as the job ID (multiple instances of a process can run simultaneously on a node). Thread IDA thread is a unit of execution within a process. Multiple threads can run inside each instance of a process (known as multithreading). Each thread is assigned a thread ID number.

TIDS

Chans FDs Tmrs MEM HH:MM:SS CPU NAME

Channels (client connections) to the server. Number of files open. Number of timers for the process. Total memory of the process. Run time of process since last restart. Percentage of CPU used by process thread. Process name.

Cisco IOS XR Getting Started Guide

7-12

Chapter 7

Troubleshooting the Cisco IOS XR Software Understanding Processes and Threads

The following is sample output from the monitor processes command:


RP/0/RP0/CPU0:router# monitor processes 195 processes; 628 threads; 3300 channels, 4579 fds CPU states: 47.6% idle, 1.2% user, 51.1% kernel Memory: 2048M total, 1576M avail, page size 4K JID TIDS Chans 1 27 198 52 5 215 342 4 195 495806 1 1 293 7 31 55 11 24 121 3 10 311 4 7 138 4 14 265 5 31 FDs Tmrs 8 1 44 5 14 6 10 0 39 11 14 5 8 2 18 4 40 5 19 4 MEM 0 228K 1M 648K 352K 16M 564K 216K 240K 204K HH:MM:SS CPU NAME 5:53:31 51.11% kernel 0:00:02 0.52% devc-conaux 0:00:08 0.34% wdsysmon 0:00:00 0.16% ptop 0:00:09 0.07% shelfmgr 0:00:29 0.06% eth_server 0:00:05 0.02% bcm_process 0:00:02 0.01% sysdb_medusa_s 0:00:01 0.01% devc-vty 0:00:09 0.01% packet

To list the interactive commands, type ? during the display. The options are described in Table 7-8.
Table 7-8 Interactive Display Commands for the monitor processes Command

Command Description ? q n d k l t m c f Displays or prints the interactive commands. Quits the monitor processes display and returns to the system prompt. Changes the number of processes to be displayed. Changes the delay interval between updates. Kills a process. Refreshes the screen. Sorts the display by time (default). Sorts the display by memory used. Sorts the display by number of open channels. Sorts the display by number of open files.

Commands Used to Manage Process and Threads


Table 7-9 describes the commands used to reset the options for a thread or to manually stop, start, and restart a process. For complete details on the commands and options related to process and thread management, see the Cisco IOS XR System Management Command Reference.

Caution

Manually stopping, starting, or restarting a process can seriously impact the operation of a router. Use these commands only under the direction of a technical support representative.

Cisco IOS XR Getting Started Guide

7-13

Chapter 7 Configuration Error Messages

Troubleshooting the Cisco IOS XR Software

Table 7-9

Commands to Manage Processes

Command process {kill | restart | start} process mandatory {on | off} process mandatory reboot {enable | disable}

Description Manually stops, starts, or restarts a process or process instance. Changes the mandatory setting for a process. Changes how the system reacts to mandatory processes that go down.

Configuration Error Messages


The following sections contain information on configuration error messages:

Configuration Failures During a Commit Operation, page 7-14 Configuration Errors at Startup, page 7-15

Configuration Failures During a Commit Operation


A target configuration is added to the running configuration of a router when the commit command is entered. During this operation, the changes are automatically verified by the other components in the system. If successful, the configuration becomes part of the running configuration. If some configuration items fail, an error message is returned. To display the configuration items that failed and see the cause of each failure, enter the show configuration failed command.

Note

The show configuration failed command can be entered in either the EXEC mode or any configuration mode. In any mode, the configuration failures from the most recent commit operation are displayed. In the following example, a configuration error occurs when an invalid commit operation is attempted:
RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# taskgroup bgp RP/0/RP0/CPU0:router(config-tg)# description this is a test of an invalid taskgroup RP/0/RP0/CPU0:router(config-tg)# commit % Failed to commit one or more configuration items. Please use 'show configurati on failed' to view the errors

To display the configuration items that failed, including a description of the error, enter the show configuration failed command:
RP/0/RP0/CPU0:router(config-tg)# show configuration failed !! CONFIGURATION FAILED DUE TO SEMANTIC ERRORS taskgroup bgp !!% Usergroup/Taskgroup names cannot be taskid names !

Cisco IOS XR Getting Started Guide

7-14

Chapter 7

Troubleshooting the Cisco IOS XR Software Memory Warnings in Configuration Sessions

You can also display the failed configuration items without the error description by entering the show configuration failed noerror command:
RP/0/RP0/CPU0:router(config-tg)# show configuration failed noerror !! CONFIGURATION FAILED DUE TO SEMANTIC ERRORS taskgroup bgp

Configuration Errors at Startup


Configuration errors that occurred during system startup can be displayed with the show configuration failed startup command. For example:
RP/0/RP0/CPU0:router# show configuration failed startup !! CONFIGURATION FAILED DUE TO SYNTAX ERRORS ntp xml agent corba http server

Memory Warnings in Configuration Sessions


The Cisco IOS XR software automatically monitors and manages the system resources in a router. Under normal operating conditions, memory problems should not occur. When a low-memory issue does occur, it is often in the form of a low-memory warning during a configuration session. Low-memory conditions can be caused by multiple, large configurations being added to the router at a single time. Users can remove the source of a problem by removing configurations. The following sections describe the commands used to display memory usage in a router and what to do if a low-memory warning appears:

Understanding Low-Memory Warnings in Configuration Sessions, page 7-16 Displaying System Memory Information, page 7-17 Removing Configurations to Resolve Low-Memory Warnings, page 7-18 Contacting TAC for Additional Assistance, page 7-21

Cisco IOS XR Getting Started Guide

7-15

Chapter 7 Memory Warnings in Configuration Sessions

Troubleshooting the Cisco IOS XR Software

Understanding Low-Memory Warnings in Configuration Sessions


The Cisco IOS XR software monitors memory usage in the Cisco CRS-1. If system memory becomes low, an error message is displayed when you attempt to enter configuration mode. An out-of-memory error message is displayed during one of the following situations:

When a user attempts to enter configuration mode. During a configuration session when the memory shortage occurs. When a user attempts to load a target configuration from a large file that results in a memory shortage. During a commit operation that results in the low-memory warning message. The commit operation is denied and only lr-root users can perform commit operations to remove configurations.

Caution

Never ignore a low-memory warning. These warnings indicate a memory state that could affect system operations if not addressed.

WARNING! MEMORY IS IN MINOR STATE


If the system memory begins to run low, the following minor memory warning is displayed when you enter a new configuration mode.
WARNING! MEMORY IS IN MINOR STATE

Although users are allowed to enter configuration mode, they should immediately reduce memory usage using the tools described in the Removing Configurations to Resolve Low-Memory Warnings section on page 7-18. Failure to take action can result in a worsening situation and eventual impact to router operations.

ERROR! MEMORY IS IN SEVERE (or CRITICAL) STATE


When the memory is in a severe or critical state, router operation and performance is likely to be affected. Regular users are not allowed to enter configuration mode. Only lr-root owners can enter configuration mode to free memory by removing configurations. In some situations, the commit command is not allowed. Users with lr-root access can still use the commit force command to apply configurations that reduce memory usage. Reducing memory usage normally means removing configurations, but a user can also add configurations that reduce memory usage. For example, configuring the shutdown command on an interface could cause numerous routes to be purged from Border Gateway Protocol (BGP), the Routing Information Base (RIB), and Forwarding Information Base (FIB) configurations.

Caution

The commit force command should be used only to apply configurations that reduce memory usage. Adding configurations that increase memory usage could result in serious loss of router operation.

Cisco IOS XR Getting Started Guide

7-16

Chapter 7

Troubleshooting the Cisco IOS XR Software Memory Warnings in Configuration Sessions

Displaying System Memory Information


To display a high level summary of system memory, enter the show memory summary command. Table 7-9 describes the meaning of each heading.
RP/0/RP0/CPU0:router# show memory summary Physical Memory: 2048M total Application Memory : 1787M (1509M available) Image: 132M (bootram: 132M) Reserved: 128M, IOMem: 0, flashfsys: 0 Total shared window: 0 RP/0/RP1/CPU0:router#

To display general memory usage for the device as a whole and by process, enter the show memory command. Table 7-9 describes the meaning of each heading.
RP/0/RP0/CPU0:router# show memory Physical Memory: 2048M total Application Memory : 1787M (1510M available) Image: 132M (bootram: 132M) Reserved: 128M, IOMem: 0, flashfsys: 0 Total shared window: 0 kernel: jid 1 Address Bytes 000d2000 12288 00112000 12288 Total Allocated Memory: 0 Total Shared Memory: 0 pkg/bin/wd-mbi: Address 4817f000 48180000 481fe000 48200000 --More-jid 72 Bytes 4096 516096 8192 8192

What Program Stack Program Stack

What Program Program Program Program

Stack (pages not allocated) Stack (pages not allocated) Stack Text

Table 7-10

Heading Descriptions for show memory Command Output

Heading Physical Memory Application Memory Image Reserved IOMem flashfsys Process and JID Address Bytes What

Description Amount of physical memory installed on the device. Memory available for the system to use (total memory minus image size, reserved, IOMem, and flashfsys). Size of the bootable image. Reserved for packet memory. IO memoryCurrently used as a backup for packet memory. Flash file system memory. Process and job ID. Starting address in memory. Size of memory block. Block description.

Cisco IOS XR Getting Started Guide

7-17

Chapter 7 Memory Warnings in Configuration Sessions

Troubleshooting the Cisco IOS XR Software

Removing Configurations to Resolve Low-Memory Warnings


To resolve most low-memory problems, you should remove the configurations from the router that are consuming the most memory. Often, memory problems occur when a large new configuration is added to the system. The following sections provide information to resolve low-memory issues:

Clearing a Target Configuration, page 7-18 Removing Committed Configurations to Free System Memory, page 7-18 Rolling Back to a Previously Committed Configuration, page 7-20 Clearing Configuration Sessions, page 7-20

Clearing a Target Configuration


A low-memory warning can occur when a large configuration file is loaded into a target configuration session. To remove the target configuration, enter the clear command to discard the changes. For example:
RP/0/RP0/CPU0:router(config)# clear

Caution

Committing a target configuration that has caused a low-memory warning can make the system unstable. Clearing a target configuration is a preventive measure to not let the system go into a worse memory state due to additional configuration. In addition, all other active configuration sessions can be closed to minimize the churn.

Removing Committed Configurations to Free System Memory


You can reduce memory usage by removing configurations from the router, as shown in the following procedure:
Step 1

Enter the show memory summary command in EXEC mode to display the overall system memory:
RP/0/RP0/CPU0:router# show memory summary Physical Memory: 2048M total Application Memory : 1787M (1511M available) Image: 132M (bootram: 132M) Reserved: 128M, IOMem: 0, flashfsys: 0 Total shared window: 0

Step 2

Enter the show configuration commit history command in EXEC mode to see if a large configuration forced the router over the limit.

Cisco IOS XR Getting Started Guide

7-18

Chapter 7

Troubleshooting the Cisco IOS XR Software Memory Warnings in Configuration Sessions

The output from this command does not show the details of the entries, but allows you to display a larger list of the commit events that occurred. To display the commitIDs to which you can roll back, use the show configuration commit history command.
RP/0/RP0/CPU0:router# show configuration commit history SNo. ~~~~ 1 2 3 4 5 6 7 8 9 10 Label/ID ~~~~~~~~ 1000000144 1000000143 1000000142 1000000141 1000000140 1000000139 1000000138 1000000137 1000000136 1000000135 User ~~~~ user user user user lab user user lab user lab Line ~~~~ vty0 vty0 0.0.0.0 0.0.0.0 con0_RP1_C 0.0.0.0 0.0.0.0 con0_RP1_C 0.0.0.0 con0_RP1_C Client ~~~~~~ CLI CLI XMLAgent XMLAgent CLI XMLAgent XMLAgent CLI XMLAgent CLI Time Stamp ~~~~~~~~~~ 00:16:51 UTC 00:04:32 UTC 21:58:36 UTC 21:46:07 UTC 21:43:30 UTC 21:40:13 UTC 21:34:48 UTC 21:32:10 UTC 21:30:13 UTC 19:45:04 UTC

Thu Thu Wed Wed Wed Wed Wed Wed Wed Wed

Dec Dec Dec Dec Dec Dec Dec Dec Dec Dec

11 11 10 10 10 10 10 10 10 10

2003 2003 2003 2003 2003 2003 2003 2003 2003 2003

Step 3

Enter the show configuration commit changes command followed by a commitID number to display the configuration changes for a commit session (commitID). For example:
RP/0/RP0/CPU0:router# show configuration commit changes 1000000053 Building configuration... interface preconfigure MgmtEth0/RP1/CPU0/0 ipv4 address 10.8.50.10 255.255.0.0 proxy-arp ! route ipv4 172.255.254.254/32 12.8.0.1 end

Step 4

Remove the configuration using the appropriate configuration commands. In some situations, the commit command is not allowed. Users with lr-root access can still use the commit force command, but this command should be used only to remove configurations. The addition of new configurations seriously impacts router operation.

For more information, see the Managing Configuration History and Rollback section on page 3-3.

Cisco IOS XR Getting Started Guide

7-19

Chapter 7 Memory Warnings in Configuration Sessions

Troubleshooting the Cisco IOS XR Software

Rolling Back to a Previously Committed Configuration


You can roll back the system to a previous committed configuration, as shown in the following procedure:
Step 1

Enter the show configuration commit list command to display the commitIDs available for rollback:
RP/0/RP0/CPU0:router# show configuration commit list SNo. ~~~~ 1 2 3 4 5 6 7 8 9 10 Label/ID ~~~~~~~~ 1000000391 1000000390 1000000389 1000000388 1000000387 1000000386 1000000385 1000000384 1000000383 1000000382 User ~~~~ user_a user_a user_a user_a user_a user_a user_a user_a user_a user_a Line ~~~~ con0_33_1 con0_33_1 con0_33_1 con0_33_1 con0_33_1 con0_32_1 con0_33_1 con0_33_1 con0_33_1 con0_33_1 Client ~~~~~~ CLI CLI CLI CLI CLI CLI CLI CLI CLI CLI Time Stamp ~~~~~~~~~~ 19:29:18 UTC 19:29:16 UTC 19:29:15 UTC 19:29:12 UTC 19:26:16 UTC 19:18:38 UTC 19:14:09 UTC 19:13:58 UTC 19:13:33 UTC 19:12:50 UTC

Wed Wed Wed Wed Wed Wed Wed Wed Wed Wed

Dec Dec Dec Dec Dec Dec Dec Dec Dec Dec

10 10 10 10 10 10 10 10 10 10

2003 2003 2003 2003 2003 2003 2003 2003 2003 2003

Step 2

Enter the show configuration rollback changes to commit-id command to display the details of a specific commit ID:
RP/0/RP0/CPU0:router# show configuration rollback changes to 1000000373 Building configuration... interface Loopback2 no description no ipv4 address 10.0.5.1 255.0.0.0

Step 3

Roll back the configuration with the rollback configuration to commitId command:
RP/0/RP0/CPU0:router# rollback configuration to 1000000325 Configuration successfully rolled back to 1000000325. RP/0/RP0/CPU0:router#

For more information, see the Managing Configuration History and Rollback section on page 3-3.

Clearing Configuration Sessions


Active configuration sessions and their associated target configurations can consume system memory. Users with the appropriate access privileges can display the open configuration sessions of other users and terminate those sessions, if necessary (see Table 7-11).
Table 7-11 Session Commands

Command show configuration sessions clear configuration sessions session-id

Description Displays the active configuration sessions. Clears a configuration session.

Cisco IOS XR Getting Started Guide

7-20

Chapter 7

Troubleshooting the Cisco IOS XR Software Interfaces Not Coming Up

In the following example, the open configuration sessions are displayed with the show configuration sessions command. The clear configuration sessions command is then used to clear a configuration session.
RP/0/RP0/CPU0:router# show configuration sessions Session 00000211-002c409b-00000000 Line User Date con0_RP1_CPU0 UNKNOWN Mon Feb Lock 2 01:02:09 2004

RP/0/RP0/CPU0:router# clear configuration sessions 00000211-002c409b-00000000 session ID '00000211-002cb09b-00000000' terminated

Contacting TAC for Additional Assistance


If you remove configurations and the low-memory condition remains, you may need to contact TAC for additional assistance. See the Additional Sources for Information section on page 1.

Interfaces Not Coming Up


The router interfaces are directly used in processing network traffic, so their status information is crucial to understanding how the device is functioning. This section contains information on the commands used to verify that the router interfaces are operational. The basic commands used in this process are summarized in Table 7-12.
Table 7-12 show interface Commands

Command show interface show interface type instance

Description Displays detailed information about all interfaces installed or configured on the device, whether or not they are operational. Specifies a particular interface, rather than displaying information for all interfaces, as in the following example:
show interface POS0/1/0/0

show ipv4 interface show ipv4 interface brief

Displays basic, IP-related information for all available interfaces. Quickly displays the most critical information about the interfaces, including the interface status (up or down) and the IPv4 protocol status.

Cisco IOS XR Getting Started Guide

7-21

Chapter 7 Interfaces Not Coming Up

Troubleshooting the Cisco IOS XR Software

Verifying the System Interfaces


Perform the following steps to verify the system interfaces.
Step 1

Enter the show platform command to verify that all nodes are in the IOS-XR RUN state:
RP/0/RP0/CPU0:router# show platform Node Type PLIM State Config State ----------------------------------------------------------------------------0/1/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/1/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/2/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/2/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/3/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/3/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/RP0/CPU0 RP(Active) N/A IOS-XR RUN PWR,NSHUT,MON 0/RP1/CPU0 RP(Standby) N/A IOS-XR RUN PWR,NSHUT,MON 0/SM0/SP FC/S(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/SM1/SP FC/S(SP) N/A IOS-XR RUN PWR,NSHUT,MON

Note

Line cards in Cisco CRS-1s are called modular services cards (MSCs). The show platform command output is different for Cisco CRS-1s and Cisco XR 12000 Series Routers. Enter the show ipv4 interface brief command to verify IP address configuration and protocol status:
RP/0/RP0/CPU0:router# show ipv4 interface brief Interface POS0/1/0/0 POS0/1/0/1 POS0/1/0/2 POS0/1/0/3 POS0/1/0/4 POS0/1/0/5 POS0/1/0/6 POS0/1/0/7 POS0/1/0/8 POS0/1/0/9 POS0/1/0/10 POS0/1/0/11 POS0/1/0/12 POS0/1/0/13 POS0/1/0/14 POS0/1/0/15 POS0/2/0/0 POS0/2/0/1 POS0/2/0/2 POS0/2/0/3 TenGigE0/3/0/0 TenGigE0/3/0/2 MgmtEth0/RP0/CPU0/0 IP-Address unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned 10.10.1.101 unassigned unassigned unassigned unassigned unassigned unassigned Status Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Down Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Protocol Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down

Step 2

Cisco IOS XR Getting Started Guide

7-22

Chapter 7

Troubleshooting the Cisco IOS XR Software Interfaces Not Coming Up

Step 3

Configure the interfaces, as shown in the following examples.

Note

You must enter the commit command to make the new configuration part of the active running configuration. If you end the configuration session, you are automatically prompted to commit the changes, as shown in the second example:

RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# interface pos0/2/0/1 RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.1.1.1 255.0.0.0 RP/0/RP0/CPU0:router(config-if)# no shutdown RP/0/RP0/CPU0:router(config-if)# commit RP/0/RP0/CPU0:router(config-if)# end RP/0/RP0/CPU0:router# RP/0/RP0/CPU0:router# configure RP/0/RP0/CPU0:router(config)# interface pos0/2/0/2 RP/0/RP0/CPU0:router(config-if)# ipv4 address 10.1.1.2 255.255.0.0 RP/0/RP0/CPU0:router(config-if)# no shutdown RP/0/RP0/CPU0:router(config-if)# end Uncommitted changes found, commit them? [yes]: yes RP/0/RP0/CPU0:router#

Step 4

Enter the show ipv4 interface brief command to verify that the interfaces are Up in the Status column:
RP/0/RP0/CPU0:router# show ipv4 interface brief Interface POS0/1/0/0 POS0/1/0/1 POS0/1/0/2 POS0/1/0/3 POS0/1/0/4 POS0/1/0/5 POS0/1/0/6 POS0/1/0/7 POS0/1/0/8 POS0/1/0/9 POS0/1/0/10 POS0/1/0/11 POS0/1/0/12 POS0/1/0/13 POS0/1/0/14 POS0/1/0/15 POS0/2/0/0 POS0/2/0/1 POS0/2/0/3 POS0/2/0/3 TenGigE0/3/0/0 TenGigE0/3/0/2 MgmtEth0/RP0/CPU0/0 IP-Address unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned 10.10.1.101 10.1.1.1 10.1.1.2 unassigned unassigned unassigned unassigned Status Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Up Up Shutdown Shutdown Shutdown Shutdown Shutdown Protocol Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Up Up Down Down Down Down Down

Cisco IOS XR Getting Started Guide

7-23

Chapter 7 Interfaces Not Coming Up

Troubleshooting the Cisco IOS XR Software

Step 5

If the interface is in the Shutdown/Down state, as shown in the previous example, perform the following tasks:
a.

Verify that the status of the interface is Shutdown:


RP/0/RP0/CPU0:router# show running interface POS0/2/0/3 interface pos0/2/0/3 shutdown keepalive disable !

b.

Bring the interface up with the following commands:


RP/0/RP0/CPU0:router(config)# controller pos 0/2/0/3 RP/0/RP0/CPU0:router(config-sonet)# no shutdown RP/0/RP0/CPU0:router(config-sonet)# commit RP/0/RP0/CPU0:router(config-sonet)# exit RP/0/RP0/CPU0:router(config)# interface pos 0/2/0/3 RP/0/RP0/CPU0:router(config-if)# no shutdown RP/0/RP0/CPU0:router(config-if)# commit RP/0/RP0/CPU0:router(config-if)# end RP/0/RP0/CPU0:router#

Step 6

If the interface state is still displayed as Down, verify that the physical cable connections are correctly installed. The following message indicates that the interface has either a bad connection or no connection:
LC/0/0/1:Sep 29 15:31:12.921 : plim_4p_oc192[183]: %SONET-4ALARM : SONET0_1_1_0: SLOS

Step 7

Verify again that the interface is up by entering the show ipv4 interface brief command:
RP/0/RP0/CPU0:router# show ipv4 interface brief Interface POS0/1/0/0 POS0/1/0/1 POS0/1/0/2 POS0/1/0/3 POS0/1/0/4 POS0/1/0/5 POS0/1/0/6 POS0/1/0/7 POS0/1/0/8 POS0/1/0/9 POS0/1/0/10 POS0/1/0/11 POS0/1/0/12 POS0/1/0/13 POS0/1/0/14 POS0/1/0/15 POS0/2/0/0 POS0/2/0/1 POS0/2/0/2 POS0/2/0/3 TenGigE0/3/0/0 TenGigE0/3/0/2 MgmtEth0/RP0/CPU0/0 IP-Address unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned unassigned 10.10.1.101 10.1.1.1 10.1.1.2 unassigned unassigned unassigned unassigned Status Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Shutdown Up Up Up Shutdown Shutdown Shutdown Shutdown Protocol Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Down Up Up Up Down Down Down Down

Step 8

Repeat these steps for every interface, until every interface shows both Status and Protocol as Up.

Cisco IOS XR Getting Started Guide

7-24

A P P E N D I X

Router Recovery and Management with ROM Monitor


The ROM Monitor is a bootstrap program that initializes the hardware and boots the Cisco IOS XR software when you power on or reload a router. If the Cisco IOS XR software cannot boot, the router startup ends in ROM Monitor mode and displays the ROM Monitor command-line interface (CLI) prompt:
rommon B1>

During normal operation, users do not see the ROM Monitor prompt or use ROM Monitor mode. If the ROM Monitor prompt appears, you might need to reinstall the router software. If you lose the router password or want to specify a configuration file to use at startup, you can perform these tasks in ROM Monitor mode. This chapter describes the procedures that you might want to perform in ROM Monitor mode.

Contents
This appendix contains the following sections:

ROM Monitor Overview, page A-1 Reinstalling the Cisco IOS XR Software from ROMMON, page A-2 Recovering the Root Password, page A-21 Specifying an Alternative Configuration, page A-24 ROM Monitor Procedures, page A-25

ROM Monitor Overview


The ROM Monitor software is known by many names. It is sometimes called ROMMON because of the CLI prompt in ROM Monitor mode. The ROM Monitor software is also called the boot software, boot image, or boot helper. Although it is distributed with routers that use the Cisco IOS XR software, ROM Monitor is a separate program from the Cisco IOS XR software. During normal startup, the ROM Monitor initializes the router, and then control passes to the Cisco IOS XR software. After the Cisco IOS XR software takes over, ROM Monitor is no longer in use.

Cisco IOS XR Getting Started Guide

A-1

Appendix A Reinstalling the Cisco IOS XR Software from ROMMON

Router Recovery and Management with ROM Monitor

Two primary connections exist between ROM Monitor and the Cisco IOS XR software: the ROM Monitor environment variables and the configuration register. The ROM Monitor environment variables define the location of the Cisco IOS XR software and how to load it. After ROM Monitor has initialized the router, it uses the environment variables to locate and load the Cisco IOS XR software. The configuration register is a software setting that controls router startup. One of the primary uses of the configuration register is to control whether the router starts in ROM Monitor mode or EXEC mode. The configuration register is set in either ROM Monitor mode or EXEC mode as needed. Typically, you set the configuration register for ROM Monitor mode in the Cisco IOS XR software when you need to use ROM Monitor mode. When your maintenance in ROM Monitor mode is complete, you change the configuration register to start the Cisco IOS XR software. When the router is in ROM Monitor mode, you can access the ROM Monitor software only from a terminal connected directly to the Console port of the primary or standby route processor (RP). Because the Cisco IOS XR software (EXEC mode) is not operating, the non management interfaces (such as PoS interfaces) are not accessible. Basically, all of the Cisco IOS XR software resources are unavailable. The hardware is there, but no configuration exists to make use of the hardware. Some people get confused when they start to use ROM Monitor mode. It is important to remember that ROM Monitor mode is a router mode, not a mode within the Cisco IOS XR software. It is best to remember that ROM Monitor software and the Cisco IOS XR software are two separate programs that run on the same router. At any given time, the router is running one of these programs, but it never runs both at the same time. One area that confuses people when using ROM Monitor and the Cisco IOS XR software is that area that defines the IP configuration for the Management Ethernet interface. Most router users get comfortable with configuring the Management Ethernet interface in the Cisco IOS XR software. When the router is in ROM Monitor mode, however, the router is not running the Cisco IOS XR software, so that Management Ethernet interface configuration is not available. Therefore, because it is a separate program, you must configure ROM Monitor to use the Management Ethernet interface if you want to access other devices, such as a TFTP server, while in ROM Monitor mode.

Reinstalling the Cisco IOS XR Software from ROMMON


Caution

Reinstalling the Cisco IOS XR software from ROMMON replaces the currently installed router software and causes substantial router downtime. We recommend installing or upgrading software packages from the EXEC mode using package installation envelope (PIE) files, as described in Chapter 5, Managing Cisco IOS XR Software Packages. The standard way to install new software on a router is by using the install command in admin EXEC mode. However, if the router is unable to boot the Cisco IOS XR software or you want to completely replace the existing software, you can reinstall the software while the router is in ROM Monitor mode. When you install the Cisco IOS XR software from ROM Monitor, you must use a special software installation file with a .vm file extension. You cannot install software in PIE files from ROM Monitor mode.

Cisco IOS XR Getting Started Guide

A-2

Appendix A

Router Recovery and Management with ROM Monitor Reinstalling the Cisco IOS XR Software from ROMMON

Contents
This section includes the following topics:

Cisco IOS XR Software Installation Overview, page A-3 Locating Installable Files, page A-4 tar Filenames and Version Numbers, page A-6 .vm Filenames and Version Numbers, page A-9 Reinstalling the Software from an Image Located on a TFTP Server, page A-10 Reinstalling the Software from a .vm File Located on Flash disk1:, page A-16 What to Do Next, page A-21

Cisco IOS XR Software Installation Overview


When you reinstall the software from ROM Monitor mode, you can do either of the following:

Load the Cisco IOS XR software from a .vm file on a TFTP server. Transfer the .vm file to disk1: and load the Cisco IOS XR software from disk1:. Installation from a TFTP Server, page A-3 Installation from disk1:, page A-4

The following sections provide an overview of the processes:


Installation from a TFTP Server


When you install the Cisco IOS XR software from a TFTP server, you must do the following:
1. 2. 3. 4. 5.

Place the router in ROM Monitor mode. Clear any environment variables that might interfere with the installation. Configure ROM Monitor with the IP parameters required to access the TFTP server. Configure the TURBOBOOT environment variable to either clean or format disk0: during the install. Boot the Cisco IOS XR software from a .vm file on the TFTP server.

After you boot the Cisco IOS XR software, the software loads into memory so that it can clean or format disk0: based on the TURBOBOOT environment variable setting. When this variable is set to clean the disk, the software replaces all previously installed software with the Cisco IOS XR software from the TFTP server. All router configuration files are retained so that after the installation, the new software operates with the previous configuration. When the TURBOBOOT environment variable is set to format disk0:, the Cisco IOS XR software from the TFTP server replaces the software on disk0: and the previous configuration is deleted. When the router starts after a disk format, it operates as would a new router with no configuration. For the procedure to install the Cisco IOS XR software from a TFTP server, see the Reinstalling the Software from an Image Located on a TFTP Server section on page A-10.

Cisco IOS XR Getting Started Guide

A-3

Appendix A Reinstalling the Cisco IOS XR Software from ROMMON

Router Recovery and Management with ROM Monitor

Installation from disk1:


When you install the Cisco IOS XR software from disk1:, you must do the following:
1. 2. 3. 4. 5.

Copy the new Cisco IOS XR software to disk1:. Place the router in ROM Monitor mode. Clear any environment variables that might interfere with the installation. Configure the TURBOBOOT environment variable to either clean or format disk0: during the install. Boot the Cisco IOS XR software from the new Cisco IOS XR software on disk1:.

After you boot the Cisco IOS XR software, the software loads into memory so that it can clean or format disk0: based on the TURBOBOOT environment variable setting. When this variable is set to clean the disk, the software replaces all previously installed software with the Cisco IOS XR software from disk1:. All router configuration files are retained so that after the installation, the new software operates with the previous configuration. When the TURBOBOOT environment variable is set to format disk0:, the Cisco IOS XR software from disk1: replaces the software on disk0: and the previous configuration is deleted. When the router starts after a disk format, it operates as would a new router with no configuration. For the procedure to install the Cisco IOS XR software from disk1:, see the Reinstalling the Software from a .vm File Located on Flash disk1: section on page A-16.

Locating Installable Files


To obtain Cisco IOS XR software and version information, use the Cisco IOS XR Software Selector tool at the following website: http://www.cisco.com/cgi-bin/Software/IOXPlanner/planner-tool/ioxplanner.cgi? The Cisco IOS XR Software Selector tool allows you to browse for your software upgrade from a single interface. You can display and select software by package name, release, or platform. The tool also includes posting images and Extensible Markup Language (XML) schemas. Choosing a platform, release, or software feature automatically limits the choices based on your selection, until you arrive at your preferred software. The software packages that you can install from ROMMON are listed in Table A-1.

Cisco IOS XR Getting Started Guide

A-4

Appendix A

Router Recovery and Management with ROM Monitor Reinstalling the Cisco IOS XR Software from ROMMON

Table A-1

Downloadable Software for Installation from ROM Monitor

Software Package Name Cisco IOS XR IP/MPLS Core Software

Description This package contains two copies of the Cisco IOS XR Unicast Routing Core Bundle. One copy is in the package installation envelope (PIE) file format and can be installed while IOS XR is running, as described in Chapter 5, Managing Cisco IOS XR Software Packages. The other copy is in a .vm file that can be installed from ROM Monitor. This package also includes the Cisco IOS XR MPLS, Manageability, and Mulitcast packages (in PIE files). This package contains everything in the Cisco IOS XR IP/MPLS Core Software package, and it contains the Cisco IOS XR Security package (in a PIE file).

Cisco IOS XR IP/MPLS Core Software 3DES

The packages listed in Table A-1 are distributed in files with .tar filename extensions (.tar files are assembled with the UNIX tar utility). When you download a tar file, you must unpack the tar file with a software program before you can install any of the files in the package. The files that you can install from ROM Monitor have a .vm filename extension. These files contain the software included in the Cisco IOS XR Unicast Routing Core Bundle. The other files in the packages are PIE files.

Note

The tar files contain both PIE files and .vm files. If the router is operating properly, you can install the software using the appropriate PIE file with little or no interruption to router traffic, as described in Chapter 5, Managing Cisco IOS XR Software Packages. If the router cannot boot the Cisco IOS XR software, install the core software using the .vm file first, then install any additional packages using the PIE files after the router enters EXEC mode. Packages for the Cisco XR 12000 Series Router contain additional files which are described in Table A-1.

Cisco IOS XR Getting Started Guide

A-5

Appendix A Reinstalling the Cisco IOS XR Software from ROMMON

Router Recovery and Management with ROM Monitor

Table A-2

Additional Files for the Cisco XR 12000 Series Router

Filename mbiprp-rp.vm-3.2.0

Description This is the software for all RPs except the RP that serves as the designated shelf controller (DSC). This software is automatically downloaded from the DSC to the other RPs when the RPs are started. This is the ROM Monitor upgrade software for the PRP cards, and later versions may display a different version number at the end of the filename. For instructions on installing this software, see Appendix C, Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers. This is the boothelper software for the PRP cards, and later versions may display a different version number at the end of the filename. For instructions on installing this software, see Appendix C, Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers.

bfprp_romupgrade-1.14.0.91

c12kprp-boot-mz.120-30.S

tar Filenames and Version Numbers


The format for a tar filename is: platform-bundle_name-major.minor.maintenance.tar The tar filename components are described in Table A-3.

Cisco IOS XR Getting Started Guide

A-6

Appendix A

Router Recovery and Management with ROM Monitor Reinstalling the Cisco IOS XR Software from ROMMON

Table A-3

tar Filename Components

Component platform

Description Identifies the platform for which the software package is designed.

For packages designed for the Cisco CRS-1 router, the platform designation is CRS-1. For packages designed for the Cisco XR 12000 Series Router, the platform designation is c12000. The iosxr bundle name indicates a file that includes all packages in the Cisco IOS XR Unicast Routing Core Bundle and the Management, MPLS, and Mulitcast packages. These packages are described in Chapter 5, Managing Cisco IOS XR Software Packages. The iosxr-k9 bundle name indicates a file that includes all packages in the iosxr bundle file plus the Security package. A major release occurs when there is a major architectural change to the product (for example, a major new capability is introduced). All packages operating on the router must be at the same major release level. A major release is the least frequent release and may require a router reboot.

bundle_name

Identifies a specific bundle.

major

Identifies the major release of this package.

Cisco IOS XR Getting Started Guide

A-7

Appendix A Reinstalling the Cisco IOS XR Software from ROMMON

Router Recovery and Management with ROM Monitor

Table A-3

tar Filename Components (continued)

Component minor

Description Identifies the minor release of this package.

A minor release contains one or more of the following:


New features Bug fixes

The minor release version does not have to be identical for all software packages operating on the router, but the operating packages must be certified by Cisco as compatible with each other. A minor release may require a router reboot. A maintenance release contains a collection of bug fixes for a package. The maintenance release version does not have to be identical for all software packages operating on the router, but the major and minor versions of the maintenance release must match the those of the package being updated. A maintenance release usually does not require a router reboot.

maintenance

Identifies the maintenance release of this package.


Cisco IOS XR Getting Started Guide

A-8

Appendix A

Router Recovery and Management with ROM Monitor Reinstalling the Cisco IOS XR Software from ROMMON

.vm Filenames and Version Numbers


The format for a composite .vm filename for Cisco CRS-1s is: comp-platform-package_name.vm-major.minor.maintenance The format for a .vm filename for Cisco XR 12000 Series Routers is: platform-package_name.vm-major.minor.maintenance The comp prefix indicates that the file is a composite of multiple packages. The other filename components are described in Table A-4.
Table A-4 .vm Filename Components

Component platform

Description Identifies the platform for which the software package is designed.

For packages designed for Cisco CRS-1s, the platform designation is hfr. For packages designed for Cisco XR 12000 Series Routers, the platform designation is c12k. The mbiprp platform name specifies a special file for the Cisco XR 12000 Series Router. This file is described in Table A-2. The mini package name indicates a composite package that includes all packages in the Cisco IOS XR Unicast Routing Core Bundle, which is described in Chapter 5, Managing Cisco IOS XR Software Packages. The rp package name specifies a special file for the Cisco XR 12000 Series Router. This file is described in Table A-2. A major release occurs when there is a major architectural change to the product (for example, a major new capability is introduced). All packages operating on the router must be at the same major release level. A major release is the least frequent release and may require a router reboot.

package_name

Identifies a specific package.

major

Identifies the major release of this package.


Cisco IOS XR Getting Started Guide

A-9

Appendix A Reinstalling the Cisco IOS XR Software from ROMMON

Router Recovery and Management with ROM Monitor

Table A-4

.vm Filename Components (continued)

Component minor

Description Identifies the minor release of this package.

A minor release contains one or more of the following:


New features Bug fixes

The minor release version does not have to be identical for all software packages operating on the router, but the operating packages must be certified by Cisco as compatible with each other. A minor release may require a router reboot. A maintenance release contains a collection of bug fixes for a package. The maintenance release version does not have to be identical for all software packages operating on the router, but the major and minor versions of the maintenance release must match the those of the package being updated. A maintenance release usually does not require a router reboot.

maintenance

Identifies the maintenance release of this package.


Reinstalling the Software from an Image Located on a TFTP Server


The Cisco IOS XR software can be reinstalled directly from a .vm image located on a TFTP server. Complete the instructions in this section exactly as described.

Restrictions for TFTP Services


TFTP services by some vendors (such as Sun Solaris) may not support files larger than 32 MB. Because most Cisco IOS XR .vm images are larger than 32 MB, you may need to use one of the following options:

Use a third-party or freeware TFTP server that supports file sizes larger than 32 MB. Download a patch from Sun Microsystems to correct this limitation (http://www.sun.com). Install the Cisco IOS XR software from a .vm image located on the local flash disk. See the Reinstalling the Software from a .vm File Located on Flash disk1: section on page A-16.

Prerequisites
Before you begin, collect the following information.

IP address of the Management Ethernet interface for your router Subnet mask of the Management Ethernet interface for your router IP address of the default gateway that serves your router IP address of the TFTP server from which the software will be downloaded The filename and directory of the .vm installation file that will be installed on the router

Cisco IOS XR Getting Started Guide

A-10

Appendix A

Router Recovery and Management with ROM Monitor Reinstalling the Cisco IOS XR Software from ROMMON

Note

This procedure installs the Cisco IOS XR software on a router that previously ran the Cisco IOS software. If you are upgrading a Cisco XR 12000 Series Router that is currently running Cisco IOS software, you need to first upgrade the router to Cisco IOS XR software, as described in the document titled Upgrading from Cisco IOS to Cisco IOS XR Software on the Cisco XR 12000 Series Router, Release 3.2.

SUMMARY STEPS
1. 2. 3.

Back up the router configuration while still in EXEC mode. Place both the standby RP and primary RP in ROM Monitor mode. Prepare the standby RP:
a. unset BOOT b. unset TFTP_FILE c. sync d. confreg 0x2 e. reset

4.

On the primary RP, set the environment variables that configure the Management Ethernet interface for use in ROM Monitor mode:
a. IP_ADDRESS=ip_address b. IP_SUBNET_MASK=ip_address c. DEFAULT_GATEWAY=ip_address

5.

On the primary RP, clear the BOOT and TFTP filename variables and set the TURBOBOOT environment variable:
a. unset BOOT b. unset TFTP_FILE c. TURBOBOOT=on, destination, options d. sync

6.

boot tftp://server/directory/filename

Cisco IOS XR Getting Started Guide

A-11

Appendix A Reinstalling the Cisco IOS XR Software from ROMMON

Router Recovery and Management with ROM Monitor

DETAILED STEPS

Command or Action
Step 1

Purpose (Optional) To preserve the current router configuration, copy it to another disk while still in EXEC mode.

Back up the router configuration while still in EXEC mode.

See the Managing Configuration History and Rollback section on page 3-3 for more information.

Step 2

Place both the standby RP and primary RP in ROM Monitor mode.

See the Entering ROM Monitor Mode section on page A-25 for more information.

You must attach a terminal to each card for this procedure.

Step 3

Prepare the standby RP:


a. unset BOOT b. unset TFTP_FILE c. sync d. confreg 0x2 e. reset

Enter these settings exactly as shown. All variable names are case sensitive.
a. Clears the BOOT variable. b. Clears the TFTP_FILE variable. c. Saves the changes. d. Sets the configuration register to automatically

start the router in EXEC mode when the card is reset.


e. Resets the standby RP and starts the boot

Example:
rommon rommon rommon rommon rommon B1> B2> B4> B5> B6> unset BOOT unset TFTP_FILE sync confreg 0x2 reset

process.

Step 4

On the primary RP, set the environment variables that Enter these settings exactly as shown. configure the Management Ethernet interface for use in All variable names are case sensitive. ROM Monitor mode: a. Sets the IP address for the Management Ethernet a. IP_ADDRESS=ip_address interface on the router. b. IP_SUBNET_MASK=ip_address b. Sets the subnet mask for the Management
c. DEFAULT_GATEWAY=ip_address

Ethernet interface on the router.


c. Identifies the default gateway that serves the

Example:
rommon B1> IP_ADDRESS=1.1.1.1 rommon B2> IP_SUBNET_MASK=255.255.254.0 rommon B3> DEFAULT_GATEWAY=1.1.0.1

router.

Cisco IOS XR Getting Started Guide

A-12

Appendix A

Router Recovery and Management with ROM Monitor Reinstalling the Cisco IOS XR Software from ROMMON

Command or Action
Step 5

Purpose
a. Clears the BOOT variable. b. Clears the TFTP_FILE variable. c. Sets the TURBOBOOT parameters.

On the primary RP, clear the BOOT and TFTP filename variables and set the TURBOBOOT environment variable:
a. unset BOOT b. unset TFTP_FILE c. TURBOBOOT=on, destination, options d. sync

TURBOBOOT parameters are:


on: Enables TURBOBOOT and cleans the

destination if the format option is not specified.


destination: Specifies the disk from which the

Cisco IOS XR software boots. Available destinations are disk0 and disk1.
Example:
rommon B1> TURBOBOOT=on,disk0,format rommon B2> sync

options: Specifies the TURBOBOOT options. If

no option is specified or the clean option is entered, the destination is cleaned. To format the destination, enter the format option.
When the clean option is selected, the current

software is deleted and replaced with new packages. Other files, such as user configurations, are preserved.
When the format option is entered, the entire

flash disk is formatted before the new software packages are installed. All existing software and configurations are deleted.
d. Saves the new ROM Monitor variable settings.

Caution

The option to format disk0: deletes all router configurations. To preserve the current router configuration, copy it to another disk while still in EXEC mode. See the Managing Configuration History and Rollback section on page 3-3.

Cisco IOS XR Getting Started Guide

A-13

Appendix A Reinstalling the Cisco IOS XR Software from ROMMON

Router Recovery and Management with ROM Monitor

Command or Action
Step 6

Purpose Retrieves the file from the TFTP server and installs it on disk0:.

boot tftp://server/directory/filename
Example:
rommon B1> boot tftp://223.255.254.254/softdir/comp-hfr-mini.vm

Execute this command on the primary RP and specify the .vm installation file from the TFTP server. This process removes any existing software packages, resets the configuration register to 0x2, and boots the system. After the primary RP boots, the standby RP downloads (synchronizes) the packages from the primary RP and boots automatically. Allow the system to fully boot. If you choose the option to format disk0:, the router configuration is cleared and the router prompts you to enter a root-system username and password. If you choose the option to clean disk0:, the system is fully booted when the CLI prompt is shown and the interfaces are created. The TURBOBOOT process takes some time. Please do not enter any commands until you are prompted to enter a username or until the CLI prompt appears.

Examples
The following examples are provided:

Preparing the Standby RP, page A-14 Setting the IP Environment Variables, page A-15 Setting the TURBOBOOT Variable, page A-15 Booting the .vm Installation File, page A-15

Preparing the Standby RP


The following example shows how to clear the boot and TFTP filename environment variables, set the TURBOBOOT variable to clean the hard disk, set the configuration register to start the router in EXEC mode, and reset the standby RP:
rommon rommon rommon rommon rommon B1> B2> B4> B5> B6> unset BOOT unset TFTP_FILE sync confreg 0x2 reset

Cisco IOS XR Getting Started Guide

A-14

Appendix A

Router Recovery and Management with ROM Monitor Reinstalling the Cisco IOS XR Software from ROMMON

Setting the IP Environment Variables


The following example shows how to configure the ROM Monitor Management Ethernet interface on the primary RP:
rommon B1> IP_ADDRESS=10.1.1.1 rommon B2> IP_SUBNET_MASK=255.255.254.0 rommon B3> DEFAULT_GATEWAY=10.1.0.1

Setting the TURBOBOOT Variable


The following example shows how to set the TURBOBOOT variable on the primary RP and save the change:
rommon B1> TURBOBOOT=on,disk0,format rommon B2> sync

Booting the .vm Installation File


The following example shows how to boot the router using the specified .vm file on the specified TFTP server. Because the TURBOBOOT option was set to format disk0:, the previous configuration is erased, and the Cisco IOS XR software prompts the user to enter a root-system username and password:
rommon B2> boot tftp://10.10.10.10/software/comp-hfr-mini.vm-05.02.08 . . . bios con0/RP1/CPU0 is now available

Press RETURN to get started. . . . --- Administration User Dialog ---

Enter root-system username: crs-1 Enter secret: crs-1

Cisco IOS XR Getting Started Guide

A-15

Appendix A Reinstalling the Cisco IOS XR Software from ROMMON

Router Recovery and Management with ROM Monitor

The following configuration command script was created: username crs-1 secret 5 $1$NCmY$VBS6zCKg3baU0IrJ.IvLm/ group cisco-support ! end

[0] Return back to the setup without saving this config. [1] Save this configuration and exit. Enter your selection [1]: 1 RP/0/RP1/CPU0:Feb 17 21:54:19.709 : exec[65667]: %MGBL-LIBTARCFG-6-SYSTEM_ADMIN_ COMMIT : Administration configuration committed by system. Use the 'configure' command to modify this configuration. User Access Verification Username: crs-1 Password: RP/0/RP1/CPU0:ios#

Reinstalling the Software from a .vm File Located on Flash disk1:


This section describes the tasks required to install the Cisco IOS XR software on the flash disk0: using a .vm image stored on flash disk1:. Complete the procedures exactly as described in this section.

Note

Before booting begins, a delay of 10 minutes or more may occur while the .vm image is read to memory from the removable flash disk1: (DDTS CSCed22546).

Copying a .vm Image to disk1:


Flash disk1: can contain an archive of bootable .vm files. If these files are not present on disk1: or a different version is required, use one of the following options:

While the router is still in EXEC mode, copy the necessary .vm image from a TFTP, an FTP, or an rcp server to disk1:. This process is described in the Upgrading, Downgrading, and Installing Packages section on page 5-26. Consult your system administrator for a flash disk containing the bootable .vm file. Consult your Cisco representative for a flash disk containing the bootable.vm file. See the Obtaining Technical Assistance section on page xviii for more information.

Note

The removable disk1: is used to store archives of .vm and PIE files only. This disk cannot be used as a destination for installed software or configurations. Only disk0: can be used to store active software and configurations. See the Overview of Package Management section on page 5-18 for more information.

Prerequisites
A valid .vm image, as described in the Locating Installable Files section on page A-4, must be located on flash disk (disk1:).

Cisco IOS XR Getting Started Guide

A-16

Appendix A

Router Recovery and Management with ROM Monitor Reinstalling the Cisco IOS XR Software from ROMMON

SUMMARY STEPS
1. 2. 3.

Back up the router configuration while still in EXEC mode. Place both the standby RP and primary RP in ROM Monitor mode. Prepare the standby RP:
a. unset BOOT b. unset TFTP_FILE c. sync d. confreg 0x2 e. reset

4.

On the primary RP, clear the BOOT and TFTP filename variables and set the TURBOBOOT variable:
a. unset BOOT b. unset TFTP_FILE c. TURBOBOOT=on, destination, options d. sync

5.

boot disk1:/filename

Cisco IOS XR Getting Started Guide

A-17

Appendix A Reinstalling the Cisco IOS XR Software from ROMMON

Router Recovery and Management with ROM Monitor

DETAILED STEPS

Command or Action
Step 1

Purpose (Optional) To preserve the current router configuration, copy it to another disk while still in EXEC mode.

Back up the router configuration while still in EXEC mode.

See the Managing Configuration History and Rollback section on page 3-3 for more information.

Step 2

Place both the standby RP and primary RP in ROM Monitor mode.

See the Entering ROM Monitor Mode section on page A-25 for more information.

You must attach a terminal to each card for this procedure. All variable names are case sensitive.
a. Clears the BOOT variable. b. Clears the TFTP_FILE variable. c. Saves the changes. d. Sets the configuration register to

Step 3

Prepare the standby RP:


a. unset BOOT b. unset TFTP_FILE c. sync d. confreg 0x2 e. reset

Enter the settings exactly as shown.

Example:
rommon rommon rommon rommon rommon B1> B2> B4> B5> B6> unset BOOT unset TFTP_FILE sync confreg 0x2 reset

automatically start the boot process instead of staying in ROM Monitor mode.
e. Resets the standby RP and starts the boot

process.

Cisco IOS XR Getting Started Guide

A-18

Appendix A

Router Recovery and Management with ROM Monitor Reinstalling the Cisco IOS XR Software from ROMMON

Command or Action
Step 4

Purpose
a. Clears the BOOT variable. b. Clears the TFTP_FILE variable. c. Sets the TURBOBOOT parameters.

On the primary RP, clear the BOOT and TFTP filename variables and set the TURBOBOOT environment variable:
a. unset BOOT b. unset TFTP_FILE c. TURBOBOOT=on, destination, options d. sync

TURBOBOOT parameters are:


on: Enables TURBOBOOT and cleans the

destination if the format option is not specified.


destination: Specifies the disk from which

Example:
rommon B1> TURBOBOOT=on,disk0,format rommon B2> sync

the Cisco IOS XR software boots. Available destinations are disk0 and disk1.
options: Specifies the TURBOBOOT

options. If no option is specified or the clean option is entered, the destination is cleaned. To format the destination, enter the format option.
When the clean option is selected, the

current software is deleted and replaced with new packages. Other files, such as user configurations, are preserved.
When the format option is entered, the

entire flash disk is formatted before the new software packages are installed. All existing software and configurations are deleted.
d. Saves the configuration.

Caution

The option to format disk0: deletes all router configurations. To preserve the current router configuration, copy it to another disk while still in EXEC mode. See the Managing Configuration History and Rollback section on page 3-3

Cisco IOS XR Getting Started Guide

A-19

Appendix A Reinstalling the Cisco IOS XR Software from ROMMON

Router Recovery and Management with ROM Monitor

Command or Action
Step 5

Purpose Boots the file located on disk1: and installs it to the default disk0:.

boot disk1:/filename

Example:
rommon B1> boot disk1:/comp-hfr-mini.vm-05.02.08

This process removes any existing software packages, resets the configuration register to 0x2, and boots the system. After the primary RP boots, the standby RP downloads (synchronizes) the packages from the primary RP and boots automatically. Allow the system to fully boot. If you choose the option to format disk0:, the router configuration is cleared and you must enter a new root-system username and password when the router boot process completes. If you choose the option to clean disk0:, the system is fully booted when the CLI prompt is shown and the interfaces are created. The TURBOBOOT process takes some time. Please do not enter any commands until you are prompted to enter a username or until the CLI prompt appears. A delay of 10 minutes or more occurs while the software is read from the flash disk (DDTS CSCed22546).

Note

Examples
The following examples are provided:

Preparing the Standby RP, page A-20 Setting the TURBOBOOT Variable, page A-21 Booting the .vm Installation File, page A-21

Preparing the Standby RP

The following example shows how to clear the boot and TFTP filename environment variables, set the configuration register to start the router in EXEC mode, and reset the standby RP:
rommon rommon rommon rommon rommon B1> B2> B4> B5> B6> unset BOOT unset TFTP_FILE sync confreg 0x2 reset

Cisco IOS XR Getting Started Guide

A-20

Appendix A

Router Recovery and Management with ROM Monitor Recovering the Root Password

Setting the TURBOBOOT Variable

The following example shows how to set the TURBOBOOT variable on the primary RP and save the change:
rommon B1> TURBOBOOT=on,disk0,format rommon B2> sync

Booting the .vm Installation File

The following example shows how to boot the router using the specified .vm file on flash disk1:
rommon B1> boot disk1:/comp-hfr-mini.vm

Note

A delay of 10 minutes or more occurs while the software is read from the flash disk (DDTS CSCed22546).

What to Do Next
After the system is up, it is in normal EXEC mode, and you can execute the full range of CLI commands.

Note

If you chose the option to format disk0:, the router configuration is cleared and you must enter a root-system username and password when the boot process is complete. After reinstalling the software, you might want to do one or more of the following:
1. 2. 3.

See the Verifying the System Interfaces section on page 7-22 for instructions to verify that the interfaces are up and properly configured. Install additional software from the PIE files, as necessary. See Chapter 5, Managing Cisco IOS XR Software Packages, for more information. See the Related Documents section on page xv for a list of the additional documentation required to fully configure the router.

Recovering the Root Password


If the root password is forgotten, it can be recovered only at the designated shelf controller (DSC). To recover the password at the DSC, set the configuration register to 0x42 on the primary RP and reboot the router. When the router boots, a password recovery dialog appears. This dialog prompts you to reset the root-system username and password. After you save the new password, the configuration register automatically resets to the prior value (such as 0x2). Password recovery procedures are described in the following sections:

Recovering the Root Password on Single-RP Routers, page A-22 Recovering the Root Password on Redundant-RP Routers, page A-23

Cisco IOS XR Getting Started Guide

A-21

Appendix A Recovering the Root Password

Router Recovery and Management with ROM Monitor

Recovering the Root Password on Single-RP Routers


Use the following procedure to recover the router password from a router with a single RP.
Step 1 Step 2

Place the router in ROM Monitor mode, as described in the Entering ROM Monitor Mode section on page A-25. Set the RP configuration register to 0x42 at the ROMMON prompt:
rommon 1 > confreg 0x42

Note

The configuration register is not an environment variable like TURBOBOOT (which is described earlier in this chapter). Do not enter an equal sign when entering the confreg command. Reset or power cycle the router so that the new setting can take effect:
rommon 2 > reset

Step 3

Step 4

Press Return at the prompt to enter the password recovery dialog. Then enter the new root-system username and password and save the configuration.
router con0/0/CPU0 is now available Press RETURN to get started.

--- Administration User Dialog ---

Enter root-system username: c12000 Enter secret: c12000

The following configuration command script was created: username c12000 secret 5 $1$5b3a$YCat5x.hUoAhZYWRrE0fI0 group cisco-support ! end

[0] Return back to the setup without saving this config. [1] Save this configuration and exit. Enter your selection [1]: 1 config register will be reset to 0x102 Use the 'configure' command to modify this configuration. User Access Verification Username: c12000 Password: RP/0/0/CPU0:router#

Cisco IOS XR Getting Started Guide

A-22

Appendix A

Router Recovery and Management with ROM Monitor Recovering the Root Password

Recovering the Root Password on Redundant-RP Routers


Use the following procedure to recover the router password from a router with redundant RPs.
Step 1 Step 2

Place both RPs in ROM Monitor mode, as described in the Entering ROM Monitor Mode section on page A-25. Set the configuration register of the secondary RP to 0x0 so that the secondary RP does not take control during the password recovery:
rommon 1> confreg 0x0

Note

The configuration register is not an environment variable like TURBOBOOT (which is described earlier in this chapter). Do not enter an equal sign when entering the confreg command. Set the primary RP configuration register to 0x42:
rommon 1 > confreg 0x42

Step 3

Step 4

Reset or power cycle the router so that the new setting can take effect:
rommon 2 > reset

Step 5

Press Return at the prompt to enter the password recovery dialog. Then enter the new root-system username and password and save the configuration, as shown in the following example:
router con0/0/CPU0 is now available Press RETURN to get started.

--- Administration User Dialog ---

Enter root-system username: c12000 Enter secret: c12000

Cisco IOS XR Getting Started Guide

A-23

Appendix A Specifying an Alternative Configuration

Router Recovery and Management with ROM Monitor

The following configuration command script was created: username c12000 secret 5 $1$5b3a$YCat5x.hUoAhZYWRrE0fI0 group cisco-support ! end

[0] Return back to the setup without saving this config. [1] Save this configuration and exit. Enter your selection [1]: 1 config register will be reset to 0x102 Use the 'configure' command to modify this configuration. User Access Verification Username: c12000 Password: RP/0/0/CPU0:router#

Step 6

Set the configuration register of the secondary RP to 0x102:


rommon 1> confreg 0x102

Step 7

Reset the secondary RP so that the new setting can take effect and the secondary RP becomes operational:
rommon 2 > reset

Specifying an Alternative Configuration


Caution

The default committed configuration (disk0:/config/startup) should be sufficient for most situations. The option described in this section is for rare cases when an alternative configuration is required. Use of this method can result in system errors or downtime. To specify a temporary configuration file with the -a boot option, use the following procedure:

Step 1 Step 2

Place both RPs in ROM Monitor mode, as described in the Entering ROM Monitor Mode section on page A-25. Set the configuration register of the secondary RP to 0x0 so that the secondary RP does not take control:
rommon 1> confreg 0x0

Note

The configuration register is not an environment variable like TURBOBOOT (which is described earlier in this chapter). Do not enter an equal sign when entering the confreg command. Set the primary RP configuration register to 0x2:
rommon 1 > confreg 0x2

Step 3

Cisco IOS XR Getting Started Guide

A-24

Appendix A

Router Recovery and Management with ROM Monitor ROM Monitor Procedures

Step 4

Enter the set command to display the current environment variable settings:
rommon 2 > set

Note the filename set in the BOOT variable.


Step 5

Enter the boot command using the following command syntax: boot image a config-file-path Replace image with the filename listed in the boot variable, and replace config-file-path with the path and filename for the configuration file. Example:
rommon 3> boot tftp://223.255.254.254/images/comp-hfr-mini.vm -a /disk1:/cfgarchives/gold.conf

Note

The pathname should be a valid UNIX pathname (a slash [/] must be included after the device: disk1:/). Although this command causes the router to boot from an alternative configuration, the system reverts to the default committed configuration on the next system reload.

Step 6

Set the configuration register of the secondary RP to 0x102:


rommon 1> confreg 0x102

Step 7

Reset the secondary RP so that the new setting can take effect and the secondary RP becomes operational:
rommon 2 > reset

ROM Monitor Procedures


This section describes the following ROM Monitor tasks:

Entering ROM Monitor Mode, page A-25 Displaying the Available ROM Monitor Commands and Options, page A-29 Displaying the Configuration Register Setting, page A-30 Displaying Environment Variable Settings, page A-30 Saving Environment Variable Settings, page A-31 Exiting ROM Monitor Mode, page A-31

Entering ROM Monitor Mode


The following sections describe two ways to enter ROM Monitor mode:

Resetting the Configuration Register and Reloading the Router, page A-26 Manually Halting the Initialization Process During System Reload, page A-28

Cisco IOS XR Getting Started Guide

A-25

Appendix A ROM Monitor Procedures

Router Recovery and Management with ROM Monitor

Resetting the Configuration Register and Reloading the Router


In normal operating conditions, it should not be necessary to enter ROM Monitor mode. If you do find it necessary to place the system in ROMMON, make sure that the system is in a steady state and that you are prepared for the consequences of a system reload. In particular, verify the items described in the Prerequisites section on page A-26.

Note

If a standby RP is installed in the router, you must complete the steps for the standby after the primary RP has entered ROM Monitor mode.

Prerequisites
Before you place the router in ROM Monitor mode, verify that the system is in a steady state by doing the following:
1.

Prepare the primary RP:


a. Anticipate substantial downtime, including the loss of packet forwarding on the system. b. Verify that all changes to the active router configuration are saved with the commit command

in configuration mode.
c. Verify that all changes to the active software set are saved with the install commit command in

admin EXEC mode.


d. Verify that all install commit processes are complete with the show install committed

command in admin EXEC mode. This command displays the committed packages that become active during the next router boot.
2.

Verify that the other nodes in the system are in a steady state:
a. If a standby RP is installed, verify that it is in the ready state with the show redundancy

command in EXEC mode.


b. Verify that all available nodes in the system are in IOS-XR RUN state with the show platform

command in EXEC mode. After you have verified that the system is in a stable state, you can enter ROM Monitor mode by setting the configuration register setting and entering the reload command, as described in the following steps.

SUMMARY STEPS
1. 2. 3. 4. 5. 6.

Verify that the router is in a steady state, as described in the Prerequisites section on page A-26. Connect a terminal to the primary RP console port and log into the router. admin config-register 0x0 exit reload

Cisco IOS XR Getting Started Guide

A-26

Appendix A

Router Recovery and Management with ROM Monitor ROM Monitor Procedures

DETAILED STEPS

Command or Action
Step 1 Step 2

Purpose Ensures that all configurations are saved and that no install processes are running. Connects a terminal or PC to the primary RP console port and establishes a router management session.

Verify that the router is in a steady state, as described in the Prerequisites section on page A-26. Connect a terminal to the primary RP console port and log into the router.

See the Connecting and Communicating with the Router section on page 2-2 for more information on connecting a terminal.

Step 3

admin
Example:
RP/0/RP0/CPU0:router# admin

Enters admin EXEC mode.

Step 4

config-register 0x0
Example:
RP/0/RP0/CPU0:router(admin)# config-register 0x0

Resets the configuration register to 0x0 so that the router enters ROM Monitor mode during the next reload.

Caution

Resetting the configuration register may change the baud rate for the console.

Step 5

exit
Example:
RP/0/RP0/CPU0:router(admin)# exit

Exits admin EXEC mode.

Step 6

reload
Example:
RP/0/RP0/CPU0:router# reload

Reloads the system to enter ROM Monitor mode.

Note

When you place the primary RP in ROM Monitor mode, the system fails over to the standby RP, which then becomes the primary RP. If the router contains two RPs, repeat these steps for the second RP. Both RPs must be in ROM Monitor mode.

Tip

To verify the configuration register setting, enter the show version | include 0x command in EXEC mode or admin EXEC mode.

Examples
The following examples are provided:

Verifying the Router State: Example, page A-28 Placing the System in ROM Monitor Mode: Example, page A-28

Cisco IOS XR Getting Started Guide

A-27

Appendix A ROM Monitor Procedures

Router Recovery and Management with ROM Monitor

Verifying the Router State: Example

The following example shows the redundancy roles of both RPs and that both are operating in IOS-XR RUN state:
RP/0/RP0/CPU0:router# show redundancy This node (0/RP0/CPU0) is in ACTIVE role Partner node (0/RP1/CPU0) is in STANDBY role Standby node in 0/RP1/CPU0 is ready RP/0/RP0/CPU0:router# show platform Node Type PLIM State Config State ----------------------------------------------------------------------------0/2/SP L3LC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/2/CPU0 L3LC 16 port OC48 IOS-XR RUN PWR,NSHUT,MON 0/3/SP L3LC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/3/CPU0 L3LC 8 port 10GE IOS-XR RUN PWR,NSHUT,MON 0/RP0/CPU0 RP(Standby) N/A IOS-XR RUN PWR,NSHUT,MON 0/RP1/CPU0 RP(Active) N/A IOS-XR RUN PWR,NSHUT,MON 0/SM0/SP S123(SP) N/A IOS-XR RUN PWR,NSHUT,MON

Placing the System in ROM Monitor Mode: Example

The following example shows how to place the primary RP in ROM Monitor mode:
P/0/0/CPU0:router# admin RP/0/0/CPU0:router(admin)# config-register 0x0 Successfully set config-register to 0x0 on node 0/0/CPU0 RP/0/0/CPU0:router(admin)# exit RP/0/0/CPU0:router# reload Proceed with reload? [confirm] System Bootstrap, Version 12.0(20040624:164256) [assafb-misc1 1.14dev(0.91)] DEV ELOPMENT SOFTWARE Copyright (c) 1994-2004 by cisco Systems, Inc. DRAM DIMM Slot 1: 512M found, Slot 2: Empty MPC7450 platform with 524288 Kbytes of main memory rommon 1 >

Manually Halting the Initialization Process During System Reload


To force the router to stop loading and enter ROM Monitor mode, press Ctrl-C when you see the following message:
MBI validation sending request. HIT CTRL-C to abort

This message usually appears during the first 20 seconds of system startup. It may be necessary to press the Ctrl-C keys repeatedly during this time to ensure that the initialization process stops and the system enters ROMMON. This operation can be performed only from a terminal directly connected to the router console port. See the Connecting and Communicating with the Router section on page 2-2 for more information.

Cisco IOS XR Getting Started Guide

A-28

Appendix A

Router Recovery and Management with ROM Monitor ROM Monitor Procedures

Note

If a standby RP is installed in the system, repeat this process for both RPs. When the primary RP is placed in ROMMON, it fails over to the standby RP, which can then also be placed in ROMMON.

Displaying the Available ROM Monitor Commands and Options


Table A-5 describes the available help commands for ROM Monitor mode.
Table A-5 Help Commands in ROMMON

Command help or ? -?

Description Displays a summary of all available ROM Monitor commands. Displays information about command syntax.

Note

Commands are case sensitive. You can halt any command by pressing Ctrl-C.

Examples
The following example shows what appears when you enter the ? command:
rommon B5 > ? alias show_bcm_links show_bcm boot confreg cont context dev dir dis dnld help history meminfo dumpspd dumpplaneeeprom repeat reset scanpci0 scanpci1 set smptest sync tftpdnld unalias unset version writei2c rommon B2 > set and display aliases command Show Links status on Broadcom Switches Show Broadcom Switches Information boot up an external process configuration register utility continue executing a downloaded image display the context of a loaded image list the device table list files in file system disassemble instruction stream serial download a program module monitor builtin command help monitor command history main memory information Dump the Serial Presents Detect info from the SDRAM DIMMs Dump the contents of the back plane repeat a monitor command system reset scan for devices on PCI bus 0 scan for devices on PCI bus 1 display the monitor variables Test the other CPU on an SMP board write monitor environment to NVRAM tftpdnld no longer available, use boot unset an alias unset a monitor variable display rommon software, board, version Write to an I2C device

Cisco IOS XR Getting Started Guide

A-29

Appendix A ROM Monitor Procedures

Router Recovery and Management with ROM Monitor

The following example shows the parameters for the dir (directory) command:
rommon 7 > dir -? bad device name usage: dir <device>

Displaying the Configuration Register Setting


To display the current configuration register setting, enter the confreg command without parameters as follows:
rommon B1 > confreg

Configuration Summary (Virtual Configuration Register: 0x0) enabled are: console baud: 9600 boot: the ROM Monitor do you wish to change the configuration? y/n [n]:

The configuration register setting is labeled Virtual Configuration Register. Enter no to avoid changing the configuration register setting. To change the configuration setting with this command, see the Resetting to EXEC Mode Using Prompts section on page A-32.

Displaying Environment Variable Settings


To display the current environment variable settings, enter the set command as follows:
rommon B1 > set PS1=rommon ! > MARGIN_1_5V_HIGH=1 TFTP_VERBOSE=2 IP_ADDRESS=1.1.1.1 IP_SUBNET_MASK=255.255.0.0 TFTP_SERVER= DEFAULT_GATEWAY=12.25.0.1 TFTP_FILE= CONFIG_FILE= ?=0 ReloadReason=65 BOOT=disk0:hfr-os-mbi-1.0.0/mbihfr-rp.vm,1; rommon B2 >

Cisco IOS XR Getting Started Guide

A-30

Appendix A

Router Recovery and Management with ROM Monitor ROM Monitor Procedures

Saving Environment Variable Settings


To save the current environment variable settings, enter the sync command as follows:
rommon B1 > sync

Note

Environmental values that are not saved with the sync command are discarded whenever the system is reset or booted.

Exiting ROM Monitor Mode


To exit ROM Monitor mode, you must change the configuration register to 0x2 and reset the router. This process can be done by either entering CLI commands or responding to prompts.

Tip

The first RP to enter EXEC mode becomes the primary RP. You can determine which RP is the primary RP by resetting that card to EXEC mode first and then waiting 1 to 2 minutes to allow it to boot fully. You can also fail over to the standby RP at any time with the redundancy switchover command in EXEC mode. The following sections describe ways to exit ROM Monitor mode:

Resetting to EXEC Mode with CLI Commands, page A-31 Resetting to EXEC Mode Using Prompts, page A-32

Resetting to EXEC Mode with CLI Commands


Perform this task to reset the configuration register in ROMMON and start the router in EXEC mode.

SUMMARY STEPS
1. 2.

confreg 0x2 reset

DETAILED STEPS

Command or Action
Step 1

Purpose Resets the configuration register to enter EXEC mode when the system is reset.

confreg 0x2
Example:
rommon B1> confreg 0x2

Step 2

reset
Example:
rommon B1> reset

Resets and initializes the router.

Cisco IOS XR Getting Started Guide

A-31

Appendix A ROM Monitor Procedures

Router Recovery and Management with ROM Monitor

Resetting to EXEC Mode Using Prompts


In ROM Monitor mode, you can also change the configuration register value using the configuration register prompts. Enter the confreg command, as shown in the following example, and respond to each question when prompted.

SUMMARY STEPS
1. 2. 3.

confreg Respond to each prompt as instructed. reset

DETAILED STEPS

Command or Action
Step 1

Purpose Initiates the configuration register configuration prompts.

confreg
Example:
rommon B1> confreg 0x2

Step 1 Step 2

Respond to each prompt as instructed. reset


Example:
rommon B1> reset

For more information, see the example that follows this procedure. Resets and initializes the router.

Cisco IOS XR Getting Started Guide

A-32

Appendix A

Router Recovery and Management with ROM Monitor ROM Monitor Procedures

Examples
The following example shows the commands required and the prompts that appear when you reset the router to EXEC mode using the configuration register prompts:
rommon B1> confreg

Configuration Summary (Virtual Configuration Register: 0x0) enabled are: console baud: 9600 boot: the ROM Monitor do you wish to change the configuration? y/n enable "diagnostic mode"? y/n [n]: n change console baud rate? y/n [n]: n change the boot characteristics? y/n [n]: y enter to boot: 0 = ROM Monitor 1 = MBI Validation Boot Mode [0]: 1 [n]: y

Configuration Summary (Virtual Configuration Register: 0x2) enabled are: console baud: 9600 boot: image specified by the boot system commands do you wish to change the configuration? y/n [n]: n

You must reset or power cycle for new config to take effect rommon B2> reset

Note

MBI validation mode causes the router to boot the startup Cisco IOS XR software and configuration.

Cisco IOS XR Getting Started Guide

A-33

Appendix A ROM Monitor Procedures

Router Recovery and Management with ROM Monitor

Cisco IOS XR Getting Started Guide

A-34

A P P E N D I X

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers


This appendix describes how to upgrade or downgrade the ROM Monitor software on a Cisco CRS-1.

Contents

Information About ROM Monitor Software, page B-1 How to Upgrade or Downgrade ROM Monitor, page B-3 Configuration Examples for ROM Monitor Upgrades, page B-7 Additional References, page B-13

Information About ROM Monitor Software


Before upgrading or downgrading ROM Monitor software, you should understand the following concept:

ROM Monitor Upgrade and Downgrade Basics, page B-1

ROM Monitor Upgrade and Downgrade Basics


The ROM Monitor, which is also known as ROMMON, is a bootstrap program that initializes the hardware and boots the Cisco IOS XR software when you power on or restart a Cisco CRS-1. ROM Monitor upgrades can be required to resolve software defects or support new features. Typically, ROM Monitor upgrades are infrequent and not required for every Cisco IOS XR software upgrade.

Tip

Information on operating the router in ROM Monitor mode is provided in Appendix A, Router Recovery and Management with ROM Monitor. In the Cisco CRS-1, two copies of ROM Monitor exist: ROMMON A and ROMMON B. During power on, ROMMON A loads first. If ROMMON A detects the presence of ROMMON B, it checks the compatibility and integrity of the ROMMON B code. If ROMMON B passes these tests, ROMMON A passes control of the router to ROMMON B.

Cisco IOS XR Getting Started Guide

B-1

Appendix B Information About ROM Monitor Software

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers

The upgrade and downgrade procedures for ROM Monitor are the same. During the upgrade or downgrade process, you select the firmware that is used for ROM Monitor. This firmware can represent an upgrade or a downgrade. The firmware must be compatible with the hardware, but it need not be a later version of the ROM Monitor already installed. During an upgrade or downgrade, the firmware is copied into hardware EEPROMs in the router. ROM Monitor operates on every node within the router. For most upgrades, we recommend that you upgrade ROM Monitor on all nodes. However, the software does allow you to upgrade a single node, and this is useful when moving a card between two routers or adding a card that is not running the preferred ROM Monitor version. When you upgrade a single node that uses ROM Monitor in both the CPU0 and SP modules, such as a line card node, we recommend that you upgrade both modules to the same ROM Monitor version. The ROM Monitor firmware is distributed in a .tar package file. The individual filenames are:

rommon-hfr-ppc7450-sc-dsmp-A.bin rommon-hfr-ppc7450-sc-dsmp-B.bin rommon-hfr-ppc7455-asmp-A.bin rommon-hfr-ppc7455-asmp-B.bin rommon-hfr-ppc8255-sp-A.bin rommon-hfr-ppc8255-sp-B.bin

The filenames are fixed and do not include version information, which is stored within the file and in the tar file name. When upgrading ROM Monitor, it is best to unpack the tar file only when you are ready to install the file. This way, you can be sure which version you are installing. The format for the tar file name is: rommon-version.tar The version component of the filename is a version number, such as 1.19. To prepare for a ROM Monitor upgrade, the tar file must be copied to a workstation that can unpack the file. Next, the individual files must be copied to the root directory of a router device (for example, disk0:). During a ROM Monitor upgrade, the software detects each card type and automatically selects the correct file for the upgrade on that card. ROM Monitor is typically updated less frequently than the run-time router software. To see if the ROMMON for your router needs to be updated, see the ROMMON version information at the following URL: http://www.cisco.com/cgi-bin/tablebuild.pl/crs1rommon If only one ROM Monitor tar file is listed, no updates are available. If more than one ROM Monitor tar file is listed, compare your ROM Monitor version (show diag command) with the version numbers posted. If multiple tar files are listed on the web site, the software distribution website specifies whether only ROMMON B or both ROMMON A and ROMMON B should be upgraded. When you upgrade only ROMMON B, the router can still use the unmodified ROMMON A if the ROM Monitor upgrade is interrupted or fails for any reason. If the new ROM Monitor is not compatible with the older installed version, both ROMMON A and ROMMON B must be upgraded.

Cisco IOS XR Getting Started Guide

B-2

Appendix B

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers How to Upgrade or Downgrade ROM Monitor

How to Upgrade or Downgrade ROM Monitor


This section contains the following procedures:

Upgrading or Downgrading ROM Monitor, page B-3

Upgrading or Downgrading ROM Monitor


The following procedure upgrades or downgrades the ROM Monitor using the six ROM Monitor upgrade files, which are packaged in a .tar file.

Prerequisites
Before starting the procedure described in the next section, do the following:

Determine if there is an upgrade tar file for your version of Cisco IOS XR software. If only one tar file is listed on the upgrade web site, no updates are available. You can display the ROM Monitor tar files at the following URL: http://www.cisco.com/cgi-bin/tablebuild.pl/crs1rommon To prepare for a ROM Monitor upgrade, copy the tar file to a workstation that has the software to unpack tar files, then unpack the files. Upgrade the ROMMON firmware before downloading any new Cisco IOS XR software installation files to the local storage device of the router. The Cisco IOS XR software files may not be available if you conduct a single failover during the ROMMON upgrade procedure. For example, if you download the Cisco IOS XR software files to disk0 on RP0, upgrade the ROMMON firmware, and then failover to RP1, the Cisco IOS XR software installation files located on disk0 of RP0 will not be accessible from the new active RP. You can also perform an additional RP failover to return the active role to the original RP.

SUMMARY STEPS
1. 2. 3. 4. 5. 6. 7. 8. 9.

show diag copy source destination dir device If you are upgrading only ROMMON B, go to Step 10. show platform admin upgrade rommon A {all | [location nodeID]} device exit show logging | include burner

10. show platform 11. admin 12. upgrade rommon B {all | [location nodeID]} device 13. exit 14. show logging | include burner

Cisco IOS XR Getting Started Guide

B-3

Appendix B How to Upgrade or Downgrade ROM Monitor

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers

15. If you are upgrading a router with a single RP, go to Step 21. 16. If you are upgrading a single node on a router, go to Step 23. 17. redundancy switchover 18. redundancy switchover 19. hw-module location nodeID reload 20. Go to Step 24. 21. reload 22. Go to Step 24. 23. hw-module location nodeID reload 24. show diag

DETAILED STEPS

Command or Action
Step 1
show diag

Purpose Displays hardware information and ROM Monitor information for each node in the router.

Example:
RP/0/RP0/CPU0:Router# show diag

Review the command display to determine which version of ROM Monitor is in use on each node. If the correct version is in use, there is no need to upgrade. Copy the files to the root directory of any device on the router. For example, you can copy the files to disk0:.

Step 2

copy source destination

Copies the ROM Monitor upgrade files to the router.

Example:
RP/0/RP0/CPU0:router# copy tftp://223.255.254.254/software/rommon-hfr-ppc7 450-sc-dsmp-A.bin disk0: RP/0/RP0/CPU0:router# copy tftp://223.255.254.254/software/rommon-hfr-romm on-hfr-ppc7450-sc-dsmp-B.bin disk0: RP/0/RP0/CPU0:router# copy tftp://223.255.254.254/software/rommon-hfr-romm on-hfr-ppc7455-asmp-A.bin disk0: RP/0/RP0/CPU0:router# copy tftp://223.255.254.254/software/rommon-hfr-romm on-hfr-ppc7455-asmp-B.bin disk0: RP/0/RP0/CPU0:router# copy tftp://223.255.254.254/software/rommon-hfr-romm on-hfr-ppc8255-sp-A.bin disk0: tftp://223.255.254.254/software/rommon-hfr-romm on-hfr-ppc8255-sp-B.bin disk0: RP/0/RP0/CPU0:router# dir disk0:

Step 3

dir device

Displays the directory contents for a device root directory.

Verify that the upgrade files appear in the directory.

Example:
RP/0/RP0/CPU0:Router# dir disk0:

Step 4

If you are upgrading only ROMMON B, go to Step 10.

Cisco IOS XR Getting Started Guide

B-4

Appendix B

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers How to Upgrade or Downgrade ROM Monitor

Command or Action
Step 5
show platform

Purpose Displays the state of all nodes.

Example:
RP/0/RP0/CPU0:Router# show platform

Review the command display and verify that the state for each node is IOS-XR RUN.

Step 6

admin

Places the router in admin EXEC mode.

Example:
RP/0/RP0/CPU0:Router# admin

Step 7

upgrade rommon A {all | [location nodeID]} device

Upgrades ROMMON A code for one or all nodes using the ROM Monitor code on the specified device.

To upgrade all nodes, use the all keyword. To update a single node, use the location keyword and enter the node ID displayed by the show platform command. If you are upgrading a line card, both the CPU and SP modules should be upgraded to the same ROM Monitor version. To accomplish this with a single command, replace the module part of the location identifier with an asterisk (*). For example, upgrade rommon A location 0/2/*. Do not power cycle the router, reload the router, or reset any nodes until all upgrades are completed.

Example:
RP/0/RP0/CPU0:Router(admin)# upgrade rommon A all disk0

Note

Step 8
exit

Exits admin EXEC mode.

Example:
RP/0/RP0/CPU0:Router(admin)# exit

Step 9

show logging | include burner

(Optional) Displays all ROM Monitor upgrade messages in the log.

Example:
RP/0/RP0/CPU0:Router# show logging | include burner

This step is optional when it is easy to view all ROM Monitor upgrade messages on the router. When the ROM Monitor upgrade messages are mixed with other log messages, this step can make it easier to view the upgrade status. Review the log display and verify that the upgrade for all nodes has been successfully completed. Review the command display and verify that the state for each node is IOS-XR RUN.

Step 10
show platform

Displays the state of all nodes.

Example:
RP/0/RP0/CPU0:Router# show platform

Step 11

admin

Places the router in admin EXEC mode.

Example:
RP/0/RP0/CPU0:Router# admin

Cisco IOS XR Getting Started Guide

B-5

Appendix B How to Upgrade or Downgrade ROM Monitor

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers

Command or Action
Step 12
upgrade rommon B {all | [location nodeID]} device

Purpose Upgrades ROMMON B code for one or all nodes using the ROM Monitor code on the specified device.

To upgrade all nodes, use the all keyword. To update a single node, use the location keyword and enter the node ID displayed by the show platform command. If you are upgrading a line card, both the CPU and SP modules should be upgraded to the same ROM Monitor version. To accomplish this with a single command, replace the module part of the location identifier with an asterisk (*). For example, upgrade rommon B location 0/2/*. Do not power cycle the router, reload the router, or reset any nodes until all upgrades are completed.

Example:
RP/0/RP0/CPU0:Router(admin)# upgrade rommon B all disk1:

Note

Step 13
exit

Exits admin EXEC mode.

Example:
RP/0/RP0/CPU0:Router(admin)# exit

Step 14

show logging | include burner

(Optional) Displays all ROM Monitor upgrade messages in the log.

Example:
RP/0/RP0/CPU0:Router# show logging | include burner

This step is optional when it is easy to view all ROM Monitor upgrade messages on the router. When the ROM Monitor upgrade messages are mixed with other log messages, this step can make it easier to view the upgrade status. Review the log display and verify that the upgrade for all nodes has been successfully completed.

Step 15 Step 16 Step 17

If you are upgrading a router with a single RP, go to Step 21. If you are upgrading a single node on a router, go to Step 23.
redundancy switchover

Reloads the active RP in a dual RP router with the upgraded ROM Monitor software.
Note

Example:
RP/0/RP0/CPU0:Router# redundancy switchover

The redundancy switchover command does not reload the software if the standby RP is not ready to take over.

Step 18

redundancy switchover

Reloads the second RP in a dual RP router with the upgraded ROM Monitor software.
Note

Example:
RP/0/RP1/CPU0:Router# redundancy switchover

The redundancy switchover command does not reload the software if the standby RP is not ready to take over.

Cisco IOS XR Getting Started Guide

B-6

Appendix B

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers Configuration Examples for ROM Monitor Upgrades

Command or Action
Step 19
hw-module location nodeID reload

Purpose Reloads a card in the router. Use the hw-module location nodeID reload command to reload each card where the ROMMON firmware was changed.

Example:
RP/0/RP1/CPU0:Router# hw-module location 0/0/cpu0 reload

Step 20 Step 21

Go to Step 24.
reload

Reloads the RP in a single RP router with the upgraded ROM Monitor software.
Note

Reloading a single RP router interrupts all service.

Use the hw-module location nodeID reload command to reload each additional card where the ROMMON firmware was changed. Each node must be reloaded to activate the new ROMMON firmware. See Step 23.
Step 22 Step 23

Go to Step 24.
hw-module location nodeID reload

Reloads a single node or all nodes within a router with the upgraded ROM Monitor software.

Example:
RP/0/RP0/CPU0:Router# hw-module location 0/RP0/CPU0 reload

Replace nodeID with the node ID you specified when upgrading ROM Monitor.

Step 24

show diag

Displays hardware information and ROM Monitor information for each node in the router.

Example:
RP/0/RP0/CPU0:Router# show diag

Review the command display and verify that the appropriate nodes are using the upgraded version of ROM Monitor.

Troubleshooting Tips

If any node cannot be upgraded successfully or if you see error messages similar to the following message, try reformatting the bootflash (format bootflash: [location all | nodeID]) and then repeat this upgrade procedure:
LC/0/3/CPU0:rommon_burner[65635]: %ROMMON_BURNER-3-FILE_OP_ERR : Opening ROMMON flash partition failed: No such file or directory in function main at line 952

If you are upgrading only ROMMON B and the version does not change to the expected version after the upgrade, the upgrade might have failed. When the router cannot load ROMMON B, it loads ROMMON A. If both ROMMAN B and ROMMON A are damaged due to an unexpected node reset or a power interruption during the upgrade, the affected route processors must be returned to Cisco for repair.

Configuration Examples for ROM Monitor Upgrades


This section provides the following configuration examples:

ROM Monitor Upgrade: Example, page B-8

Cisco IOS XR Getting Started Guide

B-7

Appendix B Configuration Examples for ROM Monitor Upgrades

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers

ROM Monitor Upgrade: Example


The following example shows a ROMMON B upgrade on a router with a single RP:
RP/0/RP0/CPU0:Router# show diag NODE 0/0/SP : MSC(SP) MAIN: type 500060, 0800-019840-1033 rev 01 dev 010cd8 HW version 0.0 S/N SAD07290129 PCA: 0073-007648-04 rev 08 Board State : IOS-XR RUN PLD: Motherboard: 0xf425, Processor: 0x0000, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.15(20040603:013227) [CRS-1 ROMMON]

NODE 0/0/CPU0 : MSC(16OC48-POS/DPT) MAIN: type 500060, 0800-019840-1033 rev 01 dev 010cd8 HW version 0.0 S/N SAD07290129 PCA: 0073-007648-04 rev 08 Board State : IOS-XR RUN PLD: Motherboard: 0x0025, Processor: 0xda13, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.15(20040603:013406) [CRS-1 ROMMON]

NODE 0/2/SP : 4OC192-POS/DPT PLIM PRESENT NODE 0/3/SP : MSC(SP) MAIN: type 500060, 0800-025021-259 rev 01 dev 000000 HW version 0.0 S/N SAD074907X6 PCA: 0073-007648-06 rev 11 Board State : IOS-XR RUN PLD: Motherboard: 0xfa25, Processor: 0x0000, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.15(20040603:013227) [CRS-1 ROMMON]

NODE 0/3/CPU0 : MSC(16OC48-POS/DPT) MAIN: type 500060, 0800-025021-259 rev 01 dev 000000 HW version 0.0 S/N SAD074907X6 PCA: 0073-007648-06 rev 11 Board State : IOS-XR RUN PLD: Motherboard: 0x0025, Processor: 0xda13, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.15(20040603:013406) [CRS-1 ROMMON]

NODE 0/RP0/CPU0 : RP MAIN: type 100000, 0000-000000-00 rev 01 dev 000000 HW version 0.0 S/N SAD07150223 PCA: 0073-007641-04 rev 05 Board State : IOS-XR RUN PLD: Motherboard: 0x0018, Processor: 0xda13, Power: 0x001f MONLIB: QNXFFS Monlib Version 2.1 ROMMON: Version 1.15(20040603:013406) [CRS-1 ROMMON]

Cisco IOS XR Getting Started Guide

B-8

Appendix B

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers Configuration Examples for ROM Monitor Upgrades

NODE 0/SM0/SP : FC/S MAIN: type 400030, 0800-018560-800 rev 01 dev 000000 HW version 0.0 S/N SAD071701ZD PCA: 0073-007302-06 rev 06 Board State : IOS-XR RUN PLD: Motherboard: 0x0019, Processor: 0x0000, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.15(20040603:013227) [CRS-1 ROMMON]

RACK 0 : MINIQ MAIN: type 0001e2, 65535-16777215-65535 rev XX dev ffffff HW version 255.255 S/N TBC06366072 PCA: 65535-16777215-255 rev XX RP/0/RP0/CPU0:Router# copy tftp:software/rommon-hfr-ppc7450-sc-dsmp-A.bin disk0:/ Destination filename [/disk0:/rommon-hfr-ppc7450-sc-dsmp-A.bin]? Accessing tftp://223.255.254.254/software/rommon-hfr-ppc7450-sc-dsmp-A.bin CCCCCCCCCCCCCCCCCCCCCCC 360464 bytes copied in 1 sec ( 198384)bytes/sec RP/0/RP0/CPU0:Router# copy tftp:software/rommon-hfr-ppc7450-sc-dsmp-B.bin disk0:/ Destination filename [/disk0:/rommon-hfr-ppc7450-sc-dsmp-B.bin]? Accessing tftp://223.255.254.254/software/rommon-hfr-ppc7450-sc-dsmp-B.bin CCCCCCCCCCCCCCCCCCCCCCC 360464 bytes copied in 1 sec ( 198384)bytes/sec RP/0/RP0/CPU0:Router# copy tftp:software/rommon-hfr-ppc7455-asmp-A.bin disk0:/ Destination filename [/disk0:/rommon-hfr-ppc7455-asmp-A.bin]? Accessing tftp://223.255.254.254/software/rommon-hfr-ppc7455-asmp-A.bin CCCCCCCCCCCCCCCCCCCCCCC 372752 bytes copied in 1 sec ( 230093)bytes/sec RP/0/RP0/CPU0:Router# copy tftp:software/rommon-hfr-ppc7455-asmp-B.bin disk0:/ Destination filename [/disk0:/rommon-hfr-ppc7455-asmp-B.bin]? Accessing tftp://223.255.254.254/software/rommon-hfr-ppc7455-asmp-B.bin CCCCCCCCCCCCCCCCCCCCCCC 372752 bytes copied in 1 sec ( 242204)bytes/sec RP/0/RP0/CPU0:Router# copy tftp:software/rommon-hfr-ppc8255-sp-A.bin disk0:/ Destination filename [/disk0:/rommon-hfr-ppc8255-sp-A.bin]? Accessing tftp://223.255.254.254/software/rommon-hfr-ppc8255-sp-A.bin CCCCCCCCCCCCCCCC 252536 bytes copied in 0 sec RP/0/RP0/CPU0:Router# copy tftp:software/rommon-hfr-ppc8255-sp-B.bin disk0:/ Destination filename [/disk0:/rommon-hfr-ppc8255-sp-B.bin]? Accessing tftp://223.255.254.254/software/rommon-hfr-ppc8255-sp-B.bin CCCCCCCCCCCCCCCC 252124 bytes copied in 0 sec RP/0/RP0/CPU0:Router# dir disk0:

Cisco IOS XR Getting Started Guide

B-9

Appendix B Configuration Examples for ROM Monitor Upgrades

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers

Directory of disk0: 2 5 1237 1239 3630 5225 6516 6870 8029 4 8900 8908 8909 66624 mp-A.bin 66752 mp-B.bin 66880 A.bin 67008 B.bin 67136 bin 67264 bin drwx drwx drwx drwx drwx drwx drwx drwx drwx drwx dr-x drwx drwx -rwx -rwx -rwx -rwx -rwx -rwx 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 16384 360464 360464 372752 372752 252536 252124 Tue Tue Tue Tue Tue Tue Tue Tue Tue Tue Tue Tue Tue Tue Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul 20 20 20 20 20 20 20 20 20 20 20 20 20 20 16:55:00 16:56:00 17:06:33 17:00:44 16:58:30 17:02:08 17:02:40 17:03:52 17:04:46 17:07:24 17:22:54 17:18:51 17:18:51 17:01:56 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 2004 LOST.DIR hfr-os-mbi-0.48.0 instdb hfr-base-0.48.0 shutdown hfr-admin-0.48.0 hfr-fwdg-0.48.0 hfr-lc-0.48.0 hfr-rout-0.48.0 config aaa usr var rommon-hfr-ppc7450-sc-ds rommon-hfr-ppc7450-sc-ds rommon-hfr-ppc7455-asmprommon-hfr-ppc7455-asmprommon-hfr-ppc8255-sp-A. rommon-hfr-ppc8255-sp-B.

Tue Jul 20 17:01:56 2004 Tue Jul 20 17:01:58 2004 Tue Jul 20 17:01:58 2004 Tue Jul 20 17:02:00 2004 Tue Jul 20 17:02:00 2004

1024606208 bytes total (876625920 bytes free) RP/0/RP0/CPU0:Router# show platform Node Type PLIM State Config State ----------------------------------------------------------------------------0/0/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/0/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/3/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/3/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/RP0/CPU0 RP(Active) N/A IOS-XR RUN PWR,NSHUT,MON 0/SM0/SP FC/S(SP) N/A IOS-XR RUN PWR,NSHUT,MON RP/0/RP0/CPU0:Router(admin)# upgrade rommon A all disk0 Please do not power cycle, reload the router or reset any nodes until all upgrades are completed. Please check the syslog to make sure that all nodes are upgraded successfully. If you need to perform multiple upgrades, please wait for current upgrade to be completed before proceeding to another upgrade. Failure to do so may render the cards under upgrade to be unusable. RP/0/RP0/CPU0:Router#RP/0/RP0/CPU0Jul 20 18:02:04.794 : rommon_burner[65718]: %R OMMON_BURNER-5-progress : ROMMON A is programmed successfully. LC/0/0/CPU0Jul 20 18:19:44.573 : rommon_burner[65636]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. LC/0/3/CPU0Jul 20 18:02:05.380 : rommon_burner[65636]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. SP/0/0/SPJul 20 18:02:05.907 : rommon_burner[65582]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. SP/0/SM0/SPJul 20 18:02:05.950 : rommon_burner[65584]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. SP/0/3/SPJul 20 18:02:06.244 : rommon_burner[65582]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully.

Cisco IOS XR Getting Started Guide

B-10

Appendix B

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers Configuration Examples for ROM Monitor Upgrades

RP/0/RP0/CPU0:Router# show logging | include burner RP/0/RP0/CPU0Jul 20 18:02:04.794 : rommon_burner[65718]: %ROMMON_BURNER-5-progre ss : ROMMON A is programmed successfully. LC/0/0/CPU0Jul 20 18:19:44.573 : rommon_burner[65636]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. LC/0/3/CPU0Jul 20 18:02:05.380 : rommon_burner[65636]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. SP/0/0/SPJul 20 18:02:05.907 : rommon_burner[65582]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. SP/0/SM0/SPJul 20 18:02:05.950 : rommon_burner[65584]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. SP/0/3/SPJul 20 18:02:06.244 : rommon_burner[65582]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. RP/0/RP0/CPU0:Router# show platform Node Type PLIM State Config State ----------------------------------------------------------------------------0/0/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/0/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/3/SP MSC(SP) N/A IOS-XR RUN PWR,NSHUT,MON 0/3/CPU0 MSC 16OC48-POS/DPT IOS-XR RUN PWR,NSHUT,MON 0/RP0/CPU0 RP(Active) N/A IOS-XR RUN PWR,NSHUT,MON 0/SM0/SP FC/S(SP) N/A IOS-XR RUN PWR,NSHUT,MON RP/0/RP0/CPU0:Router(admin)# upgrade rommon B all disk0 Please do not power cycle, reload the router or reset any nodes until all upgrades are completed. Please check the syslog to make sure that all nodes are upgraded successfully. If you need to perform multiple upgrades, please wait for current upgrade to be completed before proceeding to another upgrade. Failure to do so may render the cards under upgrade to be unusable. RP/0/RP0/CPU0:Router#LC/0/0/CPU0Jul 20 18:26:56.764 : rommon_burner[65637]: %ROM MON_BURNER-5-progress : ROMMON B is programmed successfully. RP/0/RP0/CPU0Jul 20 18:07:30.084 : rommon_burner[65719]: %ROMMON_BURNER-5-progre ss : ROMMON B is programmed successfully. LC/0/3/CPU0Jul 20 18:07:30.902 : rommon_burner[65637]: %ROMMON_BURNER-5-progress : ROMMON B is programmed successfully. SP/0/0/SPJul 20 18:07:30.949 : rommon_burner[65583]: %ROMMON_BURNER-5-progress : ROMMON B is programmed successfully. SP/0/SM0/SPJul 20 18:07:31.120 : rommon_burner[65585]: %ROMMON_BURNER-5-progress : ROMMON B is programmed successfully. SP/0/3/SPJul 20 18:07:31.645 : rommon_burner[65583]: %ROMMON_BURNER-5-progress : ROMMON B is programmed successfully. RP/0/RP0/CPU0:Router# show logging | include burner RP/0/RP0/CPU0Jul 20 18:02:04.794 : rommon_burner[65718]: %ROMMON_BURNER-5-progre ss : ROMMON A is programmed successfully. LC/0/0/CPU0Jul 20 18:19:44.573 : rommon_burner[65636]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. LC/0/3/CPU0Jul 20 18:02:05.380 : rommon_burner[65636]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. SP/0/0/SPJul 20 18:02:05.907 : rommon_burner[65582]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. SP/0/SM0/SPJul 20 18:02:05.950 : rommon_burner[65584]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. SP/0/3/SPJul 20 18:02:06.244 : rommon_burner[65582]: %ROMMON_BURNER-5-progress : ROMMON A is programmed successfully. LC/0/0/CPU0Jul 20 18:26:56.764 : rommon_burner[65637]: %ROMMON_BURNER-5-progress : ROMMON B is programmed successfully.

Cisco IOS XR Getting Started Guide

B-11

Appendix B Configuration Examples for ROM Monitor Upgrades

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers

RP/0/RP0/CPU0Jul 20 18:07:30.084 : rommon_burner[65719]: %ROMMON_BURNER-5-progre ss : ROMMON B is programmed successfully. LC/0/3/CPU0Jul 20 18:07:30.902 : rommon_burner[65637]: %ROMMON_BURNER-5-progress : ROMMON B is programmed successfully. SP/0/0/SPJul 20 18:07:30.949 : rommon_burner[65583]: %ROMMON_BURNER-5-progress : ROMMON B is programmed successfully. SP/0/SM0/SPJul 20 18:07:31.120 : rommon_burner[65585]: %ROMMON_BURNER-5-progress : ROMMON B is programmed successfully. SP/0/3/SPJul 20 18:07:31.645 : rommon_burner[65583]: %ROMMON_BURNER-5-progress : ROMMON B is programmed successfully. RP/0/RP0/CPU0:Router# reload Proceed with reload? [confirm] . . . RP/0/RP0/CPU0:Router# show diag NODE 0/0/SP : MSC(SP) MAIN: type 500060, 0800-019840-1033 rev 01 dev 010cd8 HW version 0.0 S/N SAD07290129 PCA: 0073-007648-04 rev 08 Board State : IOS-XR RUN PLD: Motherboard: 0xfe25, Processor: 0x0000, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.19(20040603:013227) [CRS-1 ROMMON]

NODE 0/0/CPU0 : MSC(16OC48-POS/DPT) MAIN: type 500060, 0800-019840-1033 rev 01 dev 010cd8 HW version 0.0 S/N SAD07290129 PCA: 0073-007648-04 rev 08 Board State : IOS-XR RUN PLD: Motherboard: 0x0025, Processor: 0xda13, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.19(20040603:013406) [CRS-1 ROMMON]

NODE 0/2/SP : 4OC192-POS/DPT PLIM PRESENT NODE 0/3/SP : MSC(SP) MAIN: type 500060, 0800-025021-259 rev 01 dev 000000 HW version 0.0 S/N SAD074907X6 PCA: 0073-007648-06 rev 11 Board State : IOS-XR RUN PLD: Motherboard: 0xfa25, Processor: 0x0000, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.19(20040603:013227) [CRS-1 ROMMON] NODE 0/3/CPU0 : MSC(16OC48-POS/DPT) MAIN: type 500060, 0800-025021-259 rev 01 dev 000000 HW version 0.0 S/N SAD074907X6 PCA: 0073-007648-06 rev 11 Board State : IOS-XR RUN PLD: Motherboard: 0x0025, Processor: 0xda13, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.19(20040603:013406) [CRS-1 ROMMON]

Cisco IOS XR Getting Started Guide

B-12

Appendix B

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers Additional References

NODE 0/RP0/CPU0 : RP MAIN: type 100000, 0000-000000-00 rev 01 dev 000000 HW version 0.0 S/N SAD07150223 PCA: 0073-007641-04 rev 05 Board State : IOS-XR RUN PLD: Motherboard: 0x0018, Processor: 0xda13, Power: 0x001f MONLIB: QNXFFS Monlib Version 2.1 ROMMON: Version 1.19(20040603:013406) [CRS-1 ROMMON]

NODE 0/SM0/SP : FC/S MAIN: type 400030, 0800-018560-800 rev 01 dev 000000 HW version 0.0 S/N SAD071701ZD PCA: 0073-007302-06 rev 06 Board State : IOS-XR RUN PLD: Motherboard: 0x0019, Processor: 0x0000, Power: N/A MONLIB: QNXFFS Monlib Version 2.2 ROMMON: Version 1.19(20040603:013227) [CRS-1 ROMMON]

RACK 0 : MINIQ MAIN: type 0001e2, 65535-16777215-65535 rev XX dev ffffff HW version 255.255 S/N TBC06366072 PCA: 65535-16777215-255 rev XX

Additional References
Related Documents
Related Topic Hardware component commands System management commands Document Title Cisco IOS XR Interface and Hardware Component Command Reference Cisco IOS XR System Management Command Reference

Technical Assistance
Description Link http://www.cisco.com/techsupport The Cisco Technical Support website contains thousands of pages of searchable technical content, including links to products, technologies, solutions, technical tips, and tools. Registered Cisco.com users can log in from this page to access even more content.

Cisco IOS XR Getting Started Guide

B-13

Appendix B Additional References

Upgrading and Downgrading ROM Monitor Software on Cisco CRS-1 Routers

Cisco IOS XR Getting Started Guide

B-14

A P P E N D I X

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers
This appendix describes how to upgrade or downgrade the boothelper and ROM Monitor software on a Cisco XR 12000 Series Router.

Contents

Information About ROM Monitor and Boothelper Software, page C-1 How to Upgrade or Downgrade Boothelper, page C-2 How to Upgrade or Downgrade ROM Monitor, page C-4 Additional References, page C-10

Information About ROM Monitor and Boothelper Software


Before upgrading or downgrading ROM Monitor or boothelper software, you should understand the following concept:

ROM Monitor and Boothelper Upgrade and Downgrade Basics, page C-1

ROM Monitor and Boothelper Upgrade and Downgrade Basics


The ROM Monitor, which is also known as ROMMON, is a bootstrap program that initializes the hardware and boots the Cisco IOS XR software when you power on or restart a Cisco XR 12000 Series Router. ROM Monitor upgrades can be required to resolve software defects or to support new features. Typically, ROM Monitor upgrades are infrequent and are not required for every Cisco IOS XR software upgrade.

Tip

Information on operating the router in ROM Monitor mode is provided in Appendix A, Router Recovery and Management with ROM Monitor.

Cisco IOS XR Getting Started Guide

C-1

Appendix C How to Upgrade or Downgrade Boothelper

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers

The upgrade and downgrade procedures for ROM Monitor are the same. During the upgrade or downgrade process, you select the firmware that is used for ROM Monitor. This firmware can represent an upgrade or a downgrade. The firmware must be compatible with the hardware, but it need not be a later version of the ROM Monitor already installed. During an upgrade or downgrade, the firmware is copied into hardware EEPROMs in the router. Boothelper software is additional software that extends the capabilities of ROM Monitor on a Cisco XR 12000 Series Router. Without boothelper, ROM Monitor can load images from disk0, disk1, and bootflash. With boothelper, ROM Monitor can load images from disk0, disk1, bootflash, compact flash, and TFTP servers. Boothelper software is stored in bootflash and can be upgraded or downgraded by replacing the software in bootflash with a different boothelper image.

How to Upgrade or Downgrade Boothelper


This section contains the following procedures:

Upgrading or Downgrading Boothelper, page C-2

Upgrading or Downgrading Boothelper


The following procedure upgrades or downgrades the boothelper.

Prerequisites
Before starting the procedure described in the next section, do the following:

Determine if there is a boothelper upgrade file for your version of Cisco IOS XR software. To prepare for a boothelper upgrade, copy the boothelper upgrade file to the router or to a local workstation from which you can copy files to the router. You can also perform the upgrade with a boothelper upgrade file located on a TFTP server.

SUMMARY STEPS
1. 2. 3. 4.

Establish a connection to the active RP. dir bootflash: format bootflash: copy upgradeImage bootflash:

Cisco IOS XR Getting Started Guide

C-2

Appendix C

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers How to Upgrade or Downgrade Boothelper

DETAILED STEPS

Command or Action
Step 1

Purpose Allows you to manage the active RP.

Establish a connection to the active RP.

For more information, see the Connecting and Communicating with the Router section on page 2-2. The boothelper filename shows the file version number. If the correct version is in use, there is no need to upgrade.

Step 2

dir bootflash:

Displays the bootflash contents.

Example:
RP/0/0/CPU0:Router# dir bootflash:

Step 3

format bootflash:

Formats bootflash and erases all contents.

Example:
RP/0/0/CPU0:Router# format bootflash:

Step 4

squeeze bootflash:

Permanently erases the files tagged as "deleted" in the file system.

Example:
RP/0/0/CPU0:Router# squeeze bootflash:

Step 5

copy upgradeImage bootflash:

Copies a file to bootflash.

Example:
RP/0/0/CPU0:Router# copy disk0:c12kprp-boot-mz.120-30.S bootflash:

The file system changes you make to the active RP are replicated on the standby RP.

Example
In the following example, the bootflash is upgraded with a file located on a TFTP server.
RP/0/0/CPU0:router# dir bootflash: Directory of bootflash: 10 381 440 443 444 445 -rwx -rwx -rwx -rwx -rwx -rwx 5192 5177 1389 3047 5177 3223556 Thu Wed Sat Sun Sun Thu Apr Jun Jul Jul Jul Aug 28 1 16 24 24 4 03:37:53 22:12:54 14:20:08 06:19:25 06:30:00 21:55:27 2005 2005 2005 2005 2005 2005 crashinfo5 crashinfo4 snmp/ifindex-table crashinfo crashinfo3 c12kprp-boot-mz.120-29.S

66322432 bytes total (58795492 bytes free)

RP/0/0/CPU0:router# format bootflash: Format operation may take a while. Continue? [confirm] y Format will destroy all data on "bootflash:". Continue? [confirm] y Formatting sector 1 Format of bootflash: complete

Cisco IOS XR Getting Started Guide

C-3

Appendix C How to Upgrade or Downgrade ROM Monitor

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers

RP/0/0/CPU0:router# squeeze bootflash: All deleted files will be removed. Continue? [confirm] y Squeeze operation may take a while. Continue? [confirm] y Squeeze under progress 254 Squeeze of bootflash: complete

RP/0/0/CPU0:router# disk0:c12kprp-boot-mz.120-30.S Destination filename [/bootflash:/c12kprp-boot-mz.120-30.S]? <return> Accessing disk0:c12kprp-boot-mz.120-30.S CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC 3223556 bytes copied in 23 sec ( 138000)bytes/sec

RP/0/0/CPU0:router# dir bootflash: Directory of bootflash: 1 -rwx 3223556 Thu Aug 4 22:09:23 2005 c12kprp-boot-mz.120-30.S

66322432 bytes total (63098748 bytes free) RP/0/0/CPU0:router#

How to Upgrade or Downgrade ROM Monitor


This section contains the following procedures:

Upgrading or Downgrading ROM Monitor, page C-4

Upgrading or Downgrading ROM Monitor


The following procedure upgrades or downgrades the ROM Monitor.

Prerequisites
Before starting the procedure described in the next section, do the following:

Determine if there is an ROM Monitor upgrade file for your version of Cisco IOS XR software. To prepare for a ROM Monitor upgrade, copy the ROM Monitor upgrade file to the router or to a local workstation from which you can copy files to the router. If you want to upgrade ROM Monitor without interrupting traffic through the router, install a standby RP and verify that the standby RP is operating in standby mode.

SUMMARY STEPS
1. 2. 3. 4.

Establish a connection to the active RP. show version copy source destination dir device

Cisco IOS XR Getting Started Guide

C-4

Appendix C

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers How to Upgrade or Downgrade ROM Monitor

5. 6. 7. 8. 9.

admin If you are upgrading a standalone RP, go to Step 15. show redundancy config-register 0x0 redundancy switchover

10. confreg 0x2 11. boot upgradeImage 12. Establish a connection to the active RP (formerly the standby RP). 13. admin 14. show redundancy 15. config-register 0x0 16. redundancy switchover or reload 17. confreg 0x2 18. boot upgradeImage

DETAILED STEPS

Command or Action
Step 1

Purpose Allows you to manage the active RP.

Establish a connection to the active RP.

For more information, see the Connecting and Communicating with the Router section on page 2-2. The ROM Monitor version appears near the top of the show version command display. The line is labeled ROM:. Review the command display to determine which version of ROM Monitor is in use on the RP. If the correct version is in use, there is no need to upgrade. Copy the upgrade file to the root directory of any device on the router. For example, you can copy the file to disk0:.

Step 2

show version

Displays software version information.

Example:
RP/0/0/CPU0:Router# show version

Step 3

copy source destination

Copies the ROM Monitor upgrade file to the router.

Example:
RP/0/0/CPU0:Router# copy tftp:software/filename disk0:

Step 4

dir device

Displays the directory contents for a device root directory.

Verify that the upgrade file appears in the directory.

Example:
RP/0/0/CPU0:Router# dir disk0:

Step 5

admin

Enters admin EXEC mode.

Example:
RP/0/0/CPU0:router# admin

Step 6

If you are upgrading a standalone RP, go to Step 15

Cisco IOS XR Getting Started Guide

C-5

Appendix C How to Upgrade or Downgrade ROM Monitor

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers

Command or Action
Step 7
show redundancy

Purpose Displays the status of the standby RP.

Verify that the standby RP is working properly. If the standby RP is not ready, there is a traffic interruption during the upgrade. This configures the RP to load ROM Monitor when it restarts.

Example:
RP/0/0/CPU0:router(admin)# show redundancy

Step 8

config-register 0x0

Set the configuration register on the active RP to 0x0.

Example:
RP/0/0/CPU0:router(admin)# config-register 0x0

Step 9

redundancy switchover

Reloads the active RP in a dual RP router.

The former standby RP becomes the active RP. The former active RP restarts in ROM Monitor mode due to the configuration register setting defined in Step 8. The redundancy switchover command does not reload the software if the standby RP is not ready to take over.

Example:
RP/0/0/CPU0:Router# redundancy switchover

Note

Step 10

confreg 0x2

Resets the configuration register to enter EXEC mode when the system is reset.

Example:
rommon B1> confreg 0x2

Step 11

boot upgradeImage

Boots the RP with the ROM Monitor upgrade image.

Example:
rommon B2> boot upgradeImage

Step 12

Establish a connection to the active RP (formerly the standby RP).

Allows you to manage the active RP.

For more information, see the Connecting and Communicating with the Router section on page 2-2.

Step 13

admin

Enters admin EXEC mode.

Example:
RP/0/1/CPU0:router# admin

Step 14

show redundancy

Displays the status of the standby RP.

Verify that the standby RP is working properly. If the standby RP is not ready, there is a traffic interruption during the upgrade.

Example:
RP/0/0/CPU0:router(admin)# show redundancy

Step 15

config-register 0x0

Set the configuration register on the active RP to 0x0.

Example:
RP/0/1/CPU0:router(admin)# config-register 0x0

Cisco IOS XR Getting Started Guide

C-6

Appendix C

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers How to Upgrade or Downgrade ROM Monitor

Command or Action
Step 16
redundancy switchover or reload

Purpose Reloads the active RP.

Example:
RP/0/1/CPU0:Router# redundancy switchover or RP/0/1/CPU0:Router# reload

Use the redundancy switchover command in a dual RP router. The former standby RP becomes the active RP, and the former active RP restarts in ROM Monitor mode due to the configuration register setting defined in Step 15. The redundancy switchover command does not reload the software if the standby RP is not ready to take over. Use the reload command in a single RP router. When the reload command is entered on a single RP router, all traffic is interrupted.

Note

Note Step 17
confreg 0x2

Resets the configuration register to enter EXEC mode when the system is reset.

Example:
rommon B1> confreg 0x2

Step 18

boot upgradeImage

Boots the RP with the ROM Monitor upgrade image.

Example:
rommon B2> boot upgradeImage

Example
In the following example, the ROM Monitor software is upgraded on a single RP:
RP/0/0/CPU0:router#show version | include ROM ROM: System Bootstrap, Version 12.0(20040624:164256) [assafb-misc1 1.14dev(0.91) ] SOFTWARE

RP/0/0/CPU0:router#copy tftp://192.168.1.1/users/bfprp_romupgrade-1.14.0.91 disk0: Destination filename [/disk0:/bfprp_romupgrade-1.14.0.91]? Copy : Destination exists, overwrite ?[confirm] Accessing tftp://192.168.1.1/users/bfprp_romupgrade-1.14.0.91 CCCCCCCCCCC 170268 bytes copied in 0 sec

Cisco IOS XR Getting Started Guide

C-7

Appendix C How to Upgrade or Downgrade ROM Monitor

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers

RP/0/0/CPU0:router#dir disk0: Directory of disk0: 2 3 37 4040 4042 19570 20991 22567 25548 29 28460 28468 28469 66592 28494 66784 66880 91 drwx drwx drwx drwx drwx drwx drwx drwx drwx drwx dr-x drwx drwx -rwx drwx -rwx -rwx 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 4096 2765 4096 126 170268 Sun Sun Sun Sun Sun Sun Sun Sun Sun Sun Sun Sun Sun Sun Sun Sun Thu Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Jul Aug 31 31 31 31 31 31 31 31 31 31 31 31 31 31 31 31 4 02:25:48 02:25:52 02:27:48 02:47:44 02:31:14 02:31:32 02:31:58 02:32:30 02:32:54 02:38:49 02:40:03 02:36:53 02:36:53 02:45:50 02:45:39 02:45:50 22:21:21 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 2005 LOST.DIR config c12k-os-mbi-3.3.80 instdb c12k-base-3.3.80 c12k-admin-3.3.80 c12k-fwdg-3.3.80 c12k-lc-3.3.80 c12k-rout-3.3.80 shutdown aaa usr var sam_certdb c12k-infra-test-3.3.80 sam_crldb bfprp_romupgrade-1.14.0.

256462848 bytes total (113434624 bytes free) RP/0/0/CPU0:router#

RP/0/0/CPU0:router(admin)#config-register 0x0 Successfully set config-register to 0x0 on node 0/0/CPU0 RP/0/0/CPU0:router(admin)#exit RP/0/0/CPU0:router#reload Updating Commit Database. Please wait...[OK] Proceed with reload? [confirm] y

System Bootstrap, Version 12.0(20040624:164256) [assafb-misc1 1.14dev(0.91)] DEV ELOPMENT SOFTWARE Copyright (c) 1994-2004 by cisco Systems, Inc. DRAM DIMM Slot 1: 512M found, Slot 2: Empty MPC7450 platform with 524288 Kbytes of main memory

rommon 2 > confreg 0x2 rommon 3 > boot disk0:bfprp_romupgrade-1.14.0.91

GRP Boot ROM Programming6322432 bytes total (620 Verify the device manufacturing code RP/0/0/CPU0:i mft = 0x1, dev = 0x4F tftp://192.168.1.1 Erasing Flashot-users$ Sector address = fff00000 Erasing the Flash... % Incomplete com Sector address = fff10000 RP/0/0/CPU0:iox1-sharedErasing the Flash...192.168.1.1/auto/t Sector address = fff20000 Erasing the Flash... Sector address = fff30000ootflash:/c12kprp-boot-mz

Cisco IOS XR Getting Started Guide

C-8

Appendix C

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers How to Upgrade or Downgrade ROM Monitor

Erasing the Flash... Sector address = fff40000 Copy : Destination e Erasing the Flash...nfirm] Sector address = fff50000 Accessing tftp:// Erasing the Flash...tftpboot-users/ Sector address = fff60000 Erasing the Flash... Sector address = fff70000 Erasing the Flash... Verifying FlashCCCCCCCCCCCCCCC Verify Boot Sector Complete! All Programming Complete! CCCCCC Verify Boot Sector Complete! All Programming Complete! CCCCCC

System Bootstrap, Version 12.0(20040624:164256) [assafb-misc1 1.14dev(0.91)] DEV copied in 22 sec ( 144018)bytes/sec ELOPMENT SOFTWARERP/0/0/CPU0:iox1Copyright (c) 1994-2004 by cisco Systems, Inc. Directory of bootfl

DRAM DIMM Slot 1: 512M found, Slot 2: Empty Thu Apr 28 03:37:53 2005 MPC7450 platform with 524288 Kbytes of main memory 381 -rwx 5177 Wed Jun 1 22:12: J##################################################################### 440 -rwx 1389 Sat Jul 16 14:20:08 2005 snmp/ifindex-tab System page at phys:00023000 user:00 445 -rwx 322 subject to restrictions as set forth in subparagraph0-30.S (c) of the Commercial Computer Software - Restricted795492 bytes free) Rights clause at FAR sec. 52.227-19 and subparagraphash: (c) (1) (ii) of the Rights in Technical Data and Computer Form Software clause at DFARS sec. 252.227-7013.ntinue? [confirm] cisco Systems, Inc. Formatting sector 1 170 West Tasman Drivelash: complete San Jose, California 95134-1706

crashinfo

Cisco IOS-XR c12000 Fabric Clock is Redundant Bandwidth Mode : Full Bandwidth RP/0/0/CPU0:Aug 4 22:32:21.241 : mbi-hello[61]: %PLATFORM-MBI_HELLO-6-INFO_CREACCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC TE_SUCCESS : MBI-H: Success to create /dev/mbi_lwm. Attempt number 1CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC RP/0/0/CPU0:Aug 4 22:32:50.333 : redcon[419]: %HA-REDCON-6-GO_ACTIVE : this carCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC 3223556 byte d going active 22 sec ( 14 RP/0/0/CPU0:Aug 4 22:32:55.330 : dsc[153]: %PLATFORM-DSCMEDIA-6-DSC_ELECTED : T:router#dir bootflash:

Cisco IOS XR Getting Started Guide

C-9

Appendix C Additional References

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers

his node is now dSC (master of chassis) 1 -rwx 3223556 Thu Aug Squeeze under progress _LOG : /pkg/bin/sysmgr_debug_script invoked for: (wdsysmon) process did not sign RP/0/0/CPU0:Aug 4 22:35:05.690 : config_lr[133]: %MGBL-CFGLAUNCH-6-STARTUP_INFO CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC RP/0/0/CPU0:Aug 4 22:35:06.062 : cfgmgr-rp[127]: %MGBL-CFGMGR-6-CONFIG_COMPLETE : Configuration for node '0/0/CPU0' has been restored. RP/0/0/CPU0:Aug 4 22:35:06.094 : ifmgr[178]: %PKT_INFRA-LINK-3-UPDOWN : Interfa ce MgmtEth0/0/CPU0/0, changed state to Down RP/0/0/CPU0:Aug 4 22:35:06.130 : ifmgr[178]: %PKT_INFRA-LINK-3-UPDOWN : Interfa ce MgmtEth0/0/CPU0/0, changed state to Up

router con0/0/CPU0 is now available

Press RETURN to get started.

Username: user Password: secret RP/0/0/CPU0:router#

Additional References
Related Documents
Related Topic Hardware component commands System management commands Document Title Cisco IOS XR Interface and Hardware Component Command Reference Cisco IOS XR System Management Command Reference

Technical Assistance
Description Link http://www.cisco.com/techsupport The Cisco Technical Support website contains thousands of pages of searchable technical content, including links to products, technologies, solutions, technical tips, and tools. Registered Cisco.com users can log in from this page to access even more content.

Cisco IOS XR Getting Started Guide

C-10

Appendix C

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers Additional References

Cisco IOS XR Getting Started Guide

C-11

Appendix C Additional References

Upgrading and Downgrading Boothelper and ROM Monitor on Cisco XR 12000 Series Routers

Cisco IOS XR Getting Started Guide

C-12

A P P E N D I X

Understanding Regular Expressions, Special Characters, and Patterns


This appendix describes the regular expressions, special or wildcard characters, and patterns that can be used with filters to search through command output. The filter commands are described in the Filtering show Command Output section on page 4-9. The following sections describe features you can use with filters:

Regular Expressions, page D-1 Special Characters, page D-2 Character Pattern Ranges, page D-2 Multiple-Character Patterns, page D-3 Complex Regular Expressions Using Multipliers, page D-3 Pattern Alternation, page D-4 Anchor Characters, page D-4 Underscore Wildcard, page D-4 Parentheses Used for Pattern Recall, page D-4

Regular Expressions
A regular expression is a pattern (a phrase, number, or more complex pattern):

Regular expressions are case sensitive and allow for complex matching requirements. Simple regular expressions include entries like Serial, misses, or 138. Complex regular expressions include entries like 00210... , ( is ), or [Oo]utput.

A regular expression can be a single-character pattern or multiple-character pattern. That is, a regular expression can be a single character that matches the same single character in the command output or multiple characters that match the same multiple characters in the command output. The pattern in the command output is referred to as a string. The simplest regular expression is a single character that matches the same single character in the command output. Letter (AZ and az), digits (09), and other keyboard characters (such as ! or ~) can be used as a single-character pattern.

Cisco IOS XR Getting Started Guide

D-1

Appendix D Special Characters

Understanding Regular Expressions, Special Characters, and Patterns

Special Characters
Certain keyboard characters have special meaning when used in regular expressions. Table D-1 lists the keyboard characters that have special meaning.
Table D-1 Characters with Special Meaning

Character . * + ? ^ $ _ (underscore)

Special Meaning Matches any single character, including white space. Matches 0 or more sequences of the pattern. Matches 1 or more sequences of the pattern. Matches 0 or 1 occurrences of the pattern. Matches the beginning of the string. Matches the end of the string. Matches a comma (,), left brace ({), right brace (}), left parenthesis ( ( ), right parenthesis ( ) ), the beginning of the string, the end of the string, or a space.

To use these special characters as single-character patterns, remove the special meaning by preceding each character with a backslash (\). In the following examples, single-character patterns matching a dollar sign, an underscore, and a plus sign, respectively, are shown. \$ \_ \+

Character Pattern Ranges


A range of single-character patterns can be used to match command output. To specify a range of single-character patterns, enclose the single-character patterns in square brackets ([ ]). Only one of these characters must exist in the string for pattern-matching to succeed. For example, [aeiou] matches any one of the five vowels of the lowercase alphabet, while [abcdABCD] matches any one of the first four letters of the lowercase or uppercase alphabet. You can simplify a range of characters by entering only the endpoints of the range separated by a dash (), as in the following example: [adAD] To add a dash as a single-character pattern in the search range, include another dash and precede it with a backslash: [adAD\] A bracket (]) can also be included as a single-character pattern in the range: [adAD\\]] Invert the matching of the range by including a caret (^) at the start of the range. The following example matches any letter except the ones listed: [^adqsv] The following example matches anything except a right square bracket (]) or the letter d: [^\]d]

Cisco IOS XR Getting Started Guide

D-2

Appendix D

Understanding Regular Expressions, Special Characters, and Patterns Multiple-Character Patterns

Multiple-Character Patterns
Multiple-character regular expressions can be formed by joining letters, digits, and keyboard characters that do not have a special meaning. With multiple-character patterns, order is important. The regular expression a4% matches the character a followed by a 4 followed by a %. If the string does not have a4%, in that order, pattern matching fails. The multiple-character regular expression a. uses the special meaning of the period character to match the letter a followed by any single character. With this example, the strings ab, a!, and a2 are all valid matches for the regular expression. Put a backslash before the keyboard characters that have special meaning to indicate that the character should be interpreted literally. Remove the special meaning of the period character by putting a backslash in front of it. For example, when the expression a\. is used in the command syntax, only the string a. is matched. A multiple-character regular expression containing all letters, all digits, all keyboard characters, or a combination of letters, digits, and other keyboard characters is a valid regular expression. For example: telebit 3107 v32bis.

Complex Regular Expressions Using Multipliers


Multipliers can be used to create more complex regular expressions that instruct Cisco IOS XR software to match multiple occurrences of a specified regular expression. Table D-2 lists the special characters that specify multiples of a regular expression.
Table D-2 Special Characters Used as Multipliers

Character * + ?

Description Matches 0 or more single-character or multiple-character patterns. Matches 1 or more single-character or multiple-character patterns. Matches 0 or 1 occurrences of a single-character or multiple-character pattern.

The following example matches any number of occurrences of the letter a, including none: a* The following pattern requires that at least one occurrence of the letter a in the string be matched: a+ The following pattern matches the string bb or bab: ba?b The following string matches any number of asterisks (*): \** To use multipliers with multiple-character patterns, enclose the pattern in parentheses. In the following example, the pattern matches any number of the multiple-character string ab: (ab)* As a more complex example, the following pattern matches one or more instances of alphanumeric pairs: ([A-Za-z][0-9])+

Cisco IOS XR Getting Started Guide

D-3

Appendix D Pattern Alternation

Understanding Regular Expressions, Special Characters, and Patterns

The order for matches using multipliers (*, +, and ?) is to put the longest construct first. Nested constructs are matched from outside to inside. Concatenated constructs are matched beginning at the left side of the construct. Thus, the regular expression matches A9b3, but not 9Ab3 because the letters are specified before the numbers.

Pattern Alternation
Alternation can be used to specify alternative patterns to match against a string. Separate the alternative patterns with a vertical bar (|). Only one of the alternatives can match the string. For example, the regular expression codex|telebit matches the string codex or the string telebit, but not both codex and telebit.

Anchor Characters
Anchoring can be used to match a regular expression pattern against the beginning or end of the string. Regular expressions can be anchored to a portion of the string using the special characters shown in Table D-3.
Table D-3 Special Characters Used for Anchoring

Character ^ $

Description Matches the beginning of the string. Matches the end of the string.

For example, the regular expression ^con matches any string that starts with con, and $sole matches any string that ends with sole. In addition to indicating the beginning of a string, the ^ can be used to indicate the logical function not when used in a bracketed range. For example, the expression [^abcd] indicates a range that matches any single letter, as long as it is not the letters a, b, c, and d.

Underscore Wildcard
Use the underscore to match the beginning of a string (^), the end of a string ($), parentheses (( )) , space ( ), braces ({}), comma (,), and underscore (_). The underscore can be used to specify that a pattern exists anywhere in the string. For example, _1300_ matches any string that has 1300 somewhere in the string and is preceded by or followed by a space, brace, comma, or underscore. Although _1300_ matches the regular expression {1300_, it does not match the regular expressions 21300 and 13000t. The underscore can replace long regular expression lists. For example, instead of specifying ^1300( ) ( )1300$ {1300, ,1300, {1300} ,1300, (1300, simply specify _1300_.

Parentheses Used for Pattern Recall


Use parentheses with multiple-character regular expressions to multiply the occurrence of a pattern. The Cisco IOS XR software can remember a pattern for use elsewhere in the regular expression.

Cisco IOS XR Getting Started Guide

D-4

Appendix D

Understanding Regular Expressions, Special Characters, and Patterns Parentheses Used for Pattern Recall

To create a regular expression that recalls a previous pattern, use parentheses to indicate memory of a specific pattern and a backslash (\) followed by a digit to reuse the remembered pattern. The digit specifies the occurrence of a parenthesis in the regular expression pattern. When there is more than one remembered pattern in the regular expression, \1 indicates the first remembered pattern, \2 indicates the second remembered pattern, and so on. The following regular expression uses parentheses for recall: a(.)bc(.)\1\2 This regular expression matches an a followed by any character (call it character number 1), followed by bc followed by any character (character number 2), followed by character number 1 again, followed by character number 2 again. So, the regular expression can match aZbcTZT. The software remembers that character number 1 is Z and character number 2 is T, and then uses Z and T again later in the regular expression.

Cisco IOS XR Getting Started Guide

D-5

Appendix D Parentheses Used for Pattern Recall

Understanding Regular Expressions, Special Characters, and Patterns

Cisco IOS XR Getting Started Guide

D-6

GLOSSARY

A
AAA

authentication, authorization, and accounting. A network security service that provides the primary framework to set up access control on a Cisco CRS-1 or access server. AAA is an architectural framework and modular means of configuring three independent but closely related security functions in a consistent manner. access control list. A list kept by routers to control access to or from the router for a number of services (for example, to prevent packets with a certain IP address from leaving a particular interface on the router). Denotes a card or process that performs a system task; in a redundant configuration, there is an inactive standby card or process available to become active. Active cards or processes are also sometimes denoted as primary. The RP that is active in a redundant pair of RPs. The software configuration marked as active for a node. The set of Cisco IOS XR software packages activated in one or more nodes in a router. A well-defined rule or process for arriving at a solution to a problem. In networking, algorithms commonly are used to determine the best route for traffic from a particular source to a particular destination. automatic protection switching. A method that allows transmission equipment to recover automatically from failures, such as a cut cable. application-specific integrated circuit. A chip designed for use in a specific hardware device. An ASIC is a chip designed for a special application, such as a particular kind of transmission protocol.

ACL

active

active RP active software configuration active software set algorithm

APS

ASIC

B
bandwidth

The amount of data that can be sent in a fixed amount of time. For digital devices, the bandwidth is usually expressed in bits per second (Bps) or bytes per second. Border Gateway Protocol. A routing protocol used between autonomous systems. It is the routing protocol that makes the internet work. BGP is a distance-vector routing protocol that carries connectivity information and an additional set of BGP attributes. These attributes allow for a rich set of policies for deciding the best route to use to reach a given destination.

BGP

Cisco IOS XR Getting Started Guide

GL-1

Glossary

C
card type CDP

The type of the card inserted in a slot. Cisco Discovery Protocol. CDP runs on all Cisco devices so that these devices can learn about neighboring devices and exchange information. CDP uses a well-known multicast MAC address. During system initialization, the application-specific integrated circuit (ASIC) is configured to forward these packets to the Cisco IOS XR software CPU, which processes the packets. The Cisco website command-line interface. A text-based user interface to an operating system. A command-line interface is a user interface to a computer operating system or an application in which the user responds to a visual prompt by typing a command on a specified line, receives a response from the system, and then enters another command, and so forth. Typically, most of the UNIX-based systems today offer both a command-line interface and graphical user interface (GUI). See also GUI. The configuration stored in the system for a particular node. The RP loads the committed configuration into memory at startup. In Cisco routers, a 16-bit, user-configurable value that determines how the router functions during initialization. The configuration register can be stored in hardware or software. In hardware, the bit position is set using a jumper. In software, the bit position is set by specifying a hexadecimal value using configuration commands. A hexadecimal or decimal value that represents the 16-bit configuration register value that you want to use the next time the router is restarted. The value range is from 0x0 to 0xFFFF (0 to 65535 in decimal). The control plane oversees the operation of the data plane, allocating resources, providing information, and handling errors to allow data plane operations to be continuous and efficient. Common Object Request Broker Architecture. Specification that provides the standard interface definition between OMG-compliant objects. CORBA allows applications to communicate with one another no matter where they are located or who has designed them. class of service. An indication of how an upper-layer protocol requires a lower-layer protocol to treat its messages. In SNA subarea routing, CoS definitions are used by subarea nodes to determine the optimal route to establish a given session. A CoS definition comprises a virtual route number and transmission priority field. Repetitive, regularly timed signals are used to control synchronous processes. Craft Works Interface. Graphical user interface (GUI) used to configure and operate a router. The CWI client runs in a web browser.

Cisco.com CLI

committed/saved software configuration configuration register

control plane

CORBA

CoS

CWI

D
DDTS DHCP

distributed defect tracking system. A method to track software errors and resolutions. Dynamic Host Configuration Protocol. Provides a mechanism for allocating IP addresses dynamically so that addresses can be reused when hosts no longer need them.

Cisco IOS XR Getting Started Guide

GL-2

Glossary

DIMM

dual in-line memory module. Small circuit boards carrying memory integrated circuits, with signal and power pins on both sides of the board, in contrast to single-in-line memory modules (SIMMs). Domain Name System. Mechanism used in the Internet and on private intranets for translating names of host computers into addresses. The DNS also allows host computers not directly on the Internet to have a registered name in the same style. Dynamic Packet Transport. DPT rings are dual, counter-rotating fiber rings. Both fibers are used concurrently to transport both data and control traffic. designated shelf controller. The RP or RP pair that controls a router or a line card chassis. The DSC is selected from among the route processors (RPs) installed in the router or line card chassis.

DNS

DPT

DSC

E
eBGP

external Border Gateway Protocol. BGP sessions are established between routers in different autonomous systems. eBGPs communicate among different network domains. error correction code. ECC is used to correct errors within memories on the Cisco CRS-1. Outgoing channel. Baseband LAN specification invented by Xerox Corporation and developed jointly by Xerox, Intel, and Digital Equipment Corporation. Ethernet networks use CSMA/CD and run over a variety of cable types at 10 Mbps. Ethernet standards are defined by the IEEE 802.3 specification.

ECC egress Ethernet

F
fabric FC

Connectivity between all line cards. Also referred to as switch fabric. fan controller. Two fan controller cards are installed in every line card chassis as a redundant pair to manage the fan assemblies; a BITS timing connector exists on the fan controller card. Forwarding Information Base. Database that stores information about switching of data packets. A FIB is based on information in the Routing Information Base (RIB). It is the optimal set of selected routes that are installed in the line cards for forwarding. See also RIB. Traffic-passing technique used by switches and bridges in which traffic received on an interface is sent out all the interfaces of that device except the interface on which the information was originally received. Process of sending a frame toward its ultimate destination by way of an internetworking device. fast reroute. Automatically reroutes traffic on a label switch path (LSP) if a node or link in an LSP fails. FRR reduces the loss of packets traveling over an LSP. File Transfer Protocol. Application protocol, part of the TCP/IP protocol stack, used for transferring files between network nodes. FTP is defined in RFC 959.

FIB

flooding

forwarding FRR

FTP

Cisco IOS XR Getting Started Guide

GL-3

Glossary

G
GE

Gigabit Ethernet. Standard for a high-speed Ethernet, approved by the IEEE 802.3z standards committee in 1996. The Ethernet speed for the Cisco CRS-1 control bus running between all chassis. graphical user interface. A user environment that uses pictorial and textual representations of the input and output of applications and the hierarchical or other data structure in which information is stored. Such conventions as buttons, icons, and windows are typical, and many actions are performed using a pointing device (such as a mouse). Microsoft Windows and the Apple Macintosh are prominent examples of platforms using a GUI. See also CLI.

Gigabit Ethernet GUI

H
HA

High availability is defined as the continuous operation of systems. For a system to be available, all components, including application and database servers, storage devices, and the end-to-end network, need to provide continuous service. high-level data link control. ISO communications protocol used in X.25 packet-switching networks. HDLC provides error correction at the data link layer and contains the following subsets: LAPB and SDLC. A number system having 16 as its base. This number representation uses the digits 09, with their usual meaning, plus the letters AF (or af) to represent hexadecimal digits with values of (decimal) 10 to 15. The far right digit counts ones, the next counts multiples of 16, then 16^2 = 256, and so on. Hexadecimal is more succinct than binary for representing bit masks, machines addresses, and other low-level constants but it is still reasonably easy to split a hex number into different bit positions. For example, the top 16 bits of a 32-bit word are the first four hex digits.

HDLC

hexadecimal

hop

Passage of a data packet between two network nodes (for example, between two routers). See also hop count. Routing metric used to measure the distance between a source and a destination. Hypertext Transfer Protocol. Used by web browsers and web servers to transfer files, such as text and graphic files. HTTP is the set of rules for exchanging files (text, graphic images, sound, video, and other multimedia files) on the World Wide Web. Relative to the TCP/IP suite of protocols (which are the basis for information exchange on the Internet), HTTP is an application protocol.

hop count HTTP

I
ICMP

Internet Control Message Protocol. Network layer Internet (TCP/IP) protocol that reports errors and provides other information relevant to IP packet processing. IP explicit path. List of IP addresses, each representing a node or link in the explicit path.

IEP

Cisco IOS XR Getting Started Guide

GL-4

Glossary

IETF

Internet Engineering Task Force. Task force consisting of over 80 working groups responsible for developing Internet standards. The IETF operates under the auspices of ISOC. Internet Group Management Protocol. Governs the management of multicast groups in a TCP/IP network. Used by IP hosts to report their multicast group memberships to an adjacent multicast router. Interior Gateway Protocol. Internet protocol used to exchange routing information within an autonomous system. Examples of common Internet IGPs include IGRP, OSPF, and RIP. See also OSPF and RIP. Incoming channel. The set of Cisco IOS XR software packages installed on a router. The Cisco operating system used on the Cisco CRS-1 and Cisco XR 12000 Series Router. Internet Protocol. Network layer protocol in the TCP/IP stack offering a connectionless internetwork service. IP provides features for addressing, type-of-service specification, fragmentation and reassembly, and security. IP Version 4. Network layer for the TCP/IP protocol suite. A connectionless, best-effort packet switching protocol. IP Version 6. Replacement for IPv4. A next-generation IP protocol. IPv6 is backward compatible with and designed to fix the shortcomings of IPv4, such as data security and maximum number of user addresses. IPv6 increases the address space from 32 to 128 bits, providing for an unlimited number of networks and systems. It also supports quality of service (QoS) parameters for real-time audio and video. Internetwork Packet Exchange. NetWare network layer (Layer 3) protocol used for transferring data from servers to workstations. IPX is similar to IP and XNS. Intermediate System-to-Intermediate System. OSI link-state hierarchical routing protocol based on DECnet Phase V routing, whereby ISs (routers) exchange routing information based on a single metric to determine network topology.

IGMP

IGP

ingress installed software set IOS XR IP

IPv4

IPv6

IPX

IS-IS

Cisco IOS XR Getting Started Guide

GL-5

Glossary

K
keepalive interval keepalive message

Period of time between each keepalive message sent by a network device. Message sent by one network device to inform another network device that the virtual circuit between the two is still active.

L
Layer 2

Layer 2 refers to the data link layer of the commonly referenced multilayered communication model, Open Systems Interconnection (OSI). The data link layer contains the address inspected by a bridge or switch. Layer 2 processing is faster than layer 3 processing, because less analysis of the packet is required. Layer 3 refers to the network layer of the commonly referenced multilayered communication model, Open Systems Interconnection (OSI). The network layer is concerned with knowing the address of the neighboring nodes in the network, selecting routes and quality of service, and recognizing and forwarding to the transport layer incoming messages for local host domains. A router is a Layer 3 device, although some newer switches also perform Layer 3 functions. The Internet Protocol (IP) address is a Layer 3 address.

Layer 3

LC LDP

line card. Line cards in the Cisco CRS-1 system are referred to as modular services cards (MSCs). label distribution protocol. A standard protocol between MPLS-enabled routers to negotiate the labels (addresses) used to forward packets. The Cisco proprietary version of this protocol is the Tag Distribution Protocol (TDP). Label Information Base. The table that contains the labels in use on the node. Send the outgoing signals back to the receiving side for testing. logical router. A collection of line cards and route processors that form a complete router. Each router contains its own instance of dynamic routing, IP stack, system database, interface manager, and event notification system.

LIB loopback LR

M
MAC address

Standardized data link layer address that is required for every port or device that connects to a LAN. Other devices in the network use these addresses to locate specific ports in the network and to create and update routing tables and data structures. MAC addresses are 6 bytes long and are controlled by the IEEE. Also known as a hardware address, MAC layer address, and physical address. Pattern of bits used to reject or accept bit patterns in another set of data. minimum boot image. Software image containing a kernel and minimum set of drivers and components to boot a node.

mask MBI

Cisco IOS XR Getting Started Guide

GL-6

Glossary

Mbps

megabits per second. A bit rate expressed in millions of binary bits per second. 1 megabit = 220 bits, or 1,048,576 bits. Management Information Base. Database of network management information that is used and maintained by a network management protocol like Simple Network Management Protocol (SNMP). The value of an MIB object can be changed or retrieved using SNMP commands, usually through a GUI network management system. MIB objects are organized in a tree structure that includes public (standard) and private (proprietary) branches. Multiprotocol Label Switching. Switching method that forwards IP traffic using a label. This label instructs the routers and switches in the network where to forward the packets based on pre-established IP routing information Multiprotocol Label Switching traffic engineering. A switching method that forwards IP traffic using a label. This label instructs the routers and switches in the network where to forward the packets based on pre-established IP routing information. modular services card. Module in which the ingress and egress packet processing and queueing functions are carried out in the Cisco CRS-1 architecture. Up to 16 MSCs are installed in a line card chassis; each MSC must have an associated physical line interface module (PLIM) (of which there are several types to provide a variety of physical interfaces). The MSC and PLIM mate together on the line card chassis midplane. See also PLIM. MSCs are also referred to as line cards.

MIB

MPLS

MPLS TE

MSC

MTU multicast

maximum transmission unit. Maximum packet size, in bytes, that a particular interface can handle. Multicast is a feature that refers to single packets copied by the network and sent to a specific subset of network addresses. These addresses are specified in the Destination Address Field. See also unicast.

N
netboot node NSF

Loading software images from a network server, such as TFTP. A card installed and running on the router. nonstop forwarding. Packets keep flowing during events such as failover, process restarts, and the upgrade or downgrade of software packages. Nonstop forwarding is the ability of a router to continue to forward traffic toward a router that may be recovering from a transient failure and the ability of a router recovering from a transient failure in the control plane to continue correctly forwarding traffic sent to it by a peer. Network Time Protocol. Protocol built on top of TCP that ensures accurate local time-keeping with reference to radio and atomic clocks located on the Internet. This protocol is capable of synchronizing distributed clocks within milliseconds over long time periods. nonvolatile RAM. Static random access memory that is made into nonvolatile storage by having a battery permanently connected.

NTP

NVRAM

Cisco IOS XR Getting Started Guide

GL-7

Glossary

O
OC-x OIR

Optical carrier, where x=3, 12, 48, or 192, relating to the various speeds within a SONET network. online insertion and removal. Feature that permits the addition, replacement, or removal of cards without interrupting the system power, entering console commands, or causing other software or interfaces to shut down. Sometimes called hot-swapping or power-on servicing. Open Systems Interconnection. International standardization program created by ISO and ITU-T to develop standards for data networking that facilitate multivendor equipment interoperability. Open Shortest Path First. Link-state, hierarchical Interior Gateway Protocol (IGP) routing algorithm proposed as a successor to Routing Information Protocol (RIP) in the Internet community. OSPF features include least-cost routing, multipath routing, and load balancing. OSPF was derived from an early version of the Intermediate System-to-Intermediate System (IS-IS) protocol. See also IGP and RIP.

OSI

OSPF

P
package packet

A group of software components installed on the router. Logical grouping of information that includes a header containing control information and (usually) user data. Packets most often are used to refer to network layer units of data. frames.

Packet-over-SONET PoS. Packet-over-SONET enables core routers to send native IP packets directly over SONET or SDH

PAP

Password Authentication Protocol. Authentication protocol that allows PPP peers to authenticate one another. The remote router attempting to connect to the local router is required to send an authentication request. Unlike Challenge Handshake Authentication Protocol (CHAP), PAP passes the password and the hostname or username in the clear (unencrypted). PAP does not itself prevent unauthorized access but merely identifies the remote end. The router or access server then determines whether that user is allowed access. PAP is supported only on PPP lines. See also PPP. Personal Computer Memory Card International Association. Standard for credit card-size memory or I/O device. package installation envelope. An installable software file with the suffix .pie. A PIE may be a package or a Software Maintenance Upgrade (SMU). A PIE is used to deliver Cisco IOS XR software. A PIE may contain a single component, group of components (called a package), or set of packages. When a PIE contains more than one component, it is called a Composite PIE. Physical layer interface module. Provides the physical interface for a line card. Also handles media-specific functions, such as framing, clock recovery, channelization, and optical signaling for line interfaces connecting to a Cisco CRS-1. performance monitoring. Provides a variety of automatic functions to aid in the maintenance and operation of the network. PM is continuous, in-service monitoring of transmission quality that uses software-provisionable performance parameters. Performance parameters are measured for all four layers of the SONET signal: physical, section, line, and STS path.

PCMCIA

PIE

PLIM

PM

Cisco IOS XR Getting Started Guide

GL-8

Glossary

PoS

Packet-over-SONET. Packet-over-SONET enables core routers to send native IP packets directly over Synchronous Optical Network (SONET) or Synchronous Digital Hierarchy (SDH) frames. Point-to-Point Protocol. Successor to SLIP that provides router-to-router and host-to-network connections over synchronous and asynchronous circuits. Whereas SLIP was designed to work with IP, PPP was designed to work with several network layer protocols, such as IP, IPX, and ARA. PPP also has built-in security mechanisms, such as CHAP and PAP. PPP relies on two protocols: LCP and NCP. The first route processor configured for DSC or logical router operation. If a second RP is configured as a redundant RP, it becomes the secondary RP.

PPP

primary RP

Q
QoS

quality of service. A set of parameters that describes a flow of data, such as guaranteed bandwidth, delay, and delivery guarantee.

R
RCP

remote copy protocol. A protocol that allows users to copy files to and from a file system residing on a remote host or server on the network. The RCP protocol uses TCP to ensure the reliable delivery of data. Routing Information Base. This is the set of all available routes from which to choose the FIB. The RIB essentially contains all routes available for selection. Essentially, it is the sum of all routes learned by dynamic routing protocols, all directly attached networks (that is. networks to which a given router has interfaces connected), and any additional configured routes, such as static routes. Routing Information Protocol. A simple routing protocol that is part of the TCP/IP protocol suite and the most common IGP in the Internet. RIP determines a route based on the smallest hop count between source and destination. It is a distance vector protocol that broadcasts routing information to neighboring routers. It is known to use excessive bandwidth. See also hop count and IGP. ROM monitor program. ROMMON is executed from ROM and is a single-threaded program that initializes a board and loads a higher-level operating system. ROMMON is for debugging or to manually boot the system. Network layer device that uses one or more routing metrics to determine the optimal path along which network traffic should be forwarded. Routers forward packets from one network to another based on network layer information. Process of finding a path to a destination host. Routing is very complex in large networks because of the many potential intermediate destinations a packet might traverse before reaching its destination host. A routing algorithm determines that one route is better than another. This information is stored in routing tables. Metrics include bandwidth, communication cost, delay, hop count, load, MTU, path cost, and reliability. Sometimes referred to simply as a metric. See also algorithm. Protocol that accomplishes routing through the implementation of a specific routing algorithm. Examples of routing protocols include BGP, OSPF, and IS-IS.
Cisco IOS XR Getting Started Guide

RIB

RIP

ROMMON

router

routing

routing metric

routing protocol

GL-9

Glossary

routing table

Table stored in a router or some other internetworking device that keeps track of routes to particular network destinations and, in some cases, metrics associated with those routes. route processor. Cards that contain run-control software on the router. Two RPs are installed as a redundant pair in dedicated slots in the front of each line card chassis. Reverse Path Forwarding. Multicasting technique in which a multicast datagram is forwarded from all but the receiving interface if the receiving interface is the one used to forward unicast datagrams to the source of the multicast datagram. Resource Reservation Protocol. Protocol that supports the reservation of resources across an IP network. Applications running on IP end systems can use RSVP to indicate to other nodes the nature (bandwidth, jitter, maximum burst, and so on) of the packet streams they want to receive. RSVP depends on IPv6. Also known as Resource Reservation Setup Protocol. See also IPv6. The router configuration currently in effect. Although the user can save multiple versions of the router configuration for future reference, only one copy of the running configuration exists in the router at any given time. The receiver end of a fabric link. All links are unidirectional. See also Tx.

RP

RPF

RSVP

running configuration

Rx

S
SCFC

shelf controller/fan controller. Combines shelf controller function and fan controller function on one card. Two are installed in each fabric chassis. Synchronous Digital Hierarchy. European standard that defines a set of rate and format standards that are sent using optical signals over fiber. SDH is similar to SONET, with a basic SDH rate of 155.52 Mbps, designated at STM-1. synchronous dynamic random access memory. A form of dynamic RAM that adds a separate clock signal to the control signals. The hardware component that manages the configuration and health of a fabric chassis within the Cisco CRS-1. The shelf manager process runs on a router or switch, doing platform-dependent functions, including handling OIR events. Shelf manager is formerly called platform manager. Software Maintenance Upgrade. A point fix for a critical problem. SMUs are delivered as PIE files and are used to update software packages. Simple Network Management Protocol. SNMP is the protocol governing network management and the monitoring of network devices and their functions. It is not necessarily limited to TCP/IP networks. Simple Network Management Protocol Version 3. An interoperable standards-based protocol for network management. SNMPv3 provides secure access to devices by a combination of authenticating and encrypting packets over the network. A list of packages activated for a particular node. A software configuration consists of a boot package and additional feature packages.

SDH

SDRAM

shelf controller

shelf manager

SMU

SNMP

SNMPv3

software configuration

Cisco IOS XR Getting Started Guide

GL-10

Glossary

SONET

Synchronous Optical Network. A standard format for transporting a wide range of digital telecommunications services over optical fiber. SONET is characterized by standard line rates, optical interfaces, and signal formats. See also SDH. service processor. An SP on each card maintains an internal management connection to the shelf controller for the rack. The SP is referred to in CLI commands to identify the nodeID for fabric, alarm and fan controller cards. Example:
RP/0/RPO/CPU:router# admin show controllers fabric connectivity location 0/SM0/SP

SP

SPE

Synchronous Payload Envelope. Portion of the SONET frame containing overhead information (POH and user data). shortest path first. Routing algorithm that iterates on length of path to determine a shortest-path spanning tree. Commonly used in link-state routing algorithms. Sometimes called Dijkstra's algorithm. Secure Shell. A protocol that provides a secure remote connection to a router through a Transmission Control Protocol (TCP) application. secure socket layer. A secure socket between two entities with authentication. Denotes an inactive card or process that waits to become active; standby cards or processes are also sometimes denoted as backup. The router configuration designated to be applied on the next router startup.

SPF

SSH

SSL standby

startup configuration subinterface

Virtual interfaces created on a hardware interface. These software-defined interfaces allow for segregation of traffic into separate logical channels on a single hardware interface and better utilization of the available bandwidth on the physical interface. A switch between the active and standby cards. The switchover can be initiated by command, or it can occur automatically when the active card fails. Reload of a router node. Soft reset of a router node. This involves restarting all processes running on that node.

switchover

system reload system restart

Cisco IOS XR Getting Started Guide

GL-11

Glossary

T
TAC TACACS

Cisco Technical Assistance Center. Terminal Access Controller Access Control System. Authentication protocol, developed by the DDN community, that provides remote access authentication and related services, such as event logging. User passwords are administered in a central database rather than in individual routers, providing an easily scalable network security solution. A two-stage configuration of the Cisco IOS XR software running configuration. This allows users to make changes to the running configuration and accept these changes by entering the commit command. An identifier that determines user access to a given command or series of commands. A user must be a member of a group with the appropriate task IDs assigned to it to execute the related commands. terabits per second. The amount of data that can be sent in a fixed amount of time. 1 terabit = 240 bits, or 1,099,511,627,776 bits. Transmission Control Protocol. Connection-oriented transport layer protocol that provides reliable full-duplex data transmission. TCP is part of the TCP/IP protocol stack. Standard terminal emulation protocol in the TCP/IP protocol stack. Telnet is used for remote terminal connection, enabling users to log in to remote systems and use resources as if they were connected to a local system. Telnet is defined in RFC 854. A unit of computer memory or data storage capacity equal to 1024 gigabytes (240 bytes). Approximately 1 trillion bytes. Trivial File Transfer Protocol. A simplified version of FTP that allows files to be transferred from one computer to another over a network, usually without the use of client authentication (for example, username and password). Note: some TFTP servers (such as Sun Solaris) may not support file sizes larger that 32 MB.

target configuration

task ID

Tbps

TCP

Telnet

terabyte

TFTP

trap

Message sent by an SNMP agent to an NMS, a console, or a terminal to indicate the occurrence of a significant event, such as a specifically defined condition or a threshold that was reached. Secure communication path between two peers, such as two routers. The transmitter end of a fabric link. All links are unidirectional. See also Rx.

tunnel Tx

Cisco IOS XR Getting Started Guide

GL-12

Glossary

U
UDP

User Datagram Protocol. Connectionless transport layer protocol in the TCP/IP protocol stack. UDP is a simple protocol that exchanges datagrams without acknowledgments or guaranteed delivery, requiring that error processing and retransmission be handled by other protocols. UDP is defined in RFC 768. Message sent to a single network destination. A unicast transmission sends one copy of each packet to each member of the group. This method is inefficient because the same information must be carried multiple times, requiring extra bandwidth.

unicast unicast transmission

V
VCSEL VPN

vertical cavity surface emitting laser. Virtual Private Network. Enables IP traffic to travel securely over a public TCP/IP network by encrypting all traffic from one network to another. A VPN uses tunneling to encrypt all information at the IP level.

W
WRED

Weighted Random Early Detection. Queueing method that ensures that high-precedence traffic has lower loss rates than other traffic during times of congestion.

X
XML

Extensible Markup Language. A standard maintained by the World Wide Web Consortium (W3C) that defines a syntax that lets you create markup languages to specify information structures. Information structures define the type of information, for example, subscriber name or address, not how the information looks (bold, italic, and so on). External processes can manipulate these information structures and publish them in a variety of formats. XML allows you to define your own customized markup language. A process on the router that is sent XML requests by XML clients and is responsible for carrying out the actions contained in the request and returning an XML response back to the client. The XML Agent for CORBA is an example of an XML agent provided on the Cisco CRS-1 router. An external application that sends an XML request to the router and receives XML responses to those requests. A portion of an XML request that specifies an operation that the XML client would like the XML agent to perform. The router code that carries out a particular XML operation including parsing the operation XML, performing the operation, and assembling the operation XML response

XML agent

XML client

XML operation

XML operation provider

Cisco IOS XR Getting Started Guide

GL-13

Glossary

XML request XML response XML schema

An XML document sent to the router containing a number of requested operations to be carried out. The response to an XML request. An XML document specifying the structure and possible contents of XML elements that can be contained in an XML document.

Cisco IOS XR Getting Started Guide

GL-14

INDEX

Symbols
? command
4-2 A-29

bring up hardware, first time verifying status


1-12 1-5

? command (ROM Monitor)

C A
capitalization, keyboard shortcuts abbreviated commands, entering abort command admin command
2-31 4-7 4-2 4-19

card type, displayed in prompt characters anchor


D-4

2-11

aborting command output


B-5

parentheses for pattern recall


2-18

D-4

admin configuration mode admin EXEC mode


2-18

pattern ranges special


D-2

D-2

Admin package features alarm correlation, logging alarm logging correlation locations aliases
4-16 3-11 3-11 3-11

5-3 3-11

underscore wildcard chassis

D-4

multiple-chassis system Cisco IOS XR software initial startup


1-4 1-1

1-1 2-11

number, displayed in prompt

severity levels

supported hardware

alphanumeric LED display, illustration (16-slot chassis) 1-6, 2-3 alphanumeric LED display, illustration (8-slot chassis) 1-7, 2-4 alphanumeric LED display, illustration (PRP-2) anchor characters
D-4 5-26 1-8, 2-5

Cisco IOS XR Software Selector tool cisco-support user group clear command
7-18 2-13

5-16

clear configuration commit command clear configuration sessions command CLI identifying command mode introduction
1-2 2-10 2-15

3-9 7-21

asynchronous operation, install command

B
Base package features
5-4 3-22 A-14, A-25

logging in prompt clock, router

2-11 2-38

BGP, configuration limits BOOT variable


A-12

boot command (ROM Monitor)

clock and scheduler card See CSC clock set command


2-39

Cisco IOS XR Getting Started Guide

IN-1

Index

clock timezone command

2-39 2-40

displaying

3-4 3-6

clock update-calendar command command-line interface See CLI command mode admin configuration administration EXEC CLI prompt EXEC
2-16 2-16 2-17 2-15 2-16 2-18 2-18

displaying changes loading changes


3-8

committing a configuration committing packages complex expressions


5-36 D-3

2-21

config-register command configuration clearing changes committing displaying


2-19 2-18 2-17 2-17 2-21 2-23 2-28 2-30 2-29

6-15 A-27

configuration submodes global configuration interface configuration navigation


2-14

config-register command (ROM Monitor)

navigation example ROM monitor mode router configuration commands abbreviated aliases
4-16 4-2

displaying errors ending a session limiting limits BGP IS-IS MPLS


3-22 3-19 3-27 3-26 3-17

router submode configuration

applying templates creating templates

4-14 4-4

multicast OSPF other


4-4 4-6 3-27 3-24

completing a partial command


4-12

3-19

identifying syntax errors no form output filtering halting narrowing


4-8 4-7 4-8 4-7 4-18 4-4 4-2

RPL

more prompt, responding to on-screen help

static routes overview


2-20

3-18 2-23, 2-27

merged configuration, displaying reloading a failed configuration running configuration displaying locking unlocking displaying introduction
4-5 2-21 7-19 2-24, 2-25 2-31 2-31

2-29

redirecting to a file recall deleted entries redisplaying wildcards


4-18 4-11

target configuration
2-27 2-21 3-10

wrapped lines, editing commit command commitIDs clearing


3-9

loading from a file saving to a file


3-10

commit force command

configuration files, storage

2-23 2-18

configuration mode, entering EXEC commands configurations, single and multiple-chassis


1-1

Cisco IOS XR Getting Started Guide

IN-2

Index

configuration submodes configuration templates applying creating


4-14 4-12

2-16

displaying status enabling dir command


2-32 A-30, A-31, A-32, C-6, C-7 7-5

7-5

DEFAULT_GATEWAY variable
B-4, C-5

A-12

configure exclusive command connection CLI prompt Console port connection


2-3 2-11

disk0: disk1:

5-19

confreg command (ROM Monitor)

PIE file archive

5-17 A-16 3-1

reinstalling vm files domain name command


1-6, 2-3 1-7, 1-8, 2-4, 2-5 1-5

domain name, configuration


3-2

illustration (16-slot chassis) illustration (8-slot chassis) console port, connecting to

domain name server, configuration domain name-server command drives, formatting


6-16 3-2

3-1

consolidated switch fabric cards See CSFC controller fabric plane command controllers command copy command copy ftp command copy rcp command copy tftp command CPU0 module CSC removing and replacing CSFC removing and replacing cursor movement CWI introduction
1-2 4-19 6-27 6-22 2-11 6-15 B-4, C-5 5-27 5-27 5-27 3-11 6-21

E
end command BOOT
A-12 A-12 2-31

environment variables DEFAULT_GATEWAY displaying introduction IP_ADDRESS saving errors displaying configuration errors syntax
4-4 2-28 A-31 A-3, A-4, A-13 A-30 A-2 A-12 A-12

correlation, alarm logging

Craft Works Interface See CWI

IP_SUBNET_MASK TURBOBOOT

Ethernet interface configuring


2-33 1-6, 2-3 1-7, 1-8, 2-4, 2-5

D
debug command debugging disabling for all services, all sessions disabling for all services, one session disabling for a service displaying features
7-5 7-6 7-6 7-6 7-5

connection, illustration (16-slot chassis) connection, illustration (8-slot chassis) displaying EXEC mode exit command expressions complex
D-3 2-35

EXEC commands, entering in configuration mode


2-16 2-30, B-5, B-6

2-18

Cisco IOS XR Getting Started Guide

IN-3

Index

regular

D-1

displaying status documentation history, commands hostname configuration


4-7

6-1 xv A-29

extensible markup language See XML

help command (ROM Monitor)

F
file redirecting output to file storage flash disk0: flash disk1: PIE file archive
5-17 A-16 5-27 5-19

4-17

2-32 2-11 2-32 3-2 6-12, 6-15, 6-24, 6-25, B-7

displayed in prompt hostname command

HTTP server configuration

hw-module location command

reinstalling vm files

file transfer protocols, supported File Transfer Protocol See FTP filters, command output flash disk disk0: disk1: PIE file archive flash disk0: configuration file storage format bootflash command
B-7 6-16 6-16 5-5 2-23 5-17 A-16 5-19 4-8

I
install activate command install add command
5-28 5-29, 5-33 5-29, 5-33 5-29, 5-33 5-30, 5-32 5-38

install activate command, test option install add ftp: command install add rcp: command install add tftp: command

reinstalling vm files

install command, synchronous and asynchronous operation 5-26 install commit command install remove command
5-36, 5-37 5-37

install deactivate command

5-37 5-34, 5-35

format command formatting drives FTP


5-27

install rollback committed command interface configuration mode interface MgmtEth command interfaces, verifying operation IP_ADDRESS variable
A-12 A-12 2-17 2-36

Forwarding package features

interface preconfigure command

6-17, 6-18 7-21

G
global configuration mode group command
3-17 2-16

IP_SUBNET_MASK variable

ipv4 access-list oor ace threshold command ipv4 access-list oor acl threshold command ipv4 address command
2-36

3-27 3-27

ipv6 access-list oor ace threshold command

3-27 3-27

H
halting command output hardware
4-7

ipv6 access-list oor acl threshold command IS-IS, configuration limits


3-19

Cisco IOS XR Getting Started Guide

IN-4

Index

K
keyboard shortcuts capitalization
4-19 4-18 4-19

configuration configuring

2-35 2-33 2-3 2-4

connection illustration (16-slot chassis) connection illustration (8-slot chassis) displaying name syntax
4-18 4-20 2-35 2-9

command history cursor movement deleting text


4-20

establishing a connection through


2-33 3-26

recalling deleted entries transposing letters

maximum external-sa command maximum groups command


3-26

maximum group-mappings autorp command maximum groups per-interface command maximum interfaces command
3-20 3-23 3-19 3-20 3-26

3-26

L
line card removal
6-17 6-18, 6-19 5-6 4-5

3-26

maximum-paths command (BGP) maximum-paths command (IS-IS) maximum paths command (OSPF) maximum-prefix command
3-8 3-8, 3-9 3-22

replacement

Line Card package features line wrap, editing long lines load command
3-10

maximum peer-external-sa command

maximum redistributed-prefix command (OSPF) maximum-redistributed-prefixes command (IS-IS) maximum register-states command maximum route-interfaces command
3-11 3-26 3-26

3-20 3-19

load commit changes command load rollback changes command logging alarm correlation configuration severity levels logging command
3-12 3-11 3-11

maximum routes command memory displaying system memory low memory warnings
3-11, 3-13

3-26

output locations

7-17

7-16

logging buffered command


3-12

management

3-17 7-18 2-23, 2-27

removing configurations
3-11, 3-13 3-11

logging console command logging monitor command logging trap command logical router, logging in log in, router
2-10 4-5

merged configuration, displaying mode admin configuration admin EXEC EXEC


7-18 2-16 2-16 2-17 2-18 2-16 2-18

3-11, 3-12 2-10

configuration submodes global configuration interface configuration ROM monitor


2-18 2-17

long lines, editing

low memory warning, removing configurations

M
Manageability package features Management Ethernet interface
5-10

router configuration modem connection

router submode configuration

2-17

Cisco IOS XR Getting Started Guide

IN-5

Index

illustration (16-slot chassis) illustration (8-slot chassis) module


6-4

1-6, 2-3 1-7, 1-8, 2-4, 2-5

operator user group OS package features

2-13 5-3 3-19

OSPF, configuration limits


2-11 7-8, 7-12 7-8

module, number displayed in prompt monitor processes command monitor threads command More prompt MPLS configuration limits package features MSC removal
6-17 3-26 5-9 3-27 4-6

P
package activation impact on running configuration introduction
3-27 5-19 5-19 5-19 5-21

mpls traffic-eng maximum tunnels command

addition, introduction deactivation


5-37

committing a package set

multicast, configuration limits Multicast package features


5-8

impact on running configuration removal rollback


5-37 5-19

5-21

N
name router, configuring netadmin user group no, command form node administrative shutdown power cycle reload
6-12 6-12 7-6 6-21 2-21 6-12 6-15 2-32 2-11

package installation envelope files See PIE files packages committing


5-36 4-4 A-21

partial command, entry password command


2-3

router name displayed in prompt


2-13

password, recovering root


3-16

network connection, overview


4-4

pattern alternation recall PIE files names


D-4 1-1 D-4 D-3

multiple-character

performance route processor (PRP)


5-11 5-17

shutdown

archive on flash disk1:


5-11 5-11

no debug command

no hw-module node command nonactive target configuration

version numbers ping command PLIM removal power cycle


6-17 7-3

O
OIR
6-17 6-19 6-17

replacement

6-18, 6-19 6-12 1-5 1-6, 2-3 1-7, 2-4

for switch fabric cards

power on, first time

online insertion and removal

Primary LED illustration (16-slot chassis) Primary LED illustration (8-slot chassis)

Cisco IOS XR Getting Started Guide

IN-6

Index

process

7-7 7-14 7-14 7-14

ROM monitor commands downgrades exiting options


A-31 A-28 A-29 B-2, C-2

process command

process mandatory command

process mandatory reboot command

manually halt initialization during reload

R
rack, displayed in prompt rack number rcp
5-27 4-7, 4-8 6-4 2-11

A-29 A-21 A-2

recovering the root password reinstalling vm files reloading the router


A-10, A-16 A-26

reinstalling Cisco IOS XR software

redirecting command output redundancy automatic failover commands primary RP standby RP reload router
A-26 6-12 6-10 6-11 6-10

resetting the configuration register upgrades basics example files


B-2 B-3, C-2, C-4 B-7 B-1, C-1 B-8, C-10

A-26 B-1

ROMMON A and ROMMON B, startup

manual switchover
6-9 6-9

procedure
6-10, 6-11, B-6, C-6, C-7

redundancy switchover command

troubleshooting tips version, displaying ROM monitor mode root-lr user group
2-18

B-4, C-3, C-5, C-6

software

ROMMON See ROM monitor


6-10, 6-13, B-7 2-13 A-21

reload command

Remote Copy Protocol See rcp resource management rollback committed software
5-34 3-3 3-4 3-17

root password, recovering root-system user group

2-13 3-18 3-18

route maximum ipv4 command route maximum ipv6 command route processors

configuration, overview history log, displaying package incompatibility points, displaying points, rolling back previewing changes procedure
3-7 5-34 5-35 3-6

configuration rollback failure


3-5

faceplate illustration (16-slot chassis) faceplate illustration (8-slot chassis)


3-8

1-6, 2-3 1-7, 2-4

loading changes to the target configuration


3-4

faceplate illustration (PRP-2) router clock setting


2-38 A-28 2-32

1-8, 2-5

halt initialization name configuration reloading


A-26

name displayed in prompt


3-7 7-20

2-11

rollback configuration command rollback for packages introduction


5-19

rollback configuration to command

verifying status

1-12 2-17 2-17

router configuration mode

router submode configuration

Cisco IOS XR Getting Started Guide

IN-7

Index

Routing package features RPL, configuration limits

5-7 3-24 3-24 3-24

show configuration failed command

7-14 7-15 7-15

show configuration failed noerror command show configuration failed startup command show configuration rollback changes
7-20

rpl maximum lines command RP reload


6-10

rpl maximum policies command running configuration displaying locking unlocking


2-24, 2-25 2-31 2-31

show configuration rollback changes command show configuration sessions command show context command show controller command show controllers command show debug command
3-16 5-10 7-2 7-2 6-21 2-31, 7-21

3-6 7-20

show configuration rollback changes to command

show controller fabric plane all command

S
secret command

6-15

7-2, 7-5 7-6

show debug condition command show diag command


6-1

Security package features service processor See SP session configuration overview ending SFC removing and replacing SFTP
5-27 2-30

show environment command show exception command


2-20 7-2

1-13, 4-6, 6-5, 7-2

show hosts command

3-2 3-26 5-23, 5-25 5-23 5-25

show igmp summary command


A-30

set command (ROM Monitor)


6-22

show install active command

show install active detail command show install active location command show install command
7-2

shortcuts capitalization
4-19 4-18 4-19

show install committed command show install rollback ? command show install rollback command show interface command show interfaces command
4-18 7-21 6-17, 7-2

5-25 5-34 5-35

command history cursor movement deleting text


4-20

recalling deleted entries transposing letters


4-20

show interfaces MgmtEth command show ipv4 access-lists command show ipv4 interface brief command show ipv4 interface command show isis adjacency command show isis route command
3-19 3-13, 7-2, B-5 7-2, 7-17 7-21 3-19

2-37

3-27 7-21

show aaa userdb command

3-15 2-14, 3-15 3-22

show aaa usergroup command show bgp neighbor command show clock command
2-40

show configuration command

3-10, 4-6, 7-2 3-6, 7-19

show logging command show memory command

show configuration commit changes command show configuration commit history show configuration commit list
7-20 7-18

show memory summary command


3-5, 7-18

7-17, 7-18 3-27

show configuration commit history command show configuration commit list command
Cisco IOS XR Getting Started Guide

show mpls traffic-eng maximum tunnels command show msdp summary command
3-26

3-4, 7-20

show ospf command

3-20

IN-8

Index

show pim summary command show platform command


B-5

3-26

Software Maintenance Update See SMU software packages activating on all cards activation impact on running configuration impact on system prerequisites
7-8 7-8 5-22 5-21 5-21 5-30 5-32

1-14, 4-6, 6-3, 6-10, 6-20, 6-23, 7-2, 7-2 7-8 7-8

show process blocked command show processes abort command show processes boot command show processes command show processes cpu command show processes blocked command

on a single card

7-8

7-8, 7-9, 7-10 7-8

show processes dynamic command show processes failover command show processes log command
7-8

active packages displaying all


5-23 5-25

displaying for a card


7-9, 7-11 7-9

show processes memory command show processes startup command show redundancy command show rpl maximum lines command show rpl max policies command show running-config command

adding from router available packages committing


5-36

5-28 5-1 5-16

1-15, 6-8, 6-9, 6-10, 6-14, 7-2 3-24

Cisco IOS XR Software Selector tool configuration rollback failure


3-4

3-24 4-6, 6-17, 7-2 3-18

copying, adding, and activating in one step copying and adding from network server copying to the router deactivation impact on running configuration impact on system prerequisites described
5-1 5-25 5-22 5-21 5-21 5-27 3-20

5-33 5-29

show running-config route maximum command show running-config router ospf command show task supported command show tech-support command show tracebacks command show user all command show user command
7-3 2-12, 3-15 4-6, 7-3

6-20, 6-23

2-14, 7-3 2-14, 6-19, 6-23 2-14 6-13, 6-14, 7-2

show user group command show user tasks command show version command shutdown
6-12

displaying committed versions downgrading


5-20 5-21

show variables boot command

impact of version changes management overview

1-13, 4-6, 6-3, 7-3

5-18 5-16

obtaining installable PIE files


1-4

Simple Network Management Protocol single-chassis system slot number SMU


5-11 5-13 5-13 6-4 1-1 2-11

optional PIE files rollback SMUs upgrading


1-4

5-8 5-11 5-37

slot, number displayed in prompt

removing inactive software


5-34, 5-35 5-13 5-20 5-11

filenames

version numbers

version numbers SP
6-4 xv

SNMP (Simple Network Management Protocol) software, documentation

special characters

D-2

Cisco IOS XR Getting Started Guide

IN-9

Index

SSH File Transfer Protocol start up hardware, first time verifying status
1-12 1-5

5-27

displaying

2-27 3-10

loading from a file saving to a file tar utility


3-18 1-6, 2-3 1-7, 2-4 A-5 3-10

static route, configuration limits

task group, introduction task ID, introduction task IDs displaying templates applying creating
4-14 4-12 2-13

2-12

Status LED illustration (16-slot chassis) Status LED illustration (8-slot chassis) stopping command output submodes, configuration switch fabric cards Cisco XR 12000 Series routers removing and replacing CRS-1routers removing and replacing switch fabric card See SFC synchronous operation install command syntax anchor characters
D-4 D-2 D-3 5-26 6-19 6-22 A-31 6-22 4-7 2-16

2-12

Telnet server configuration

3-2

terminal connection, illustration (16-slot chassis) terminal connection, illustration (8-slot chassis)
2-4, 2-5

1-6, 2-3 1-7, 1-8,

sync command (ROM Monitor)

terminal history command

4-18 2-7

terminal server, establishing a connection through terminal settings, default values TFTP introduction
5-27 A-10 1-10, 2-6, 2-8

character pattern ranges error identification pattern alternation pattern recall


D-4 D-1 D-2 D-4 2-13 4-4 D-4

server, reinstalling vm files TFTP_FILE thread


A-12 A-12

complex regular expressions

TFTP_FILEenvironment variables TFTP_FILE variable


7-7, 7-9, 7-12 2-38 2-38

regular expressions special characters sysadmin user group wildcard underscore

time, setting the router clock traceroute command troubleshooting basic commands
7-2 7-3

time zone, setting the router clock

Trivial File Transfer Protocol See TFTP

T
tab key tar files introduction names
A-6 A-6 2-21 2-29 A-5 4-4

displaying system memory information errors at startup


7-15 7-14 7-16 7-7 B-7 A-3, A-4, A-13 2-11

7-17

failed commit operation low memory warnings processes and threads ROM monitor upgrades TURBOBOOT variable

version numbers target configuration clearing changes

type, card type displayed in prompt

Cisco IOS XR Getting Started Guide

IN-10

Index

U
undebug all command
7-6 D-4 B-5 B-6

X
XML API
1-3 3-2

underscore wildcard character upgrade rommon A command upgrade rommon B command user access task IDs, displaying user accounts configuration overview creating user groups assigning to a user displaying introduction predefined user interfaces CLI CWI SNMP
1-2 1-2 1-4 1-3 3-16 2-13 2-12 2-13 3-16 3-16 3-15 2-13

host service configuration

XML API

username command

V
vm files names
A-9 A-10

reinstalling from a TFTP server reinstalling from disk1: version numbers


A-9 A-16

W
warning, low memory wildcards
4-11 7-16

Cisco IOS XR Getting Started Guide

IN-11

Index

Cisco IOS XR Getting Started Guide

IN-12

Vous aimerez peut-être aussi