Software Package Management Commands

This chapter describes the Cisco IOS XR commands used to add packages to a router storage device, activate or deactivate packages, upgrade or downgrade existing packages, and display information about packages.

For detailed information about the concepts and tasks necessary to manage Cisco IOS XR software see .

install activate

To add software functionality to the active software set, use the install activate command in System Admin EXEC mode or XR EXEC mode.

install activate {package | id add-id} [noprompt]

Syntax Description

package

Enter the package name(s) separated by space. Example: ncs6k.iso ncs6k_upgrade.iso

Note 

Multiple packages can be activated at one time. Up to 64 packages can be specified in a single install activate command. However, the number of packages is limited based on the length of the character entered. The character length should not exceed 1024.

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 64 install add operations can be specified.

noprompt

(Optional) Sets Yes to any response prompted from an install operation when this keyword is used in the command.

Note 

The command functionality remains unaltered even if the keyword is not specified.

Command Default

The install activate command can be executed without any keywords if the install prepare is already executed.

Command Modes

System Admin EXEC mode

XR EXEC mode

Command History

Release

Modification

Release 5.0.0

This command was introduced.

Release 6.1.2

Support for noprompt keyword was added.

Usage Guidelines

Use the install activate command to activate ISO images, 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.


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.

Task ID

Task ID

Operations

pkg-mgmt

execute

Examples

This example shows how to activate a package: 

sysadmin-vm:0_RP0#install activate ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i
result Wed Sep 18 05:35:06 2013 Install operation 8 (install activate) started by user 'root' will continue asynchronously.
sysadmin-vm:0_RP0# 0/3:Sep 18 00:35:09.189 : pm[1736]: %INFRA-Process_Manager-3-PROCESS_RESTART : Process slice_manager restarted
LC/0/3/CPU0:Sep 18 00:37:39.942 : npu_driver[122]: %PLATFORM-NPU-3-SW_ERROR : Slice Manager disconnect notification received, Success
sysadmin-vm:0_RP0# Wed Sep 18 05:36:10 2013 Install operation 8 completed successfully.
sysadmin-vm:0_RP0# 0/RP0:Sep 18 00:36:10.075 : inst_mgr[3768]: %INFRA-INSTMGR-6-OPERATION_SUCCESS : Install operation 8 completed successfully

install add

To copy the contents of the ISO image, package, and SMUs to the software repository, use the install add command in System Admin EXEC mode or XR EXEC mode.

install add source source-path package-name

Syntax Description

source source

Specifies the source location of the packages. The source location can be one of the following:
  • harddisk:
  • ftp://username@server:/package_path
  • tftp://package_path

package name

Enter the package name(s) separated by space. Example: tftp://server/directory/ file1 file2 file3

Command Default

Packages are added to the software repository, but are not activated.

The operation is performed in asynchronous mode. The install add command runs in the background, and the EXEC prompt is returned as soon as possible.

Command Modes

XR EXEC mode

System Admin EXEC mode

Command History

Release

Modification

Release 3.9.0

No modification.

Release 5.0.0

This command was introduced.

Release 5.0.1

Support of ftp and sftp protocols was introduced.

Usage Guidelines

Use the install add command to unpack the package software files from an ISO image, tar file, package, and SMUs and copy them to the software repository.

Task ID

Task ID

Operations

pkg-mgmt

execute

Examples

This example shows how to add a package: 

sysadmin-vm:0_RP0#install add source tftp://223.255.254.254/auto/tftp-infra/wmori/ng-install/images/40I/sysadmin-smu/ ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i.smu
result Wed Sep 18 05:06:24 2013 Install operation 3 (install add) started by user 'root' will continue asynchronously.
sysadmin-vm:0_RP0# Wed Sep 18 05:06:30 2013 Install operation 3 completed successfully.
sysadmin-vm:0_RP0# 0/RP0:Sep 18 00:06:30.471 : inst_mgr[3768]: %INFRA-INSTMGR-6-OPERATION_SUCCESS : Install operation 3 completed successfully

install commit

To save the active software set to be persistent across designated system controller (DSC) reloads, use the install commit command in System Admin EXEC mode or XR EXEC mode.

install commit [location node-id]

Syntax Description

location node-id

(Optional. System Admin EXEC mode mode only.)Specifies a node. The node-id argument is expressed in rack/ slot notation.

Command Default

System Admin EXEC mode: Commits the active software set for all SDRs.

Command Modes

System Admin EXEC mode

XR EXEC mode

Command History

Release

Modification

Release 5.2.1

This command was introduced.

Usage Guidelines

When a package is activated, it becomes part of the current running configuration. To make the package activation persistent across designated secure domain router shelf controller (DSDRSC) reloads, enter the install commit command. On startup, the DSDRSC of the SDR loads this committed software set.

