To add software
functionality to the active software set, use the
install
activate command in
EXEC or
Admin EXEC mode or
EXEC mode.
EXEC Mode:
install activate {device:package | id add-id} [auto-abort-timer time] [location node-id] [asynchronous | synchronous] [parallel-reload] [prompt-level {default | none}] [test] [pause sw-change]
Administration EXEC Mode:
install activate {device:package | id add-id} [auto-abort-timer time] [sdr sdr-name] [location node-id] [if-active] [asynchronous | synchronous] [parallel-reload] [prompt-level {default | none}] [test] [pause sw-change]
Syntax Description
|
device:package
|
Device and
package, expressed in concatenated form (for example, disk0:asr9k-mgbl-4.0.0).
For the
device
argument, the value is a specified storage device, typically disk0:. This is
the local storage device where the package was added with the
install
add command.
Press
?
after a partial package name to display all possible
matches available for activation. If there is only one match, press the
Tab key to
fill in the rest of the package name. Up to 16 device–package pairs can be
specified.
|
Note
|
Multiple
packages can be activated at one time. Up to 16 packages can be specified in a
single
install
activate command. Multiple packages can be specified using the
wildcard syntax, for example, harddisk:*4.0*. If multiple Software Maintenance
Upgrades (SMUs) are activated, some SMUs may require a reload. If the operation
requires a node reload, the user is prompted before the installation operation
occurs.
|
|
|
id
add-id
|
Specifies
the ID number of an
install add
operation. The command activates all packages that were added in the specified
install add
operation. The ID number of an
install add
operation is indicated in the syslog displayed during the operation and in the
output of the
show install
log command. Up to 16
install
add operations can be specified.
|
|
auto-abort-timer
time
|
(Optional)
Specifies an abort timer value, in minutes, which when expired loads the last
committed loadpath.
|
|
sdr
sdr-name
|
(Administration EXEC mode only) Activates a package for a
specific secure domain router (SDR). The value of the
sdr-name
argument is
Owner , which refers to the entire router.
|
|
location
node-id
|
(Optional)
Activates a package on the designated node. The
node-id
argument is expressed in
rack/ slot/ module
notation.
|
Note
|
A
package cannot be activated on a single node unless some version of the package
being activated is already active on all nodes. For example, a Multiprotocol
Label Switching (MPLS) package cannot be active on only one node. If a version
of the MPLS package is already active on all nodes, an MPLS package then could
be upgraded or downgraded on a single node.
|
|
Note
|
To
activate a package on all supported nodes, do not specify a location.
|
|
|
if-active
|
(Optional.
Administration EXEC mode only) Activates an optional package or SMU for an
optional package only if an earlier version of the package is already
active.
|
|
asynchronous
|
(Optional)
Performs the command in asynchronous mode. In asynchronous mode, the command
runs in the background, and the EXEC prompt is returned as soon as possible.
This is the default mode.
|
|
synchronous
|
(Optional)
Performs the command in synchronous mode. This mode allows the installation
process to finish before the prompt is returned.
|
|
parallel-reload
|
(Optional)
Forces all cards on the router to reload at the same time and then come up with
the new software, rather than proceeding according to the option encoded in the
install package.
|
|
prompt-level {default |
none}
|
(Optional)
Specifies when you are prompted for input during the procedure.
|
|
test
|
(Optional)
Verifies the effects of proposed operations without making changes to the
Cisco IOS XR software.
|
|
pause sw-change
|
(Optional)
Pauses the operation after the preparatory stage and before locking the
configuration for the actual software change. While the operation is paused,
you can perform configuration changes. You control the resumption of the
operation from the command-line interface (CLI) prompt.
|
Command Default
If the
install
prepare command was not executed prior to
install
activate, executing the
install
activate command without any keywords aborts the process.
-
Package is activated for all supported nodes in the system.
-
Operation is performed in asynchronous mode: The install
activate command runs in the background, and the EXEC prompt is returned as soon as possible.
EXEC Mode
-
Package is activated on all supported nodes for the SDR.
-
Operation is performed in asynchronous mode: The install
activate command runs in the background, and the EXEC prompt is returned as soon as possible.
Command Modes
EXEC
Admin EXEC mode
EXEC mode
Command History
|
Release
|
Modification
|
|
Release 3.7.2
|
This
command was introduced.
|
|
Release 4.0.0
|
This
command was removed from EXEC mode.
Support
for the
sdr keyword
was removed.
|
Usage Guidelines
Use the
install
activate command to activate
software packages or SMUs for all valid cards.
Information within the package is used to verify compatibility with the target
cards and with the other active software. Actual activation is performed only
after the package compatibility and application program interface (API)
compatibility checks have passed.
Specifying
Packages to Activate
You can either use
the
id
add-id keyword and argument to activate all
packages that were added in one or more specific
install add
operations, or specify packages by name. The operation ID of an
install add
operation is indicated in the syslog displayed during the operation and in the
output of the
show install
log command. If you specify packages according to operation ID,
all the packages that were added by the specified operation must still be on
the router.
Upgrading and
Downgrading Packages
-
To upgrade a package, activate the later version of the package; the earlier version is automatically deactivated.
-
To downgrade a package, activate the earlier version of the package; the later version is automatically deactivated.
Caution
|
Downgrading to
Cisco IOS XR Software Release 3.7.0 or earlier is not supported if you are
using a FAT32 flash disk. If you are using a FAT32 flash disk, and you must
downgrade, convert the flash disk to FAT16 before downgrading. If you do not
convert the flash disk to FAT16 before the downgrade, the disk becomes
unreadable and the router does not boot. Converting from FAT32 to FAT16 is a
complex procedure.
|
Note
|
Activating a
Software Maintenance Update (SMU) does not cause any earlier SMUs, or the
package to which the SMU applies, to be automatically deactivated.
|
Activating a
Package for a Specific SDR
-
To activate a package for a specific SDR from administration EXEC mode, use the install activate command with the sdr
sdr-name keyword and argument.
-
To activate a package when logged into an SDR, use the install activate command in EXEC mode.
Note
|
Some packages do
not support SDR-specific activation and can only be activated for all SDRs
simultaneously from administration EXEC mode. For detailed instructions, see
the
Managing
Cisco IOS XR Software Packages module of
System Management Configuration Guide for Cisco ASR 9000 Series Routers.
|
Activating New
Versions of the Currently Active Packages
Use the
install
activate command with the
if-active
keyword to activate the package only on SDRs where an earlier version of the
package is already active. This command is available only in administration
EXEC mode.
The
if-active
keyword is used only for optional packages or SMUs for optional packages.
Router Reloads
Following Package Activation
If the activation
requires a reload of the SDR, a
confirmation prompt appears. Use the
install
activate command with the
prompt-level
none keywords to automatically ignore any reload confirmation
prompts and proceed with the package activation. The router reloads if
required.
Node Reloads
Following Package Activation
If the software
activation requires a router reload, a confirmation prompt appears.
Node Reloads
Following Package Activation
If a software
operation requires a node reload, the config-register for that node should be
set to autoboot. If the config-register for the node is not set to autoboot,
the system automatically changes the setting and the node reloads. A message
describing the change is displayed.
Synchronous
Mode
Use the
install
activate command with the
synchronous
keyword to complete the operation before the prompt is returned. A progress bar
indicates the status of the operation. For example:
- 1% complete: The operation can still be aborted (ctrl-c for options)
\ 10% complete: The operation can still be aborted (ctrl-c for options)
When the
install
activate command is run in asynchronous mode, the system may stay
in synchronous mode for a short period of time while the system checks for
questions to ask the user.
Press
Ctrl-C
during a synchronous operation to abort the operation or make the operation
asynchronous.
Test
Option
Use the
test keyword
to verify the effects of the proposed operations and determine whether the
installation can be completed. After previewing the effects of the proposed
operations, use the
show install
log command for more details about the effects of the proposed
operations.
Auto-abort
Option
Use the
auto-abort-timer keyword to provide a safety
mechanism for the instance that a package is activated and access to the router
is lost. This option automatically rolls back to the current committed
loadpath, thereby undoing any changes that are activated with the
install
activate command. After the installation, if the activated
software is working correctly, use the
install
commit command to cancel the timer and commit the new loadpath.
Note
|
The changes made
to the active software set are not persistent during route processor (RP)
reloads. Use the
install
commit command to make changes persistent.
|
Parallel
Reload
Install operations
are activated according to the method encoded in the package being activated.
Generally, this method has the least impact for routing and forwarding
purposes, but it may not be the fastest method from start to finish and can
require user interaction by default. To perform the installation procedure as
quickly as possible, you can specify the
parallel-reload keyword. This action forces the
installation to perform a parallel reload, so that all cards on the router
reload simultaneously and then come up with the new software. This impacts
routing and forwarding, but it ensures that the installation is performed
without other issues.
Pausing Before
Configuration Lock
Use the
pause
sw-change keywords to pause the operation before locking the
configuration. An
install
activate operation begins with preparatory steps, such as
software checks, and then proceeds with the actual activation of the new
software. The configuration is locked for the activation. If you specify the
pause
sw-change keywords, the operation pauses before locking the
configuration and provides you with the option to hold the operation while you
perform configuration changes, and you can proceed with the activation whenever
you choose. This action is useful, for example, if your workflow involves
configuring a router out of the network during software installation and you
want to minimize the time that the router is out of the network. You can
specify these keywords for both asynchronous and synchronous operations. In
both cases, follow the onscreen instructions to control the pausing and
completion of the operation.
Examples
The following example shows
how to display the packages available for activation using the online help
system. In this example,
? is entered
after a partial package name to display all possible matches:
RP/0/RSP0/CPU0:router# admin
RP/0/RSP0/CPU0:router(admin)# install activate disk0:?
disk0:comp-asr9k-mini-3.7.2 disk0:asr9k-admin-3.7.2 disk0:asr9k-base-3.7.2
disk0:asr9k-diags-3.7.2
disk0:asr9k-fwdg-3.7.2 disk0:asr9k-k9sec-3.7.2 disk0:asr9k-lc-3.7.2
disk0:asr9k-mcast-3.7.2
disk0:asr9k-mgbl-3.7.2 disk0:asr9k-mpls-3.7.2 disk0:asr9k-os-mbi-3.7.2.1
I disk0:asr9k-rout-3.7.2
The following example shows
how to activate a package that was installed in an
install
add
operation that was assigned install operation id 2:
RP/0/RSP0/CPU0:router(admin)# install activate id 2
Install operation 3 '(admin) install activate id 2' started by user 'lab' via
CLI at 01:10:21 UTC Thu Jan 03 2008.
Info: This operation will activate the following package:
Info: disk0:asr9k-mcast-3.7.0
Info: Install Method: Parallel Process Restart
The install operation will continue asynchronously.
Info: The changes made to software configurations will not be persistent
Info: across system reloads. Use the command '(admin) install commit' to
Info: make changes persistent.
Info: Please verify that the system is consistent following the software
Info: change using the following commands:
Info: show system verify
Info: install verify packages
Install operation 3 completed successfully at 01:11:30 UTC Thu Jan 03 2008.
The following example shows
how to activate a package on all nodes. Use the
install
commit command to make the changes persistent across designated
secure domain router shelf controller (DSDRSC) reloads.
RP/0/RSP0/CPU0:router# admin
RP/0/RSP0/CPU0:router(admin)# install activate disk0:asr9k-mpls-3.4.0 synchronous
Install operation 15 'install activate disk0:asr9k-mpls-3.4.0 synchronous'
started by user 'user_b' at 19:15:33 UTC Sat Apr 08 2006.
Info: The changes made to software configurations will not be persistent
Info: across system reloads. Use the command 'admin install commit' to make
Info: changes persistent.
Info: Please verify that the system is consistent following the software
Info: change using the following commands:
Info: show system verify
Info: install verify
Install operation 15 completed successfully at 19:16:18 UTC Sat Apr 08 2006.
RP/0/RSP0/CPU0:router(admin)# install commit
Install operation 16 'install commit' started by user 'user_b' at 19:18:58 UTC
Sat Apr 08 2006.
Install operation 16 completed successfully at 19:19:01 UTC Sat Apr 08 2006.
The following example shows
how to activate multiple software packages using the wildcard syntax:
RP/0/RSP0/CPU0:router# admin
RP/0/RSP0/CPU0:router(admin)# install activate disk0:*3.7.2*
Install operation 2 '(admin) install activate disk0:*3.7.2*' started by user
'user_a' via CLI at 04:30:01 PST Fri Dec 28 2007.
Info: This operation will activate the following packages:
Info: disk0:asr9k-rout-3.7.2
Info: disk0:asr9k-lc-3.7.2
Info: disk0:asr9k-fwdg-3.7.2
Info: disk0:asr9k-admin-3.7.2
Info: disk0:asr9k-base-3.7.2
Info: disk0:asr9k-os-mbi-3.7.2
Info: disk0:asr9k-fpd-3.7.2
Info: disk0:asr9k-diags-3.7.2
Info: disk0:asr9k-mgbl-3.7.2
Info: disk0:asr9k-mpls-3.7.2
Info: disk0:asr9k-mcast-3.7.2
Info: disk0:asr9k-k9sec-3.7.2
Warning: The following packages are already active on the specified nodes:
Warning: asr9k-os-mbi-3.7.2
Warning: asr9k-base-3.7.2
Warning: asr9k-admin-3.7.2
Warning: asr9k-fwdg-3.7.2
Warning: asr9k-lc-3.7.2
Warning: asr9k-rout-3.7.2
Warning: Please check:
Warning: - check the name of the packages being activated.
Warning: - check the set of active packages using 'show install active'.
Info: Install Method: Parallel Process Restart
Info: The changes made to software configurations will not be persistent
across system reloads. Use the command '(admin)
Info: install commit' to make changes persistent.
Info: Please verify that the system is consistent following the software
change using the following commands:
Info: show system verify
Info: install verify packages
Install operation 2 completed successfully at 04:32:01 PST Fri Dec 28 2007.
The warning messages are
expected, because the packages are already active.
Feedback