To add software
functionality to the active software set, use the
install
activate command in
Admin EXEC mode or
EXEC mode.
install activate { device: package | id add-id } [ auto-abort-timer time ] [ location node-id ] [issu] [if-active] [admin-profile] [ 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:hfr-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.
|
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.
|
|
issu
|
Performs
an in-service software upgrade.
|
admin-profile
|
(Optional.
Administration EXEC mode only) Activates the package only for the admin-plane
nodes. Admin plane nodes provide system-wide functionality and do not belong to
a specific SDR. Examples of admin-plane nodes are fabric cards and service
processor modules (SPs). The
admin-profile keyword is used to update admin-plane
resources without impacting the routing nodes in any SDRs.
|
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. Use the
if-active
keyword when SDRs have different sets of active software packages.
|
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.
-
default —You
are prompted only when input is required by the operation.
-
none —You are
never prompted.
|
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 on all SDRs 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.
Command Modes
Admin EXEC mode
EXEC mode
Command History
Release
|
Modification
|
Release 2.0
|
This
command was introduced.
|
Release 3.2
|
This
command was moved from EXEC mode to administration EXEC mode.
|
Release 3.3.0
|
Support
was added for the
SDR
sdr-name
keyword and argument.
Support
was added for the
noprompt
keyword.
|
Release 3.4.0
|
Support
was added for EXEC mode.
Support
was added for the
if-active
keyword in administration EXEC mode.
|
Release 3.5.0
|
Support
was added for the
auto-abort-timer keyword.
|
Release 3.6.0
|
Support
was added for the
prompt-level
and
parallel-reload keywords.
Support
was added for wildcard syntax when specifying packages to be activated.
Support
was removed for the
noprompt
keyword.
|
Release 3.7.0
|
Support
was added for the
id
add-id keyword and argument.
Disruption
during multiple SMU activation was reduced, requiring reloads in fewer cases.
|
Release 3.8.0
|
Support
was added for the
pause
sw-change keywords.
|
Release 4.0.0
|
This
command was removed from EXEC mode.
Support
for the
sdr keyword
was removed.
|
Release 4.1.0
|
The
auto-abort timer was changed to enabled by default. The
off keyword
was added to disable the auto-abort timer.
The
issu keyword
was added.
|
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 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 or all SDRs, 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.
The auto-abort timer is
enabled to 60 minutes by default.
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.
ISSU
Note the following
prerequisites before activating software packages using ISSU:
-
You must have at least four fabric planes installed, two odd and two even. Use the command show controller fabric plane all in administration EXEC mode to verify the number of fabric planes in your router.
RP/0/RP0/CPU0:router(admin)# show controller fabric plane all
Thu Jun 23 04:45:40.186 DST
Flags: P - plane admin down, p - plane oper down
C - card admin down, c - card oper down
A - asic admin down, a - asic oper down
L - link port admin down, l - linkport oper down
B - bundle port admin Down, b - bundle port oper down
I - bundle admin down, i - bundle oper down
N - node admin down, n - node down
X - ctrl admin down, x - ctrl down
o - other end of link down d - data down
f - failed component downstream
m - plane multicast down, s - link port permanently shutdown
t - no barrier input O - Out-Of-Service oper down
T - topology mismatch down e - link port control only
D - plane admin data down U - issu down
Plane Admin Oper up->dn up->mcast
Id State State counter counter
---------------------------------------------
0 UP UP 0 0
1 UP UP 0 0
2 UP UP 0 0
3 UP UP 0 0
4 UP UP 0 0
5 UP UP 0 0
6 UP UP 0 0
7 UP UP 0 0
-
You must have only UNIGEN flash disks installed in your system. Use the command show file disk0: in EXEC mode to verify the flash disk vendor.
RP/0/RP0/CPU0:router# show file disk0:
Thu Jun 23 04:48:59.183 DST
Model: UNIGEN FLASH
Capacity: 8215201 Sectors, Total 4206182912 Bytes, (512 Bytes/sector)
-
You must have at least 400 MB of memory available on all line cards to be upgraded.
-
You must have enough disk space for V1 and V2 images, PIEs and SMUs. This prerequisite is no different than that of a non-ISSU
upgrade.
-
Cisco recommends that you do a backup of the ASCII configuration before each upgrade.
Note the following
restrictions regarding ISSU:
-
ISSU does not work
if any of the following hardware is running in the chassis. If you have any of
these running in your system, manually shut them down before running ISSU, and
then bring them back up after ISSU is complete.
If any
non-supported hardware is running on your system, you receive an error message
similar to this one when ISSU tries to run:
RP/0/RP0/CPU0:router(admin)# install activate id 4 6 prompt-level all auto-abort timer off issu
Thu Jun 9 13:42:47.217 DST
Install operation 10 '(admin) install activate id 4 6 prompt-level all
auto-abort-timer off issu' started by user 'user1' via CLI at 13:42:48 DST
Thu Jun 09 2011.
/ 1% complete: The operation can still be aborted (ctrl-c for options)
Info: This operation will activate the following packages:
Info: disk0:hfr-mini-p-4.3.99
Info: disk0:hfr-mpls-p-4.3.99
Info: disk0:hfr-mgbl-p-4.3.99
Info: disk0:hfr-mcast-p-4.3.99
Info: disk0:hfr-k9sec-p-4.3.99
Info: disk0:hfr-fpd-p-4.3.99
Info: disk0:hfr-doc-p-4.3.99
Info: disk0:hfr-diags-p-4.3.99
/ 1% complete: The operation can still be aborted (ctrl-c for options)
Error: ISSU upgrade not supported: 'ISSU is not supported for DRP cards
-
Refer to your
release notes for a complete list of hardware that cannot be upgraded during
the ISSU process. If you have any non-supported hardware running in your
system, the upgrade process automatically shuts them down and reloads them
after the upgrade is complete.
-
Ethernet OAM flaps
after an ISSU upgrade.
-
ISSU downgrade is
not supported.
-
ISSU is not supported on the NV cluster set-up.
Task ID
Task ID
|
Operations
|
pkg-mgmt
|
execute
|
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/RP0/CPU0:router# admin
RP/0/RP0/CPU0:router(admin)# install activate disk0:?
disk0:hfr-mini-p-4.0.0 disk0:hfr-diags-p-4.0.0 disk0:hfr-mcast-p-4.0.0
disk0:hfr-mpls-p.4.0.0 disk0:hfr-k9sec-p-4.0.0 disk0:hfr-mgbl-p-4.0.0
disk0:hfr-fpd-p-4.0.0
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/RP0/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 2010.
Info: This operation will activate the following package:
Info: disk0:hfr-mcast-p-4.0.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 for all SDRs. Use the
install
commit command to make the changes persistent across DSDRSC
reloads.
RP/0/RP0/CPU0:router# admin
RP/0/RP0/CPU0:router(admin)# install activate disk0:hfr-mpls-4.0.0 synchronous
Install operation 15 'install activate disk0:hfr-mpls-p-4.0.0 synchronous'
started by user 'user_b' at 19:15:33 UTC Sat Apr 08 2010.
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 2010.
RP/0/RP0/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 2010.
The following example shows how to activate a package for
a specific SDR:
RP/0/RP0/CPU0:router(admin)# install activate disk0:hfr-mpls-p-4.0.0 SDR CE1b
Install operation 2 'install activate disk0:hfr-mpls-4.0.0
on SDR: CE1b' started by user 'user_b'
Install operation 2 'install activate disk0:hfr-mpls-4.0.0
on SDR: CE1b' started by user 'user_b' at 15:31:23 GMT Mon Nov 14 2009.
Info: SDR CE1b: Checking running configuration version compatibility with
newly activated software ...
Info: SDR CE1b: No incompatibilities found between the activated software
and router running configuration.
Info: The changes made to software configurations will not be persistent
across system reloads. Use the command 'admin 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
Install operation 2 completed successfully at 15:32:28 GMT Mon Nov 14 2009.
The following example shows how to activate a package for
multiple SDRs. To perform this operation, enter the
install
activate command with the
sdr keyword,
and list the SDR names. In this example, the SDR names are“Owner” and “user_a.”
Use the
install
commit command to make the changes persistent across DSDRSC
reloads.
RP/0/RP0/CPU0:router# admin
RP/0/RP0/CPU0:router(admin)# install activate disk0:
hfr-mcast-p-4.0.0
synchronous sdr Owner user_a
Install operation 7 '(admin) install activate disk0:hfr-mcast-p-4.0.0
synchronous sdr Owner user_a' started by user 'abc' via CLI at 11:32:29
UTC Mon Sep 25 2009.
Info: This operation will reload the following node:
Info: 0/RP0/CPU0 (RP) (SDR: Owner)
Info: This operation will reload all RPs in the Owner SDR, and
thereby indirectly cause every node in the router to reload.
Proceed with this install operation (y/n)? [y]
- 85% complete: The operation can no longer be aborted (ctrl-c for
options)[OK]ting Commit Database. Please wait...
Info: The changes made to software configurations will not be
persistent across system reloads. Use the command 'admin 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
Install operation 7 completed successfully at 11:33:08 UTC Mon Sep 25 2009.
The following example shows
how to activate multiple software packages using the wildcard syntax:
RP/0/RP0/CPU0:router# admin
RP/0/RP0/CPU0:router(admin)# install activate
disk0:*4.0*
Install operation 2 '(admin) install activate disk0:*4.0*' started
by user 'user_a' via CLI at 04:30:01 PST Fri Dec 28 2009.
Info: This operation will activate the following packages:
Info: disk0:hfr-fwdg-4.0.0
Info: disk0:hfr-admin-4.0.0
Info: disk0:hfr-fpd-4.0.0
Info: disk0:hfr-diags-p-4.0.0
Info: disk0:hfr-mgbl-4.0.0
Info: disk0:hfr-mpls-4.0.0
Info: disk0:hfr-mcast-4.0.0
Info: disk0:hfr-k9sec-4.0.0
Warning: The following packages are already active on the specified nodes:
Warning: hfr-admin-4.0.0
Warning: hfr-fwdg-4.0.0
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 2009.