If the system is restarted before the active software set is saved with the install commit command, the previously committed software set is used.

Task ID

Task ID

Operations

pkg-mgmt

read, write

Examples

The following example shows how to make the current active software set persistent across DSDRSC reloads for all SDRs in the system: 


RP/0/RP0/CPU0:router# admin 
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 2006.

install deactivate

To remove a package from the active software set, use the install deactivate command in System Admin EXEC mode or XR EXEC mode.

install deactivate {package | id add-id} [noprompt]

Syntax Description

package

Enter the package name(s) separated by space. Example: ncs6k.iso ncs6k_upgrade.iso

Note 

Multiple packages can be deactivated at one time. Up to 64 packages can be specified in a single install deactivate command. However, the number of packages is limited based on the length of the character entered. The character length should not exceed 1024.

id add-id

Specifies the ID number of an install add operation. The command deactivates 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.

noprompt

(Optional) Sets Yes to any response prompted from an install operation when this keyword is used in the command.

Note 

The command functionality remains unaltered even if the keyword is not specified.

Command Default

The install deactivate operation is performed in asynchronous mode: The command runs in the background, and the router prompt is returned as soon as possible.

Command Modes

System Admin EXEC mode

XR EXEC mode

Command History

Release

Modification

Release 3.9.0

No modification.

Release 5.0.0

This command was introduced.

Release 6.1.2

Support for noprompt keyword was added.

Usage Guidelines

Deactivating a package removes the activated package from the active software set from all nodes. 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.

The following conditions apply to software deactivation:

  • A feature package cannot be deactivated if active packages need it to operate.

Specifying Packages to Deactivate

You can either use the id add-id keyword and argument to deactivate 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.

Router Reloads

If the deactivation requires a router reload, a confirmation prompt appears.

Task ID

Task ID

Operations

pkg-mgmt

execute

Examples

This example shows how to deactivate a package: 

sysadmin-vm:0_RP0#install deactivate ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i
result Wed Sep 18 05:45:49 2013 Install operation 9 (install deactivate) started by user 'root' will continue asynchronously.
sysadmin-vm:0_RP0# LC/0/3/CPU0:Sep 18 00:48:22.153 : npu_driver[122]: %PLATFORM-NPU-3-SW_ERROR : Slice Manager disconnect notification received, Success
0/3:Sep 18 00:45:50.978 : pm[1736]: %INFRA-Process_Manager-3-PROCESS_RESTART : Process slice_manager restarted
Wed Sep 18 05:45:51 2013 Install operation 9 completed successfully.
sysadmin-vm:0_RP0# 0/RP0:Sep 18 00:45:51.260 : inst_mgr[3768]: %INFRA-INSTMGR-6-OPERATION_SUCCESS : Install operation 9 completed successfully

install remove

To delete inactive packages from the software repository, use the install remove command in System Admin EXEC orXR EXEC mode.

install remove {package | id add-id}

Syntax Description

package

Enter the package name(s) separated by space. Example: ncs6k.iso ncs6k_upgrade.iso

Note 

Multiple packages can be removed at one time. Up to 64 packages can be specified in a single install remove command. However, the number of packages is limited based on the length of the character entered. The character length should not exceed 1024.

id add-id

Specifies the ID number of an install add operation. The command deletes 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.

Command Default

The operation is performed in asynchronous mode: The install remove command runs in the background, and the EXEC prompt is returned as soon as possible.

Command Modes

System Admin EXEC

XR EXEC

Command History

Release

Modification

Release 3.9.0

No modification.

Release 5.0.0

This command was introduced.

Usage Guidelines


Note

Only inactive packages can be removed.

  • To remove all packages that were added in one or more specific install add operations, use the id add-id keyword and argument. 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.

Task ID

Task ID

Operations

pkg-mgmt

execute

Examples

This example shows how to remove a package: 

sysadmin-vm:0_RP0#install remove ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i
result Wed Sep 18 05:48:05 2013 Install operation 10 (install remove) started by user 'root' will continue asynchronously.
sysadmin-vm:0_RP0# 0/RP0:Sep 18 00:48:09.050 : inst_mgr[3768]: %INFRA-INSTMGR-6-OPERATION_SUCCESS : Install operation 10 completed successfully
Wed Sep 18 05:48:09 2013 Install operation 10 completed successfully.

install upgrade source

To upgrade the software package, use the install upgrade source command in administration EXEC mode.

install upgrade source [ftp | tftp | system-disk] [path directory-path] [file-name | version version-number | packages] [source-file] [synchronous] [pause-reload]

Syntax Description

source

Specify the source location of the PIE files to be appended to the PIE filenames. Location options are as follows:

