-
Cisco IOS XR Getting Started Guide, Release 3.2
-
Preface
-
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 Routers
-
Appendix D - Understanding Regular Expressions, Special Characters, and Patterns
-
Glossary
-
Index
-
Feedback
Table Of Contents
Managing Cisco IOS XR Software Packages
Cisco IOS XR Unicast Routing Core Bundle
Package Installation Envelope Files
Standard PIE Filenames and Version Numbers
Software Maintenance Update PIE Filenames and Version Numbers
Selecting and Obtaining Software Packages
Obtaining Cisco IOS XR Software and Version Information from Cisco
Where to Place Installable PIE Files
Flash disk1: Archive of Installation PIE Files
Network Server: Downloading Updated PIE Files
Information About Package Management
Overview of Package Management
Impact of Package Version Changes
Impact of Package Activation and Deactivation
Activation and Deactivation Prerequisites
Displaying the Active Packages for All Cards
Displaying the Active Packages for a Single Card
Displaying the Committed Package Versions for Each Card
Upgrading, Downgrading, and Installing Packages
Controlling install Command Operation
Supported File Transfer Protocols
Copying Package Files from a Network Server to the Router
Adding Packages that are Resident on the Router
Adding Files from a Network Server
Activating a Package for All Appropriate Cards
Activating a Package for a Single Card
Adding and Activating Package Files in One Step from a Network Server
Rolling Back to the Last Committed Package Set
Displaying Noncommitted Rollback Points
Rolling Back to a Noncommitted Rollback Point
Committing the Active Package Set
Removing Inactive Packages from the Router
Configuration Examples for Managing Packages
Activating and Testing a Package on the Router: Example
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
•
•
•
•
Overview of Software Packages
This section provides the following information on software packages:
•
•
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 for information on obtaining PIE files.
Figure 5-1 Cisco IOS XR 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
OS
Basic operating system
•
•
•
•
•
•
•
•
•
•
•
Admin
Basic software required to install packages and manage the router
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Base
Basic infrastructure needed to boot to the CLI prompt
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Forwarding
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Line Card
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Routing
Routing protocols (BGP, OSPF, and IS-IS), RIB, and routing policy engine
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
1 IPv6 is not supported on the Cisco XR 12000 Series Router.
Optional Individual Packages
Table 5-2 describes the optional packages that can be activated individually.
Table 5-2 Optional Packages
Multicast
•
•
•
•
•
•
•
•
•
•
•
•
Multiprotocol Label Switching (MPLS)
•
•
•
–
–
–
–
–
–
•
–
–
–
–
–
–
•
–
–
–
–
–
–
–
•
•
•
Manageability
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml
Security
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
1 IPv6 is not supported on the Cisco XR 12000 Series Router.
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
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
Table 5-3 Composite- and Single-Package Filename Components
platform
Identifies the platform for which the software package is designed.
•
•
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:
•
•
•
•
•
•
•
major
Identifies the major release of this package.
•
•
•
minor
Identifies the minor release of this package.
•
–
–
•
•
maintenance
Identifies the maintenance release of this package.
•
•
•
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.
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.
In the following example, the SMU for the base package version 2.0.0 fixes DDTS CSCec98765:
In the following example, the SMU comp-001.CSCec98766 provides changes to multiple packages, as specified in DDTS CSCec98766:
Note
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
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/pcgi-bin/Software/IOXPlanner/planner-tool/ioxplanner.cgi?
The following packages can be downloaded and installed without interrupting the router:
•
•
•
•
•
•
Note
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).
Figure 5-2 Where to Locate and Store PIE Installation Files
Note
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 for information on obtaining a list of available PIE files.
Note
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.
Information About Package Management
This section describes the following concepts for managing Cisco IOS XR software packages:
•
•
•
•
•
Overview of Package Management
Package management processes include the following:
•
•
•
•
•
The general procedure for adding optional packages, upgrading packages, or downgrading packages on the router is as follows:
1.
2.
3.
4.
Figure 5-3 illustrates key steps in the package management process.
Figure 5-3 Process to Add, Activate, and Commit Cisco IOS XR Software Packages
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
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.
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 for more information.
Caution
Figure 5-4 Example of a Maintenance Release Package Upgrade
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 for more information.
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:
•
•
•
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:
•
•
•
Note
•
•
•
•
•
Tip
Activation and Deactivation Prerequisites
The following prerequisites must be met for a package to be activated or deactivated.
•
•
•
•
•
•
•
•
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 before performing the following tasks. The following sections describe package management tasks:
•
•
•
•
•
•
•
•
•
•
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 activeNode 0/1/SP [SP]Boot Image: /disk0/hfr-os-mbi-3.2.00/sp/mbihfr-sp.vmActive Packages:disk0:comp-hfr-mini-3.2.00Node 0/1/CPU0 [LC]Boot Image: /disk0/hfr-os-mbi-3.2.00/lc/mbihfr-lc.vmActive Packages:disk0:hfr-mcast-3.2.00disk0:hfr-mpls-3.2.00disk0:comp-hfr-mini-3.2.00Node 0/RP1/CPU0 [RP]Boot Image: /disk0/hfr-os-mbi-3.2.00/mbihfr-rp.vmActive Packages:disk0:hfr-mgbl-3.2.00disk0:hfr-mcast-3.2.00disk0:hfr-mpls-3.2.00disk0:hfr-k9sec-3.2.00disk0:comp-hfr-mini-3.2.00Node 0/SM0/SP [SP]Boot Image: /disk0/hfr-os-mbi-3.2.00/sp/mbihfr-sp.vmActive Packages:disk0:comp-hfr-mini-3.2.00Node 0/SM1/SP [SP]Boot Image: /disk0/hfr-os-mbi-3.2.00/sp/mbihfr-sp.vmActive Packages:disk0:comp-hfr-mini-3.2.00In 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 detailNode 0/0/CPU0 [RP]Boot Image: /disk0/c12k-rp-os-mbi-3.2.00/mbiprp-rp.vmActive Packages:disk0:c12k-mini-3.2.00disk0:c12k-rp-rout-3.2.00disk0:c12k-rp-lc-3.2.00disk0:c12k-rp-fwdg-3.2.00disk0:c12k-rp-admin-3.2.00disk0:c12k-rp-base-3.2.00disk0:c12k-rp-os-mbi-3.2.00Node 0/3/CPU0 [LC(E3-OC3-POS-8)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00disk0:c12k-lc-lc-3.2.00disk0:c12k-lc-fwdg-3.2.00disk0:c12k-lc-admin-3.2.00disk0:c12k-lc-base-3.2.00disk0:c12k-lc-os-mbi-3.2.00Node 0/4/CPU0 [LC(E3-GE-4)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00disk0:c12k-lc-lc-3.2.00disk0:c12k-lc-fwdg-3.2.00disk0:c12k-lc-admin-3.2.00disk0:c12k-lc-base-3.2.00disk0:c12k-lc-os-mbi-3.2.00Node 0/5/CPU0 [LC(E3-GE-4)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00disk0:c12k-lc-lc-3.2.00disk0:c12k-lc-fwdg-3.2.00disk0:c12k-lc-admin-3.2.00disk0:c12k-lc-base-3.2.00disk0:c12k-lc-os-mbi-3.2.00Node 0/6/CPU0 [LC(E3-OC48-POS)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00disk0:c12k-lc-lc-3.2.00disk0:c12k-lc-fwdg-3.2.00disk0:c12k-lc-admin-3.2.00disk0:c12k-lc-base-3.2.00disk0:c12k-lc-os-mbi-3.2.00Node 0/7/CPU0 [LC(E3-GE-4)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00disk0:c12k-lc-lc-3.2.00disk0:c12k-lc-fwdg-3.2.00disk0:c12k-lc-admin-3.2.00disk0:c12k-lc-base-3.2.00disk0:c12k-lc-os-mbi-3.2.00Node 0/8/CPU0 [LC(E3-OC12-POS-4)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00disk0:c12k-lc-lc-3.2.00disk0:c12k-lc-fwdg-3.2.00disk0:c12k-lc-admin-3.2.00disk0:c12k-lc-base-3.2.00disk0:c12k-lc-os-mbi-3.2.00Displaying 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/cpu0Node 0/0/CPU0 [RP]Boot Image: /disk0/c12k-rp-os-mbi-3.2.00/mbiprp-rp.vmActive Packages:disk0:c12k-mini-3.2.00Displaying 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 committedNode 0/0/CPU0 [RP]Boot Image: /disk0/c12k-rp-os-mbi-3.2.00/mbiprp-rp.vmActive Packages:disk0:c12k-mini-3.2.00Node 0/3/CPU0 [LC(E3-OC3-POS-8)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00Node 0/4/CPU0 [LC(E3-GE-4)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00Node 0/5/CPU0 [LC(E3-GE-4)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00Node 0/6/CPU0 [LC(E3-OC48-POS)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00Node 0/7/CPU0 [LC(E3-GE-4)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00Node 0/8/CPU0 [LC(E3-OC12-POS-4)]Boot Image: /disk0/c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:disk0:c12k-mini-3.2.00As 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. The following sections describe features and procedures you can use to upgrade, downgrade, and install optional packages:
•
•
•
•
•
•
•
•
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
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
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
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
hostname_or_ipaddress
Host name or IP address of the server that stores the source file.
pie-name
Name of the PIE file (package) to install. See the "Available Packages" section for descriptions of the available PIE files.
username
Required for FTP and rcp only and must be a valid username on the FTP or rcp server.
password
Required for FTP only. If a password is not provided, the networking device accepts anonymous FTP.
directory-path
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
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 installoperationsInstall: Starting install operation. Do not insert or remove cards until the operation completes.RP/0/0/CPU0:router(admin)#Install: Now operating in asynchronous mode. Do not attempt subsequent install operations until this operation is complete.Install 1: [ 0%] Install operation 'add /disk0:c12k-mgbl.pie-3.2.00.1i to disk0:' assigned request id: 1Install 1: [ 1%] Downloaded the package to the routerInstall 1: [ 1%] Verifying the packageInstall 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 beactivated:Install 1: [100%] disk0:c12k-mgbl-3.2.00Install 1: [100%] Please carefully follow the instructions in the release noteswhen activating any softwareInstall 1: [100%] Idle timeout on this line will now be resumed for synchronousinstall operations
Tip
Note
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
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 installoperationsInstall: Starting install operation. Do not insert or remove cards until the operation completes.RP/0/0/CPU0:router(admin)#Install: Now operating in asynchronous mode. Do not attempt subsequent install operations 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: 1Install 1: [ 1%] Downloading PIE file from /tftp://10.1.1.1/software/c12k-k9sec.pie-3.2.00.1iInstall 1: [ 1%] Transferred 1320473 BytesInstall 1: [ 1%] Downloaded the package to the routerInstall 1: [ 1%] Verifying the packageInstall 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 beactivated:Install 1: [100%] disk0:c12k-k9sec-3.2.00Install 1: [100%] Please carefully follow the instructions in the release noteswhen activating any softwareInstall 1: [100%] Idle timeout on this line will now be resumed for synchronousinstall operations
Tip
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
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 drwx 16384 Tue Oct 19 17:07:44 2004 LOST.DIR3 drwx 16384 Fri Nov 12 13:29:48 2004 c12k-lc-os-mbi-3.2.00564 drwx 16384 Fri Nov 12 15:38:59 2004 instdb566 drwx 16384 Fri Nov 12 13:31:30 2004 c12k-lc-base-3.2.002047 drwx 16384 Fri Nov 12 13:31:34 2004 c12k-lc-admin-3.2.002092 drwx 16384 Fri Nov 12 13:31:50 2004 c12k-lc-fwdg-3.2.002260 drwx 16384 Fri Nov 12 13:32:32 2004 c12k-lc-lc-3.2.002796 drwx 16384 Fri Nov 12 13:32:44 2004 c12k-rp-os-mbi-3.2.003281 drwx 16384 Fri Nov 12 13:36:56 2004 c12k-rp-base-3.2.006344 drwx 16384 Fri Nov 12 13:37:34 2004 c12k-rp-admin-3.2.006818 drwx 16384 Fri Nov 12 13:38:08 2004 c12k-rp-fwdg-3.2.007175 drwx 16384 Fri Nov 12 13:38:20 2004 c12k-rp-lc-3.2.007298 drwx 16384 Fri Nov 12 13:39:08 2004 c12k-rp-rout-3.2.004 drwx 16384 Tue Oct 19 17:21:00 2004 shutdown8014 drwx 16384 Thu Nov 11 09:36:16 2004 config8045 dr-x 16384 Fri Nov 12 14:21:28 2004 aaa8047 drwx 16384 Tue Oct 19 17:24:24 2004 usr8048 drwx 16384 Tue Oct 19 17:24:24 2004 var67072 -rwx 4440 Fri Nov 12 15:39:04 2004 sam_certdb67168 -rwx 54027072 Fri Nov 12 10:47:48 2004 c12k-mini.vm-3.2.00.1i67360 -rwx 126 Fri Nov 12 15:39:04 2004 sam_crldb8099 drwx 16384 Wed Nov 10 23:37:40 2004 dumper8144 drwx 16384 Fri Nov 12 14:10:12 2004 c12k-rp-k9sec-3.2.008126 drwx 16384 Fri Nov 12 15:38:59 2004 c12k-rp-mgbl-3.2.001024507904 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
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.00Install: The idle timeout on this line will be suspended for synchronous installoperationsInstall: Starting install operation. Do not insert or remove cards until the operation completes.RP/0/0/CPU0:router(admin)#Install: Now operating in asynchronous mode. Do not attempt subsequent install operations until this operation is complete.Install 3: [ 0%] Install operation 'activate disk0:c12k-rp-k9sec-3.2.00' assigned request id: 3Install 3: [ 1%] Performing Inter-Package Card/Node/Scope Version Dependency ChecksInstall 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.00Install 3: [ 10%] Checking running configuration version compatibility with newly activated software ...Install 3: [ 10%] No incompatibilities found between the activated software androuter 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 nodesInstall 3: [ 55%] Successfully downloaded packages to impacted nodesRP/0/0/CPU0:Nov 12 14:23:21.188 : instdir[181]: %INSTMGR-6-SOFTWARE_CHANGE_START : Softwarechange transaction 3 is BEGINNING...Install 3: [ 55%] Performing software changeThis product contains cryptographic features and is subject to UnitedStates and local country laws governing import, export, transfer anduse. Delivery of Cisco cryptographic products does not imply third-partyauthority to import, export, distribute or use encryption. Importers,exporters, distributors and users are responsible for compliance withU.S. and local country laws. By using this product you agree to complywith applicable laws and regulations. If you are unable to comply withU.S. and local laws, return this product immediately.A summary of U.S. laws governing Cisco cryptographic products may befound at:http://www.cisco.com/wwl/export/crypto/tool/stqrg.htmlIf you require further assistance please contact us by sending email toexport@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 changeInstall 3: [100%] Activation operation successful.Install 3: [100%] NOTE: The changes made to software configurations will not beInstall 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 synchronousinstall operationsActivating 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
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
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
Tip
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
In the following example, the system is rolled back to the last committed package set:
RP/0/0/CPU0:router(admin)# install rollback committedInstall: The idle timeout on this line will be suspended for synchronous installoperationsInstall: Starting install operation. Do not insert or remove cards until the operation completes.RP/0/0/CPU0:router(admin)#Install: Now operating in asynchronous mode. Do not attempt subsequent install operations until this operation is complete.Install 5: [ 0%] Install operation 'rollback committed' assigned request id: 5Install 5: [ 10%] Updating software configurations.Install 5: [ 10%] RP,DRP:Install 5: [ 10%] Deactivating c12k-rp-k9sec-3.2.00Install 5: [ 10%] Checking running configuration version compatibility with newly activated software ...Install 5: [ 10%] No incompatibilities found between the activated software androuter 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 nodesInstall 5: [ 55%] Successfully downloaded packages to impacted nodesRP/0/0/CPU0:Nov 14 08:36:46.502 : instdir[181]: %INSTMGR-6-SOFTWARE_CHANGE_START : Softwarechange 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 changeInstall 5: [100%] Rollback operation successful.Install 5: [100%] NOTE: The changes made to software configurations will not beInstall 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 synchronousinstall operationsDisplaying 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 ID of the rollback point to show package information for5 ID of the rollback point to show package information forIn 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 5Node 0/0/CPU0 [RP]Boot Image: /c12k-rp-os-mbi-3.2.00/mbiprp-rp.vmActive Packages:mem:c12k-rp-k9sec-3.2.00mem:c12k-mini-3.2.00Node 0/3/CPU0 [LC(E3-OC3-POS-8)]Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:mem:c12k-mini-3.2.00Node 0/4/CPU0 [LC(E3-GE-4)]Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:mem:c12k-mini-3.2.00Node 0/5/CPU0 [LC(E3-GE-4)]Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:mem:c12k-mini-3.2.00Node 0/6/CPU0 [LC(E3-OC48-POS)]Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:mem:c12k-mini-3.2.00Node 0/7/CPU0 [LC(E3-GE-4)]Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:mem:c12k-mini-3.2.00Node 0/8/CPU0 [LC(E3-OC12-POS-4)]Boot Image: /c12k-lc-os-mbi-3.2.00/gsr/ucode/mbi12000-lc.ucodeActive Packages:mem:c12k-mini-3.2.00Rolling 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. To roll back to a noncommitted rollback point, enter the install rollback command in admin EXEC mode with the rollback point number.
Note
Tip
In the following example, the system is rolled back to noncommitted rollback point 0:
RP/0/0/CPU0:router(admin)# install rollback 0Install: The idle timeout on this line will be suspended for synchronous installoperationsInstall: Starting install operation. Do not insert or remove cards until the operation completes.RP/0/0/CPU0:router(admin)#Install: Now operating in asynchronous mode. Do not attempt subsequent install operations until this operation is complete.Install 8: [ 0%] Install operation 'rollback 0' assigned request id: 8Install 8: [ 10%] Updating software configurations.Install 8: [ 10%] RP,DRP:Install 8: [ 10%] Deactivating c12k-rp-k9sec-3.2.00Install 8: [ 10%] Checking running configuration version compatibility with newly activated software ...Install 8: [ 10%] No incompatibilities found between the activated software androuter 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 nodesInstall 8: [ 55%] Successfully downloaded packages to impacted nodesInstall 8: [100%] Performing software changeInstall 8: [100%] Rollback operation successful.Install 8: [100%] NOTE: The changes made to software configurations will not beInstall 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 synchronousinstall operationsCommitting 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 commitInstall: The idle timeout on this line will be suspended for synchronous installoperationsInstall 6: [ 1%] Install operation 'commit' assigned request id: 6Install 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 synchronousinstall operations
Note
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.90Install: The idle timeout on this line will be suspended for synchronous installoperationsInstall: Starting install operation. Do not insert or remove cards until the operation completes.RP/0/0/CPU0:router(admin)#Install: Now operating in asynchronous mode. Do not attempt subsequent install operations until this operation is complete.Install 8: [ 0%] Install operation 'deactivate disk0:c12k-rp-mgbl-3.2.00' assigned request id: 8Install 8: [ 1%] Package 'disk0:c12k-rp-mgbl-3.2.00' is not active and cannot be deactivated.Install 8: [ 1%] Idle timeout on this line will now be resumed for synchronousinstall operationsRemoving 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.
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
Configuration Examples for Managing Packages
This section provides the following package management examples:
•
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 testInstall: The idle timeout on this line will be suspended for synchronous installoperationsInstall: Starting install operation. Do not insert or remove cards until the operation completes.RP/0/0/CPU0:router(admin)#Install: Now operating in asynchronous mode. Do not attempt subsequent install operations until this operation is complete.Install 6: [ 0%] Install operation 'activate disk0:c12k-rp-mgbl-3.2.00 test' assigned request id: 6Install 6: [ 1%] WARNING! No changes will occur due to 'test' option.Install 6: [ 1%] WARNING! The following is the predicted output for this install command.Install 6: [ 1%] Performing Inter-Package Card/Node/Scope Version Dependency ChecksInstall 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.00Install 6: [ 10%] WARNING! No incompatible configuration will be removed due tothe 'test' optionInstall 6: [ 10%] Checking running configuration version compatibility with newly activated software ...Install 6: [ 10%] No incompatibilities found between the activated software androuter running configuration.Install 6: [ 10%] Node 0/0/CPU0: 5 c12k-rp-mgbl processes affected (0 updated, 5added, 0 removed, 0 impacted)Install 6: [ 10%] Activation operation successful.Install 6: [ 10%] NOTE: The changes made to software configurations will not beInstall 6: [ 10%] persistent across RP reloads. Use the command 'install commit'Install 6: [ 10%] to make changes persistent.Install 6: [ 10%] WARNING! No changes have occured due to 'test' option.Install 6: [ 10%] Idle timeout on this line will now be resumed for synchronousinstall operationsRP/0/0/CPU0:router(admin)# show install log 6Request id 6 by lab at Thu Dec 02 06:38:24 2004:1 package activated: disk0:c12k-rp-mgbl-3.2.00 testSummary:Node 0/0/CPU0: 5 c12k-rp-mgbl processes affected (0 updated, 5 added, 0removed, 0 impacted)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.00WARNING! No incompatible configuration will be removed due to the 'test'optionChecking running configuration version compatibility with newly activated software ...No incompatibilities found between the activated software and router running configuration.Node 0/0/CPU0: 5 c12k-rp-mgbl processes affected (0 updated, 5 added, 0removed, 0 impacted)Activation operation successful.NOTE: The changes made to software configurations will not bepersistent 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_interfaceAdding and starting process: pm_collectorAdding and starting process: pm_serverAdding and starting process: snmppingdAdding executable: xml_demo_agentAdding and starting process: xmlagentAdding file: sh_ciscosensormib_ns_cfg__api.configinfoAdding file: sh_emweb_ns_cfg__api.configinfoAdding file: sh_frucontrolmib_ns_cfg__api.configinfoAdding file: sh_perfmgmt_ns_cfg__api.configinfoAdding file: sh_xmlagent_ns_cfg__api.configinfoAdding file: comm.jarAdding file: comm.jar.nonwindowsAdding file: craft.htmlAdding file: cwi.xmlAdding file: cwi_desktop.jarAdding file: cwi_help.zipAdding file: cwi_if.jarAdding file: cwi_ne.jarAdding file: cwi_tools.jarAdding file: javax.comm.propertiesAdding file: launcher.jarAdding file: libSerial.so.linuxAdding file: librxtxSerial.jnilib.macAdding file: orb.jarAdding file: win32com.dll.winAdding file: md5_manifestAdding DLL: libhttperr.dllAdding DLL: libpm_error.dllAdding DLL: libtaoorbutils.dllAdding DLL: libxmlcfgmgrdebug.dllAdding DLL: libxmlcfgmgrerror.dllAdding DLL: libxmlcfgmgrops.dllAdding DLL: libxmlclierror.dllAdding DLL: libxmlcliops.dllAdding DLL: libxmlmdadebug.dllAdding DLL: libxmlmdaerror.dllAdding DLL: libxmlmdaops.dllAdding DLL: libxmlmdatrans.dllAdding DLL: libxmlservice.dllAdding DLL: libxmlserviceerror.dllAdding DLL: libxmltarcfg.dllAdding DLL: libbulkfilemib.dllAdding DLL: libciscoassetmib.dllAdding DLL: libciscosensormib.dllAdding DLL: libfrucontrolmib.dllAdding DLL: libftpclientmib.dllAdding DLL: libpingmib.dllAdding file: crs-mgbl--1.infoAdding file: crs-mgbl--10.infoAdding file: crs-mgbl--11.infoAdding file: crs-mgbl--12.infoAdding file: crs-mgbl--13.infoAdding file: crs-mgbl--14.infoAdding file: crs-mgbl--15.infoAdding file: crs-mgbl--16.infoAdding file: crs-mgbl--2.infoAdding file: crs-mgbl--3.infoAdding file: crs-mgbl--4.infoAdding file: crs-mgbl--5.infoAdding file: crs-mgbl--6.infoAdding file: crs-mgbl--7.infoAdding file: crs-mgbl--8.infoAdding file: crs-mgbl--9.infoAdding file: bulkfile.mibAdding file: ciscoasset.mibAdding file: ciscosensor.mibAdding file: frucontrol.mibAdding file: ftpclient.mibAdding file: ping.mibAdding file: bulkfilemib_cmds.parserAdding file: cfg_emorb_cmds.parserAdding file: cfg_emorb_xmlagent.parserAdding file: cfg_perfmgmt.parserAdding file: ciscoassetmib_cmds.parserAdding file: ciscosensormib_cmds.parserAdding file: frucontrolmib_cmds.parserAdding file: ftpclientmib_cmds.parserAdding file: http_cfg_cmds.parserAdding file: http_debug_cmds.parserAdding file: oper_perfmgmt.parserAdding file: pingmib_cmds.parserAdding file: xml_cfgmgr_debug.parserAdding file: xml_cli_debug.parserAdding file: xml_infra_debug.parserAdding file: xml_mda_debug.parserAdding file: sh_mgbl_ns_cfg__api.partitioninfoAdding and starting process: emwebAdding file: manageability_perf_cfg_common.schemaAdding file: manageability_perf_enable_monitor_cfg.schemaAdding file: manageability_perf_enable_stats_cfg.schemaAdding file: manageability_perf_enable_thresh_cfg.schemaAdding file: manageability_perf_oper.schemaAdding file: manageability_perf_stats_cfg.schemaAdding file: manageability_perf_thresh_cfg.schemaAdding file: httpd.startupAdding file: pingmib.startupAdding file: pm_collector.startupAdding file: pm_server.startupAdding file: xmlagent.startupReplacing file: package_compatibilityInstallation impact details:Output format:<Level> (<Impact>:<Note>) <Name> <Type>[package:component]Level : the distance from the process along the DLL dependency chainImpact : a one character indication of how this server or DLL is impacted:C modified; A added; R removed; I impacted by its dependenciesNote : blank, or one of these annotations:d duplicate (this DLL has already been listed previously for this process)s self-managing (this server self-manages changes in its dependenciesName : the name of this server or DLLType : "server" or "DLL"Package : the Package containing this server or DLLComponent: the source code component containing this server or DLLNode class: RP1 node(s): 0/0/CPU05 New Servers to be started0 (A: ) pm_collector server [c12k-rp-mgbl:manageability-perf]0 (A: ) pm_server server [c12k-rp-mgbl:manageability-perf]0 (A: ) snmppingd server [c12k-rp-mgbl:snmp-pingmib]0 (A: ) xmlagent server [c12k-rp-mgbl:generic-xmlagent]0 (A: ) emweb server [c12k-rp-mgbl:emweb]