ftp: —Copies from an FTP network server. The syntax is ftp:[[[//username [:password]@] location]/directory]/filename.

tftp: —Copies from a TFTP network server. The syntax is tftp:[[//location]/directory]/filename

system disk —Copies package source from system disk. Location options are as follows:

  • harddisk: —Copies from the hard disk drive file system (if present).

  • disk1: —Copies from disk1: file system.

path directory-path

Specify the storage device and directory for the file search. The search is performed for the specified directory and all subdirectories in that directory tree.

The syntax for directory-path is: device :[/ directory-path]

If a directory path is not specified, then the search is performed in the current directory (a path of . [dot] is assumed).

file-name

Only for TFTP, with file that contains a list of packages to be installed

Note 

Directory listing is not possible

version version-number

Specify the package version that is to be installed

packages

Specify the package names to install (packages can be tar file)

source-file

Specify the source location of the PIE files on the system

synchronous

(Optional) Performs the command in synchronous mode. This mode allows the installation process to be completed before the prompt is returned.

Note 

By default, installation operations are performed in asynchronous mode. In asynchronous mode, the command will run without expecting any user inputs while holding the prompt.

pause-reload
(Optional) Pauses the operation before any reload occurs. The configuration remains locked for the activation. This keyword precedes the following two keywords:

  • pause-reload allow-sw-change —The operation pauses before locking the configuration and provides the option to hold the operation while you perform configuration changes. You can proceed with the activation whenever you choose.

  • pause-reload disallow-sw-change —The operation pauses before reload but this will not allow you to make any configuration changes.

Note 

These keywords are applicable for asynchronous and synchronous operations. In both cases, follow onscreen instructions to control the pausing and completion of the operation.

Command Default

By default install upgrade source picks active version packages.

Command Modes

Administration EXEC

Command History

Release Modification

Release 5.3.2

This command was introduced.

Usage Guidelines

FTP

Use the following options to upgrade the system using FTP as source:

  • Only repository without version—It picks delta packages (ignoring optional packages) of the active version; that is, the difference between packages present in the file specified and packages active on the system.

  • Repository with version—It picks packages of the specified version. If a mini package of the specified version is found in the file, it will upgrade the system, provided all dependency and package compatibility checks are completed successfully.

  • Packages—Specifies the list of packages to add or upgrade the system. This option can be used to add tar files.

TFTP

Use the following options to upgrade the system using TFTP as source:

  • File-name—This option requires the package list to be provided in a file, which can then be used to upgrade the system or update the packages or SMU's. It picks delta packages (ignoring optional packages) of the active version; that is, the difference between packages present in the file specified and packages active on the system.

  • File-name with version—It picks packages of the specified version. If a mini package of the specified version is found in the file, it will upgrade the system, provided all dependency and package compatibility checks are completed successfully.

  • Packages—Specifies the list of packages to add or upgrade the system. This option can be used to add tar files.

harddisk

Use the following options to upgrade the system using harddisk as source:

  • Only repository without version—It picks delta packages (ignoring optional packages) of the active version; that is, the difference between packages present in the file specified and packages active on the system.

  • Repository with version—It picks packages of the specified version. If a mini package of the specified version is found in the file, it will upgrade the system, provided all dependency and package compatibility checks are completed successfully.

  • Packages—Specifies the list of packages to add or upgrade the system. This option can be used to add tar files.

Task ID

Task ID Operation

pkg-mgmt

execute

Examples

This example shows how to upgrade a package to 5.2.4 version with image asr9k-mini-px.pie-5.2.4 from the FTP repository, using the install upgrade source command: 

RP/0/RP0/CPU0:router#admin
RP/0/RP0/CPU0:router(admin)#install upgrade source ftp://10.10.10.10/yum_like_upgrade  asr9k-mini-px.pie-5.2.4 synchronous

This example shows how to upgrade a package to 5.3.2 version from the on-system repository, using the install upgrade source command: 

RP/0/RP0/CPU0:router#admin
RP/0/RP0/CPU0:router(admin)#install upgrade source harddisk:/images/532  version 5.3.2 synchronous
This example shows how to upgrade package to release 5.1.0 from the TFTP repository, using the install upgrade source command: 

RP/0/RP0/CPU0:router#admin
RP/0/RP0/CPU0:router(admin)# install upgrade source tftp://10.10.10.10/auto/tftpboot/userid file-name packages.txt version 5.1.0  synchronous
This example shows how to add and activate the package or SMU of active version using the install upgrade source command: 

RP/0/RP0/CPU0:router#admin
RP/0/RP0/CPU0:router(admin)# install upgrade source tftp://10.10.10.10/packages pkg1,pkg2
pkg1 is an optional package and pkg2 is a SMU. Both are active versions, but inactive on the system. The install upgrade source command checks whether the package or SMU is already inactive on system. If it is in inactive, the command skips its downloading, and adds as well as activates optional packages or SMUs along with its pre requisites.

install verify packages

To verify the consistency of a previously installed software set with the package file from which it originated, use the install verify packages command in administration EXEC mode.

Administration EXEC Mode:

install verify packages [repair] [location node-id] [admin-plane] [asynchronous | synchronous]

Syntax Description

repair

(Optional) Repairs anomalies found by the install verify packages process.

location node-id

(Optional) Verifies the consistency of previously installed software from the designated node with the package file from which it originated. The node-id argument is expressed in rack/ slot notation.

admin-plane

(Optional) Verify the admin profile only.

asynchronous

(Optional) Performs the command in asynchronous mode. In asynchronous mode, this 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.

Command Default

The operation is performed in asynchronous mode: The install verify packages command runs in the background, and the EXEC prompt is returned as soon as possible.

Command Modes

Administration EXEC

Command History

Release

Modification

Release 3.8.0

No modification.

Release 3.9.0

No modification.

Release 4.0.0

This command was removed from EXEC mode.

Support was removed for the sdr keyword.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the install verify packages command to verify the consistency of a previously installed software set with the package file from which it originated. This command can be used as a debugging tool to verify the validity of the files that constitute the packages to determine if there are any corrupted files. This command also checks for corruptions of install state files and MBI image files. This command is particularly useful when issued after the activation of a package or when upgrading the Cisco IOS XR software to a major release.


Note

The install verify packages command can take up to two minutes per package to process.

Task ID

Task ID

Operations

pkg-mgmt

execute

Examples

The following example shows how to verify the consistency of a previously installed software set with the package file from which it originated: 


RP/0/RP0/CPU0:router# install verify packages
  
Install operation 2 '(admin) install verify packages' started by user 'admin' via CLI at 07:35:01 UTC Wed May 14 2008.
Info: This operation can take up to 2 minutes per package being verified. Please be patient.
Info: 0/3/CPU0 [LC] [SDR: Owner]
Info: meta-data: [SUCCESS] Verification Successful.
Info: /install/c12k-lc-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-fwdg-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-admin-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-base-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-os-mbi-3.8.0.02I: [SUCCESS] Verification Successful.
Info: 0/SM1/SP [SP] [Admin Resource]
Info: meta-data: [SUCCESS] Verification Successful.
Info: /install/c12k-admin-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-base-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-os-mbi-3.8.0.02I: [SUCCESS] Verification Successful.
Info: 0/3/SP [SP] [Admin Resource]
Info: meta-data: [SUCCESS] Verification Successful.
Info: /install/c12k-admin-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-base-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-os-mbi-3.8.0.02I: [SUCCESS] Verification Successful.
Info: 0/RP1/CPU0 [RP] [SDR: Owner]
Info: meta-data: [SUCCESS] Verification Successful.
Info: meta-data: [SUCCESS] Verification Successful.
Info: /install/c12k-os-mbi-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-base-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-admin-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-fwdg-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-lc-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-rout-3.8.0.02I: [SUCCESS] Verification Successful.
Info: 0/RP0/CPU0 [RP] [SDR: Owner]
Info: meta-data: [SUCCESS] Verification Successful.
Info: meta-data: [SUCCESS] Verification Successful.
Info: /install/c12k-os-mbi-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-base-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-admin-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-fwdg-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-lc-3.8.0.02I: [SUCCESS] Verification Successful.
Info: /install/c12k-rout-3.8.0.02I: [SUCCESS] Verification Successful.
Info: Verification Summary:
Info: 0/3/CPU0: SUCCESSFUL. No anomalies found.
Info: 0/SM1/SP: SUCCESSFUL. No anomalies found.
Info: 0/3/SP: SUCCESSFUL. No anomalies found.
Info: 0/RP1/CPU0: SUCCESSFUL. No anomalies found.
Info: 0/RP0/CPU0: SUCCESSFUL. No anomalies found.
Info: The system needs no repair.
Install operation 2 completed successfully at 07:46:29 UTC Wed May 14 2008

show install active

To display active packages, use the show install active command in System Admin EXEC or XR EXEC mode.

show install active

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

System Admin EXEC

XR EXEC

Command History

Release

Modification

Release 3.9.0

No modification.

Release 5.0.0

This command was introduced.

Usage Guidelines

Use the show install active command to display the active software set for all nodes.

For Superceded SMUs

The show install active command doesnot display superceded SMUs. To get details of the superceded SMUs, use the show install superceded command.

Task ID

Task ID

Operations

pkg-mgmt

read

Examples

The following example illustrates sample output from the show install active command : 


sysadmin-vm:0_RP0# show install active
 Node 0/RP0 [RP]
    Boot Partition: calvados_lv0
    Active Packages: 2
       ncs6k-sysadmin-5.0.0.40I version=5.0.0.40I [Boot image]
       ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i

 Node 0/RP1 [RP]
    Boot Partition: calvados_lv0
    Active Packages: 2
       ncs6k-sysadmin-5.0.0.40I version=5.0.0.40I [Boot image]
       ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i

 Node 0/3 [LC]
    Boot Partition: calvados_lv0
    Active Packages: 2
       ncs6k-sysadmin-5.0.0.40I version=5.0.0.40I [Boot image]
       ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i
Table 1. show install active Field Descriptions

Boot Partition

Location where the node stores the active software.

Boot Image

Location on the DSC of the active minimum boot image (MBI) used to boot the node.

Active Packages

Active packages loaded on the node.

show install committed

To display committed software packages, use the show install committed command in System Admin EXEC or XR EXEC mode.

System Admin EXEC Mode

show install committed

XR EXEC Mode

show install committed

Command Modes

System Admin EXEC

XR EXEC

Command History

Release

Modification

Release 5.2.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When a software package is activated, it remains active only until the next router reload. To save the active software to be persistent across router reloads, use the install commit command.

Use the show install committed command to display the packages included in the committed software set. This is useful for verifying that the desired set of packages is committed.

Task ID

Task ID

Operations

pkg-mgmt

read

Examples

The following shows sample output from the command. Enter the show install committed command without keywords or arguments to display detailed information for all nodes in the SDR or system: 

RP/0/RP0/CPU0:router# show install committed 
Wed Oct  1 08:12:09.520 UTC
Node 0/RP0/CPU0 [RP]
    Boot Partition: xr_lv0
    Committed Packages: 2
        ncs6k-xr-5.2.1.07I version=5.2.1.07I [Boot image]
        ncs6k-5.2.1.07I.CSCxr22222-1.0.0

Node 0/1/CPU0 [LC]
    Boot Partition: xr_lv0
    Committed Packages: 2
        ncs6k-xr-5.2.1.07I version=5.2.1.07I [Boot image]
        ncs6k-5.2.1.07I.CSCxr22222-1.0.0
Table 2. show install committed Field Descriptions

Field

Description

Boot Image

Image used to boot the node.

Committed Packages

Active packages committed on the node.

show install health

To validate the status of all relevant parameters and ensure the system is ready for an upgrade, use the show install health command in administration EXEC mode.

show install health

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

Administration EXEC

Command History

Release Modification

Release 6.3.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show install health command provides the ability to check the status of all parameters before an upgrade without interrupting the system.

Task ID

Task ID Operation

pkg-mgmt

read

Examples

This example displays output from the show install health command: 


RP/0/RP0/CPU0:router(admin)# show install health
sysadmin-vm:0_RP0# show install health
Platform is: xrv9k
Collecting Cards Information
Collecting Sysadmin VMs Information
Collecting XR VMs Information
Verifying all the required VMs are running.
Pass: All required VMs are Running
Collecting sysadmin VMs data
Collecting Host data
Collecting XR VMs data
Collecting Lead VMs data
Verifying Test Plugins
Verifying Plugins results
Verifying Result for:cal_version
Verifying Result for:cal_smus
Verifying Result for:cal_local_active_swp
Verifying Result for:cal_local_committed_swp
Verifying Result for:cal_disk_space
Verifying Result for:cal_marker_files
Verifying Result for:cal_mount_points
Verifying Result for:cal_stale_symlinks
Verifying Result for:cal_prepared_packages
Verifying Result for:cal_master_active_swp
Verifying Result for:cal_master_committed_swp
Verifying Result for:xr_master_active_swp
Verifying Result for:xr_master_committed_swp
Verifying Result for:xr_local_active_swp
Verifying Result for:xr_local_committed_swp
Verifying Result for:cal_image
Verifying Result for:host_version
Verifying Result for:host_smus
Verifying Result for:xr_version
Verifying Result for:xr_smus
Verifying Result for:xr_disk_space
Verifying Result for:xr_marker_files
Verifying Result for:xr_mount_points
Verifying Result for:xr_stale_symlinks
Verifying Result for:xr_prepared_packages
**********************************************************************
System is in Consistent State. You can go ahead with next operation.
**********************************************************************
Total time taken: 6.94424414635 seconds.

show install inactive

To display the inactive packages , use the show install inactive command in System Admin EXEC or XR EXEC mode.

show install inactive

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

System Admin EXEC

XR EXEC

Command History

Release

Modification

Release 3.9.0

No modification.

Release 5.0.0

This command was introduced.

Usage Guidelines

Use the show install inactive command to display the inactive packages .


Note

Use the show install active command to determine the device used as the boot device.

Task ID

Task ID

Operations

pkg-mgmt

read

Examples

The following example shows sample output from the show install inactive command: 

 
sysadmin-vm:0_RP0# show install inactive

 Node 0/RP0 [RP]
    Inactive Packages:
       ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i
 Node 0/RP1 [RP]
    Inactive Packages:
       ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i
 Node 0/3 [LC]
    Inactive Packages:
       ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i
Table 3. show install inactive Field Descriptions
Field Description
Inactive Packages Inactive packages present on the load.

show install issu inventory

To display the status of each node and the current status of ISSU, use the show install issu inventory command in administration EXEC mode.

show install issu inventory [detail | type ism-card-type]

Syntax Description

detail

Displays detailed information about the status of each card.
type ism-card-type

displays information regarding a specific card type. ism-card-type values can be of the following:

1 —Show inventory of all Active RPs in ndsc Racks

2 —Show inventory of all Standby RPs in ndsc Racks

3 —Show inventory of all Active DRPs (any rack)

4 —Show inventory of all Standby DRPs (any rack)

5 —Show inventory of the dSC node

6 —Show inventory of the Standby dSC node

7 —Show inventory of all Active Non-root SCs

8 —Show inventory of all Standby Non-root SCs

9 —Show inventory of the Root SC

10 —Show inventory of the Root SC backup

11 —Show inventory of all LCs (any rack)

12 —Show inventory of all Non-Fabric SPs. Eg:LC, Alarm, Fan Controller SPs

13 —Show inventory of all Fabric SPs

Command Default

Summary information is displayed

Command Modes

Administration EXEC

Command History

Release Modification

Release 4.2.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show install issu inventory command displays output only when the ISSU process is running.

Task ID

Task ID Operation

pkg-mgmt

read

show install issu stage

To display the current stage of the running ISSU process, use the show install issu stage command in administration EXEC mode.

show install issu stage [detail]

Syntax Description

detail

Displays more information regarding the stage of the process.

Command Default

Displays summary information about the ISSU stage on the router.

Command Modes

Administration EXEC

Command History

Release Modification

Release 4.2.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show install issu stage command displays output only when the ISSU process is running.

Task ID

Task ID Operation

pkg-mgmt

read

Examples

This example displays output from the show install issu stage command during the load phase: 


RP/0/RP0/CPU0:router(admin)# show install issu stage

Thu Dec 8 16:09:48.397 UTC
Current State : LOAD phase done (Load phase done)
Status : 31% Completed
Participating nodes : 0
Nodes in progress : 0

show install log

To display the details of installation requests, use the show install log command in System Admin EXEC or XR EXEC mode.

show install log [install-id]

Syntax Description

install-id

(Optional) Identifier assigned to an installation operation.

Command Default

None

Command Modes

System Admin EXEC

XR EXEC

Command History

Release

Modification

Release 3.9.0

No modification.

Release 5.0.0

This command was introduced.

Usage Guidelines

Enter the show install log command with no arguments to display a summary of all installation operations, including the changes to files and the processes impacted by each request. Specify the install-id argument to display details for a specific operation.

The install-id argument is listed beside each operation in the show install log summary and is attached to messages from that operation. For example, the third installation operation has “Install 3:” attached to all its status messages.

Task ID

Task ID

Operations

pkg-mgmt

read

Examples

This example shows how to display the summary of installation requests: 
 
sysadmin-vm:0_RP0# show install log 
Sep 17 07:33:12 Admin install operation 1 started by user 'root'
Sep 17 07:33:12 install add source tftp://223.255.254.254/auto/tftp-infra/wmori/ng-install/images/40I/sysadmin-smu/ ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i.smu
Sep 17 07:33:38 Sending abort command to all nodes
Sep 17 07:33:38 Sending remove command to all nodes
Sep 17 07:33:41 Install operation 1 failed (Unable to connect to 223.255.254.254 server on node 0/RP1 where install service is running).
Sep 17 07:33:41 Ending 'install add' operation 1
Sep 17 07:39:59 Admin install operation 2 started by user 'root'
Sep 17 07:39:59 install add source tftp://223.255.254.254/auto/tftp-infra/wmori/ng-install/images/40I/sysadmin-smu/ ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i.smu
Sep 17 07:40:25 Sending abort command to all nodes
Sep 17 07:40:25 Sending remove command to all nodes
Sep 17 07:40:26 Install operation 2 failed (Unable to connect to 223.255.254.254 server on node 0/RP1 where install service is running).
Sep 17 07:40:26 Ending 'install add' operation 2
Sep 18 05:06:23 Admin install operation 3 started by user 'root'
Sep 18 05:06:23 install add source tftp://223.255.254.254/auto/tftp-infra/wmori/ng-install/images/40I/sysadmin-smu/ ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i.smu
Sep 18 05:06:30 Packages added:
Sep 18 05:06:30 ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i
Sep 18 05:06:30 Install operation 3 completed successfully.
Sep 18 05:06:30 Ending 'install add' operation 3
Sep 18 05:18:44 Admin install operation 4 started by user 'root'
Sep 18 05:18:44 install prepare ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i
Sep 18 05:18:45 Sending prepare command to all nodes
Sep 18 05:18:46 Install operation 4 completed successfully.
Sep 18 05:18:46 Ending 'install prepare' operation 4
This example shows how to display the output of show install log 7: 
 
sysadmin-vm:0_RP0# show install log 4 
Sep 18 05:18:44 Admin install operation 4 started by user 'root'
Sep 18 05:18:44 install prepare ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i
Sep 18 05:18:45 Sending prepare command to all nodes
Sep 18 05:18:46 Install operation 4 completed successfully.
Sep 18 05:18:46 Ending 'install prepare' operation 4

show install package

To display information about a package, use the show install package command in System Admin EXEC or XR EXEC mode.

show install package package-name [detail | verbose]

Syntax Description

package

Enter the package name.

detail

(Optional) Displays detailed information including impact to processes and nodes, vendor information, card support, and component information.

verbose

(Optional) Displays the information included in the keyword, plus information about dynamic link libraries (DLLs).

Command Default

None

Command Modes

System Admin EXEC

XR EXEC

Command History

Release

Modification

Release 3.9.0

No modification.

Release 5.0.0

This command was introduced.

Usage Guidelines

Use the show install package command with the detail keyword to display the version of the package, name of the manufacturer, name of the package, date and time when the package was built, and source directory where the package was built.

Use the show install package command with the verbose keyword to display the same information as the detail keyword, plus additional information about DLLs.

For additional information about the status of installed software packages, use the show install active and show install inactive commands.

Task ID

Task ID

Operations

pkg-mgmt

read

Examples

The following sample output from the show install package command lists all packages that are available on the router: 


sysadmin-vm:0_RP0# show install package
package ncs6k-sysadmin-5.0.0.40I
  Filename          : ncs6k-sysadmin
            Version           : 5.0.0.40I
            ISO Type          : calvados
            RPM count         : 23

  ISO Contents      :
      ncs6k-sysadmin-boot.all
      ncs6k-sysadmin-boot.lc
      ncs6k-sysadmin-boot.rp
      ncs6k-sysadmin-boot.sc
      ncs6k-sysadmin-fabric.all
      ncs6k-sysadmin-fabric.rp
      ncs6k-sysadmin-hostos.all
      ncs6k-sysadmin-hostos.rp
      ncs6k-sysadmin-mgbl.all
      ncs6k-sysadmin-mgbl.lc
      ncs6k-sysadmin-mgbl.rp
      ncs6k-sysadmin-mgbl.sc
      ncs6k-sysadmin-platform.all
      ncs6k-sysadmin-platform.lc
      ncs6k-sysadmin-platform.rp
      ncs6k-sysadmin-platform.sc
      ncs6k-sysadmin-shared.all
      ncs6k-sysadmin-shared.lc
      ncs6k-sysadmin-shared.rp
      ncs6k-sysadmin-system.all
      ncs6k-sysadmin-system.lc
      ncs6k-sysadmin-system.rp
      ncs6k-sysadmin-topo.all

show install request

To display the list of incomplete installation requests, running and queued, use the show install request command in System Admin EXEC or XR EXEC mode.

show install request

Syntax Description

This command has no keywords or arguments.

Command Default

None

Command Modes

System Admin EXEC

XR EXEC

Command History

Release

Modification

Release 3.9.0

No modification.

Release 5.0.0

This command was introduced.

Usage Guidelines

The software processes only one installation request at a time. The show install request command displays any incomplete request that is currently running.


Note

The default of installation commands is asynchronous mode, meaning that the command runs in the background and the EXEC prompt is returned as soon as possible.

Task ID

Task ID

Operations

pkg-mgmt

read

Examples

The following example shows sample output from the show install request command: 


sysadmin-vm:0_RP0# show install request
Wed Sep  18 05:35:49.102 UTC
 User root, Op Id 8
 install activate
 ncs6k-sysadmin-5.0.0.40I.CSCui84128-0.0.9.i

The following example shows sample output from the show install request command when no installation operations are running: 

 
sysadmin-vm:0_RP0# show install request
 No install operation in progress

show issu-warm-reload control-protocol trace

To display control protocol trace data about the ongoing process of an in-service software upgrade (ISSU), use the show issu-warm-reload control-protocol trace command in EXEC mode.

show issu-warm-reload control-protocol trace data-type type {all | error | information | packet} [hexdump] [last n] [reverse] [stats] [tailf] [unique] [verbose] [wrapping] [file filename original]

Syntax Description

data-type

The type of data to display. Valid options are:

  • all —Displays all trace data.

  • chdlc —Displays Cisco High-Level Data Link Control (cHDLC) Serial Line Address Resolution Protocol (SLARP) data.

  • control-io —Displays control input-output (I/O) data.

  • ipv6nd —Displays IPv6 ND data.

  • lacp —Displays Link Aggregation Control Protocol (LACP) data.

  • platform —Displays platform data.

  • ppp —Displays PPP data.

all, chdlc, control-io, ipv6nd, lacp,
type

Specifies the format of trace data to display.
all

Displays error, information and packet traces.
error

Displays error traces.
information

Displays information traces.
packet

Displays packet traces.
hexdump

(Optional) Displays traces in hexadecimal format.

last n

(Optional) Displays the last n number of traces only.

reverse

(Optional) Displays the most recent traces first.

stats

(Optional) Displays execution path statistics.

tailf

(Optional) Displays new traces as they are added.

unique

(Optional) Displays unique entries only, along with the count of the number of times this entry appears.

verbose

(Optional) Displays additional internal debugging information.

wrapping

(Optional) Displays wrapping entries.

file filename original

(Optional) Specifies the filename of the file to display. You can specify up to four trace files.

Command Default

None.

Command Modes

EXEC

Command History

Release Modification

Release 4.2.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The show issu-warm-reload control-protocol trace command only provides information while the ISSU process is running. After the installation is complete, no information is provided.

Task ID

Task ID Operation

system

read

show zapdisk locations

To display location information where zapdisk operation is supported, use the show zapdisk locations command in XR EXEC mode.

show zapdisk locations

This command has no keywords or arguments.

Command Default

None

Command Modes

XR EXEC mode

Command History

Release

Modification

Release 7.0.1

This command was introduced.

Usage Guidelines

No specific guidelines impact the use of this command.

Task ID

Task ID

Operations

diag

read

Examples

The following example shows sample output from the show zapdisk locations command: 


RP/0/RP0/CPU0:router# show context
  
0/RSP1     Fully qualified location specification
0/7        Fully qualified location specification
0/4        Fully qualified location specification
all        all locations

zapdisk start location

To erase data from the disk memory of RSPs and line cards, use the zapdisk start location command in XR EXEC mode.

zapdisk start location node-id

Syntax Description

location { node-id | all}

Specify the location string obtained from the show zapdisk location command.

Zapdisk can be executed for specific node location or all node locations.

Command Default

Disabled.

Command Modes

XR EXEC mode

Command History

Release

Modification

Release 7.0.1

This command was introduced.

Usage Guidelines

After the command is executed, the card is shut down. Do not reload the card.


Caution

This command should not be used during normal operation of the router. The command should be used only when you have planned to delete the data from the card during return material authorization (RMA).

Task ID

Task ID

Operations

diag

read, write

Examples

The following example shows how to erase data from the line card location 0/4: 

Router# zapdisk start location 0/4
Action on designated location is in progress, more detail logs will be located in sysadmin at
/misc/disk1/tftpboot/zapdisk.log once action is completed

zapdisk set

To enable the zapdisk feature, use the zapdisk set command in the System Admin EXEC mode.


Note
When the zapdisk feature is enabled on a CPU board, the following events will not trigger zapdisk functions:

  • Reload the board using CLI.

  • Perform a physical Online Insertion and Removal (OIR) on the board.

  • Reload the router.

zapdisk set

Syntax Description

This command has no keywords or arguments.

Command Default

No default behavior or values

Command Modes

System Admin EXEC

Command History

Release Modification

Release 6.3.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

root-system

execute

Examples

The following example shows how to use the zapdisk set command: 


sysadmin-vm:0_RP0# zapdisk set
Fri Jul  21 22:32:29.242 UTC
result Zapdisk set command success

zapdisk unset

To disable zapdisk feature, use the zapdisk unset command in the System Admin EXEC mode.

zapdisk unset

Syntax Description

This command has no keywords or arguments.

Command Default

No default behavior or values

Command Modes

System Admin EXEC

Command History

Release Modification

Release 6.3.1

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID Operation

root-system

execute

Examples

The following example shows how to disable zapdisk feature on all CPU boards on the router:


sysadmin-vm:0_RP0# zapdisk unset
Fri Jul  21 22:32:29.242 UTC
result Zapdisk unset command success