Perform System Upgrade and Install Feature Packages

You can execute the system upgrade and package installation processes using the install commands on NCS 1004. The processes involve adding and activating the ISO images (.iso) and feature packages (.rpm) on NCS 1004. You can accesss these files from a network server and then activate on NCS 1004. If the installed package or SMU causes any issue, you can uninstall it.


Note

We recommend that you collect the output of show tech-support ncs1004 command before performing operations such as a reload or CPU OIR on NCS 1004. The command provides information about the state of the system before reload or before the CPU OIR operation is performed. This information is useful in debugging.


Note

The output of the examples in the procedures is not from the latest software release. The output will change for any explicit references to the current release.

The topics covered in this chapter are:

Software and firmware compatibility matrix

Use these tables to determine which FPGA firmware version corresponds to each hardware type for a given software release. Cross-reference these values before planning a software upgrade or downgrade.


Note

FPGA firmware compatibility is not applicable for NCS1K-FTA.
Table 1. FPGA firmware compatibility for R7.x.x

Hardware type

FPGA

R7.0.0

R7.0.1

R7.1.1

R7.1.2

R7.2.1

R7.3.1

R7.3.2

R7.5.1

R7.5.2

R7.7.1

R7.8.1

R7.9.1

R7.10.1
NCS1K4-1.2T-L-K9 LC_CPU_MOD_FW 70.00 70.10

11.49

71.23

72.10

73.10

73.20

75.10

75.20

77.10

78.10

 79.10 80.10
LC_OPT_MOD_FW 1.06 1.09

1.13

1.14

1.15

1.18

1.25

1.25

1.25

1.36

1.36

 1.36 1.38
NCS1K4-1.2T-K9 LC_CPU_MOD_FW 70.00 70.10

11.49

71.23

72.10

73.10

73.20

75.10

75.20

77.10

78.10

 79.10 80.10
LC_OPT_MOD_FW 1.06 1.09

1.13

1.14

1.15

1.18

1.25

1.25

1.25

1.36

1.36

 1.36 1.38
NCS1K4-2-QDD-C-K9 LC_CPU_MOD_FW NA NA NA NA NA 73.10

73.20

75.10

75.20

77.10

78.10

 79.10 80.10
LC_OPT_MOD_FW NA NA NA NA NA

1.18

1.26

1.26

1.26

1.36

1.36

 1.36 1.38
NCS1K4-2-QDD-CK9L LC_CPU_MOD_FW NA NA NA NA NA NA NA NA NA NA NA 80.10 80.10
LC_OPT_MOD_FW NA NA NA NA NA NA NA NA NA NA NA 1.36 1.36
NCS1K4- 1.2TL-K9 LC_CPU_MOD_FW NA NA NA NA

72.10

73.10

73.20

75.10

75.20

77.10

78.10

 79.10 80.10
LC_OPT_MOD_FW NA NA NA NA

1.15

1.18

1.25

1.25

1.25

1.25

1.25

 1.25 1.38
NCS1K4- OTN-XP LC_CPU_MOD_FW NA NA NA NA

72.10

73.10

73.20

75.10

75.20

77.10

78.10

79.10

 80.10
LC_DP_MOD_FW NA NA NA NA

6.10

10.10

11.10

11.10

12.10

12.10

12.10

 12.10 14.10
Sub-type

10G-GREY-MXP

40x10G-4x100G-MXP
LC_DP_MOD_FW NA NA NA NA

6.10

10.10

11.10

11.10

 11.10 11.10 11.10 12.10 12.10
Sub-type

4x100G-MXP-400G-TXP
LC_DP_MOD_FW NA NA NA NA NA NA

4.10

3.10

 3.10 3.10 3.10 3.10 3.10
LC_DP_MOD_FW NA NA NA NA NA NA

4.10

3.10

 4.10 4.10 4.10 4.10 4.10
Sub-type

400GE-TXP-DD
LC_DP_MOD_FW NA NA NA NA NA NA NA NA 2.10 2.10 2.10 3.10 3.10
Sub-type

FC-MXP

OTUCn-REGEN
LC_DP_MOD_FW NA NA NA NA NA NA NA NA NA NA 1.10 1.10 1.10
Sub-type

2x100GE-TXP-MXP
LC_CFP2_PORT_0 NA NA NA NA NA 1.10 1.52 1.52 1.60 1.60 1.60 1.60 1.46
LC_CFP2_PORT_0 NA NA NA NA NA NA NA NA NA NA 38.27397 38.27397 38.27397
Sub-type

2x100GE-TXP-MXP
LC_CFP2_PORT_1 NA NA NA NA NA 1.10 1.52 1.52 1.60 1.60 1.40 1.40 1.46
LC_QSFPDD_PORT_9 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 61.2013 61.2221 61.2221 61.2332 61.2332 61.2332
LC_QSFPDD_PORT_11 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 61.2013 61.2221 61.2221 61.2332 61.2332 61.2332
NCS1K4-QXP-K9 LC_CPU_MOD_FW NA NA NA NA NA NA NA NA NA 77.10 78.10 79.10 100.20
LC_QSFPDD_PORT_0 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 61.2221 61.2332 61.2332 61.2332
LC_QSFPDD_PORT_2 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 61.2221 61.2332 61.2332 61.2332
LC_QSFPDD_PORT_4 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 61.2221 61.2332 61.2332 61.2332
LC_QSFPDD_PORT_6 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 61.2221 61.2332 61.2332 61.2332
LC_QSFPDD_PORT_8 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 61.2221 61.2332 61.2332 61.2332
LC_QSFPDD_PORT_10 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 61.2221 61.2332 61.2332 61.2332
LC_QSFPDD_PORT_0 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.12014
LC_QSFPDD_PORT_10 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.12014
LC_QSFPDD_PORT_14 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.12014
LC_QSFPDD_PORT_4 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.13011 70.12014
NCS1004 BP_FPGA 1.25 1.25 1.25 1.25 1.25 1.25 1.25 1.25 1.25 1.25 1.25 1.25 1.25
XGE_FLASH 18.04 18.04 18.04 18.04 18.04 18.04 18.04 18.04 18.04 18.04 18.04 18.04 18.04
Table 2. FPGA firmware compatibility for controller card for R7.x.x

Hardware type

FPGA

R7.0.0

R7.0.1

R7.1.1

R7.1.2

R7.2.1

R7.3.1

R7.3.2

R7.5.1

R7.5.2

R7.7.1

R7.8.1

R7.9.1

R7.10.1
NCS1K4-CNTLR-K9 BIOS 4.10 4.20

4.20

4.30

4.30

4.70

5.06

5.30

5.50

 5.80 5.80 5.80 5.90
CSB_IMG 0.200 0.200

0.200

0.200

0.200

0.200

0.200

0.200

0.200

 0.200 0.200 0.200 0.200
TAM_FW 36.08 36.08

36.08

36.08

36.08

36.08

36.08

36.08

36.08

 36.08 36.08 36.08 36.08
CPU_FPGA 1.14 1.14

1.14

1.14

1.14

1.14

1.14

1.14

1.14

 1.14 1.14 1.14 1.14
CPU_SSD NA NA NA NA NA NA NA NA

75.00

 75.00 75.00 75.00 75.00
POWMAN_CFG NA NA NA NA NA NA NA NA

3.40

3.40

3.40

 3.40 3.40
NCS1K4-CNTLR-B-K9 CPU_SSD NA NA NA NA NA NA NA NA NA 1.00 1.00 1.00 1.00
Table 3. FPGA firmware compatibility for power supply unit for R7.x.x

Hardware type

FPGA

R7.0.0

R7.0.1

R7.1.1

R7.1.2

R7.2.1

R7.3.1

R7.3.2

R7.5.1

R7.5.2

R7.7.1

R7.8.1

R7.9.1

R7.10.1
NCS1K4-2KW-AC PO-PriMCU 2.70

2.70

2.70

2.70

2.70

2.70

2.70

2.70

2.70

2.70

2.70

 2.70 2.70
NCS1K4-AC-PSU PO-PriMCU 2.70 2.70

2.70

2.70

2.70

2.70

2.70

2.70

2.70

2.70

2.70

 2.70 2.70
NCS1K4-DC-PSU PO-PriMCU 1.12 1.12

1.12

1.12

1.12

1.12

1.12

1.12

1.12

1.12

1.12

 1.12 1.12
Table 4. FPGA firmware compatibility for R24.x.x, R25.x.x, and R26.x.x

Hardware type

FPGA

R24.1.1

R24.3.1

R25.3.1

R25.4.1

R26.1.1
NCS1K4-1.2T-L-K9 LC_CPU_MOD_FW 241.10 243.10 253.10 254.100

261.1
LC_OPT_MOD_FW 1.38 1.38 1.38 1.38 1.38
NCS1K4-1.2T-K9 LC_CPU_MOD_FW 241.10 243.10 253.10 254.100

261.1
LC_OPT_MOD_FW 1.38 1.38 1.38 1.38 1.38
NCS1K4-2-QDD-C-K9 LC_CPU_MOD_FW 241.10 243.10 253.10 254.100

261.1
LC_OPT_MOD_FW 1.38 1.38 1.38 1.38 1.38
NCS1K4-2-QDD-CK9L LC_CPU_MOD_FW 241.10 243.10 253.10 254.100

261.1
LC_OPT_MOD_FW 1.38 1.38 1.38 1.38 1.38
NCS1K4- 1.2TL-K9 LC_CPU_MOD_FW 241.10 243.10 253.10 254.100

261.1
LC_OPT_MOD_FW 1.38 1.38 1.38 1.38 1.38
NCS1K4- OTN-XP LC_CPU_MOD_FW 241.10 243.10 253.10 254.100

261.1
LC_DP_MOD_FW 3.10 15.10 17.10 17.10 17.10
Sub-type

10G-GREY-MXP

40x10G-4x100G-MXP
LC_DP_MOD_FW 12.10 12.10 14.10 14.10 14.10
Sub-type

4x100G-MXP-400G-TXP
LC_DP_MOD_FW 12.10 3.10 3.10 3.10 3.10
LC_DP_MOD_FW 4.10 4.10 4.10 4.10 4.10
Sub-type

400GE-TXP-DD
LC_DP_MOD_FW 5.10 5.10 7.10 7.10 7.10
Sub-type

FC-MXP

OTUCn-REGEN
LC_DP_MOD_FW 1.10 1.10 1.10 1.10 1.10
Sub-type

2x100GE-TXP-MXP
LC_CFP2_PORT_0 1.46 1.80 1.80 1.80 1.46
LC_CFP2_PORT_0 38.27397 38.27397 38.27397 38.27397 38.27397
Sub-type

2x100GE-TXP-MXP
LC_CFP2_PORT_1 1.46 1.46 1.46 1.46 1.46
LC_QSFPDD_PORT_9 61.2332 61.2332 61.2332 61.2332 61.2332
LC_QSFPDD_PORT_11 61.2332 61.2332 61.2332 61.2332 61.2332
NCS1K4-QXP-K9 LC_CPU_MOD_FW

241.10

 243.10 243.10 243.10 261.10
LC_QSFPDD_PORT_0 70.13011 70.13011 70.13011 70.13011 70.13011
LC_QSFPDD_PORT_2 70.13011 70.13011 70.13011 70.13011 70.13011
LC_QSFPDD_PORT_4 61.2332 70.13011 70.13011 70.13011 70.13011
LC_QSFPDD_PORT_6 61.2332 61.2332 61.2332 61.2332 70.13011
LC_QSFPDD_PORT_8 61.2332 61.2332 61.2332 61.2332 70.13011
LC_QSFPDD_PORT_10 61.2332 61.2332 61.2332 61.2332 70.13011
LC_QSFPDD_PORT_0 70.13011 70.13011 70.13011 70.13011 70.13011
LC_QSFPDD_PORT_10 70.13011 70.13011 70.13011 70.13011 70.13011
LC_QSFPDD_PORT_14 70.13011 70.13011 70.13011 70.13011 70.13011
LC_QSFPDD_PORT_4 70.13011 70.13011 70.13011 70.13011 70.13011
NCS1004 BP_FPGA 1.25 1.25 1.25 1.25 1.25
XGE_FLASH 18.04 18.04 18.04 18.04 18.04
Table 5. FPGA firmware compatibility for controller card for R24.x.x, R25.x.x, and R26.x.x

Hardware type

FPGA

R24.1.1

R24.3.1

R25.3.1

R25.4.1

R26.1.1
NCS1K4-CNTLR-K9 BIOS 6.20 6.40 7.00 7.20 7.20
CSB_IMG 0.200 0.200 0.200 0.200 0.200
TAM_FW 36.08 36.08 36.08 36.08 36.08
CPU_FPGA 1.14 1.14 1.14 1.14 1.14
CPU_SSD 75.00 75.00 75.00 75.00 120
POWMAN_CFG 3.40 3.40 3.40 3.40 3.40
NCS1K4-CNTLR-B-K9 CPU_SSD 1.00 1.00 1.00 1.00 1.00
Table 6. FPGA firmware compatibility for power supply unit for R24.x.x , R25.x.x,and R26.x.x

Hardware type

FPGA

R24.1.1

R24.3.1

R25.3.1

R25.4.1

R26.1.1
NCS1K4-2KW-AC PO-PriMCU 2.70 2.70 2.70 2.70 2.70
NCS1K4-AC-PSU PO-PriMCU 2.70 2.70 2.70 2.70 2.70
NCS1K4-DC-PSU PO-PriMCU 1.12 1.12 1.12 1.12 1.12

System upgrade

A system upgrade is a maintenance procedure that

  • replaces the Cisco IOS XR operating system image with a newer version,

  • upgrades both the XR and the System Admin operating systems simultaneously, and

  • initiates the process from XR mode using install commands.

System upgrade installs the base package, which includes the Cisco IOS XR Core Bundle and Manageability Package. Install the ISO image using install commands.

Additional reference information

For more information on upgrading the system and the RPMs, see Cisco IOS XR Flexible Packaging Configuration Guide for Cisco NCS 1000 Series.


Note

  • Software downgrade from Release 7.2.1 to Release 7.1.1 affects traffic.

  • Before you upgrade from Release 7.3.1 and later, or downgrade to Release 7.3.1 and earlier, configure minimum and maximum values for chromatic dispersion (CD) on the trunk optical controller of the OTN-XP card to maintain traffic flow. Use the controller optics R/S/I/P [cd-max cd-max | cd-min cd-min] command to configure minimum and maximum chromatic dispersion values. See Command Reference for Cisco NCS 1004 for the range of CD values.


Note

From Release 25.4.1, to run the install replace command for a software upgrade, if a public IP address is connected to management port 1, you must configure linux networking for management port 1.

This is a sample Linux networking configuration on management port 1.


linux networking
 vrf default
  address-family ipv4
   default-route software-forwarding
   source-hint management-route interface MgmtEth0/RP0/CPU0/1
   source-hint default-route interface MgmtEth0/RP0/CPU0/1
 !

View supported software upgrade or downgrade versions

Determine which release versions NCS 1004 supports for upgrade or downgrade from the currently running release, validate a specific source-to-target release path before attempting the upgrade, and configure health checks to automatically verify system readiness before and after installation.

Table 7. Feature History Table

Feature Name

Release Information

Description

Supported Software Upgrade or Downgrade IOS XR Versions

 Cisco IOS XR Release 7.5.1

You can determine whether a software version can be upgraded or downgraded to another version using this functionality. Before an actual upgrade or downgrade process, you can also view the hardware or software limitations that could cause the upgrade or downgrade to fail. This feature helps you plan successful software upgrades or downgrades.

This feature introduces the show install upgrade-matrix command.

Table 8. Feature History

Feature Name

Release Information

Feature Description

Pre and Post-Upgrade Install Health Checks using Profile

Cisco IOS XR Release 7.8.1

This feature allows you to create profiles that define the actions performed during pre and post-upgrade installation checks. You can configure the default actions for:

  • Pre-upgrade check failure

  • Upgrade failure

  • Revert after post-installation check failure

Use the show install upgrade-matrix command to list all releases from which the currently running release can be reached by a direct upgrade or downgrade.

Use the show install upgrade-matrix from release-version command to validate whether a specific release-to-release path is supported. The command output shows YES if the path is supported and NO if it is not.


Note

The show install upgrade-matrix command is available from Release 7.9.1. The from keyword option is available from Release 7.10.1.

Procedure

Step 1

Use the show install upgrade-matrix command to list all supported upgrade and downgrade paths from the currently running release.

Example:

RP/0/RP0/CPU0:ios#show install upgrade-matrix
Fri Aug 18 11:25:15.571 UTC
Upgrade Matrix for ncs1004-mini-x-7.10.1 image:
    From Release    Upgrade    Downgrade
    7.9.1             YES       NO
    7.10.1            YES       YES
    24.1.1            NO        YES

Step 2

Use the show install upgrade-matrix from release-version command to validate whether a specific release-to-release upgrade or downgrade path is supported.

Example:

RP/0/RP0/CPU0:ios#show install upgrade-matrix from 7.9.1
Fri Aug 18 11:27:50.215 UTC
From Release 7.9.1:
    To 7.10.1:  Upgrade supported: YES
                Downgrade supported: NO

The command output shows YES if the path is supported and NO if it is not.

You have verified the supported upgrade and downgrade paths for NCS 1004.

List all supported paths

This example shows the supported upgrade and downgrade paths for the currently running release.

RP/0/RP0/CPU0:ios#show install upgrade-matrix
Fri Aug 18 11:25:15.571 UTC
Upgrade Matrix for ncs1004-mini-x-7.10.1 image:
    From Release    Upgrade    Downgrade
    7.9.1             YES       NO
    7.10.1            YES       YES
    24.1.1            NO        YES

Validate a specific path

This example validates whether an upgrade from Release 7.9.1 to the current running release is supported.

RP/0/RP0/CPU0:ios#show install upgrade-matrix from 7.9.1
Fri Aug 18 11:27:50.215 UTC
From Release 7.9.1:
    To 7.10.1:  Upgrade supported: YES
                Downgrade supported: NO

show install upgrade-matrix from (unsupported path)

This example shows the output when the specified upgrade path is not supported.

RP/0/RP0/CPU0:ios#show install upgrade-matrix from 7.6.1
Fri Aug 18 11:30:22.415 UTC
From Release 7.6.1:
    To 7.10.1:  Upgrade supported: NO
                Downgrade supported: NO
Info: Direct upgrade or downgrade between 7.6.1 and 7.10.1 is not supported.
      Please upgrade via intermediate release.

show install upgrade-matrix for Release 24.x.x

RP/0/RP0/CPU0:ios#show install upgrade-matrix
Fri Aug 18 11:25:15.571 UTC
Upgrade Matrix for ncs1004-mini-x-24.1.1 image:
    From Release    Upgrade    Downgrade
    7.10.1            YES       NO
    24.1.1            YES       YES
    24.2.1            NO        YES

Software upgrade and downgrade matrix

Use this table to determine the release versions of NCS 1004 that support direct upgrade or downgrade. Cross-reference the source and target release versions before planning a software upgrade or downgrade.

Table 9. NCS 1004 software upgrade and downgrade matrix

Upgrade Path

Downgrade Path

Source Release

Destination Release

Source Release

Destination Release

  • R7.3.2

  • R7.5.1

  • R7.5.2

  • R7.7.1

  • R7.8.1

  • R7.9.1

R7.10.1

R7.10.1

  • R7.9.1

  • R7.8.1

  • R7.7.1

  • R7.5.2

  • R7.5.1

  • R7.3.2

  • R7.8.1

  • R7.9.1

  • R7.10.1

  • R24.1.1

R24.3.1

R24.3.1

  • R24.1.1

  • R7.10.1

  • R7.9.1

  • R7.8.1

  • R25.3.1

  • R24.3.1

  • R24.1.1

  • R71.0.1

  • R7.9.1

  • R7.8.1

  • R7.7.1

R25.4.1

R25.4.1

  • R25.3.1

  • R24.3.1

  • R24.1.1

  • R71.0.1

  • R7.9.1

  • R7.8.1

  • R7.7.1

  • R25.4.1

  • R25.3.1

  • R24.3.1

  • R24.1.1

  • R7.10.1

  • R7.9.1

  • R7.8.1

  • R7.3.2

R26.1.1

R26.1.1

  • R25.4.1

  • R25.3.1

  • R24.3.1

  • R24.1.1

  • R7.10.1

  • R7.9.1

  • R7.8.1

  • R7.3.2

NCS 1004 software packages

A package is a software component that

  • installs a specific set of NCS 1004 features or functions,

  • follows the naming convention <platform>-<pkg>-<pkg version>-<release version>.<architecture>.rpm, and

  • can be installed individually or as part of an SMU patch.

Standard packages for NCS 1004

This table lists the standard packages available for NCS 1004.

Table 10. Standard packages for NCS 1004

Feature set

Filename

Description

Composite Package

Cisco IOS XR Core Bundle + Manageability Package

ncs1004-mini-x-24.1.1.iso

Contains required core packages, such as the operating system, Admin, Base, Forwarding, SNMP Agent, FPD, Alarm Correlation, NETCONF-YANG, Telemetry, XML parser, and HTTP server packages.

Individually Installable Optional Packages

Cisco IOS XR Security Package

ncs1004-k9sec-1.0.0.0-r2411.x86_64.rpm

Provides support for encryption, decryption, IP Security (IPsec), Secure Socket Layer (SSL), and public key infrastructure (PKI).

OpenROADM

ncs1004-tp-sw-1.0.0.0-r2411.x86_64.rpm

To configure OpenROADM, install the ncs1004-tp-sw-1.0.0.0-r732.rpm package.

OTN-XP

ncs1004-sysadmin-otn-xp-dp-24.1.1-r2411.x86_64.rpm

Install this package on the OTN-XP card to bring up the system with the OTN-XP card.

Pre and post-upgrade installation health checks

ncs1004-healthcheck-1.0.0.0-r2411.x86_64.rpm

Install this package to configure health checks before and after upgrades.

Install and uninstall workflow

The install and uninstall workflow is an ordered sequence of operations that

  • adds, activates, and commits packages during installation, and

  • deactivates, removes, and commits packages during uninstallation.

Related procedures

To install a package, see Install packages. To uninstall a package, see Uninstall packages. Each topic includes a flowchart depicting the workflow for that operation.

Install packages

Complete this task to upgrade the system or install a patch. You can perform the system upgrade using an ISO image file and the patch installation using packages and SMUs. This task also enables you to install .tar files. The .tar file contains multiple packages and SMUs merged into a single file. A single .tar file can contain up to sixty four individual files. The packaging format defines one RPM per component, without dependency on card type.


Note

To install a System Admin package or an XR package, run the install commands in System Admin EXEC mode or XR EXEC mode respectively. All the install commands are applicable in both these modes.


Note

Two FPDs (Field-Programmable Devices) are available for the OTN-XP card: LC_CPU_MOD_FW and LC_DP_MOD_FW. LC_CPU_MOD_FW is available as part of the boot ISO image. Install the ncs1004-sysadmin-otn-xp-dp-*.rpm data path FPD package on the OTN-XP line card using this procedure to bring up the system with the OTN-XP card.

This flowchart demonstrates the process for installing the package.

Figure 1. Installing packages workflow
Installing packages workflow

Before you begin

  • Configure and connect to the management port. You can access the installable file through the management port. For information about configuring the management port, see Configure the management interface.

  • Copy the package to be installed either to the NCS 1004 hard disk or to a network server that NCS 1004 can access.

  • When the ncs1004-k9sec package is not installed, use only FTP or TFTP to copy files or during the install add operation.

Procedure

Step 1

Use one of these commands to add the package to the repository.

  • install add source <tftp transfer protocol>/package_path/ filename1 filename2 ...
  • install add source <ftp or sftp transfer protocol>//user@server:/package_path/ filename1 filename2 ...

Example:

RP/0/RP0/CPU0:ios#install add source harddisk: ncs1004-mini-x-7.2.1 ncs1004-k9sec-2.1.0.0-r721.x86_64.rpm
Thu Feb  7 11:10:51.867 UTC
Feb 07 11:10:53 Install operation 25 started by root:
 install add source harddisk: ncs1004-mini-x-7.2.1 ncs1004-k9sec-2.1.0.0-r721.x86_64.rpm
Feb 07 11:10:55 Install operation will continue in the background
Thu Feb  7 11:10:51 Install operation 25 finished successfully

Add the respective packages as appropriate. This command unpacks software files from the package and adds them to the software repository. The operation runs in asynchronous mode — the install add command runs in the background and the EXEC prompt is returned immediately.

Note

 

Install operation over IPv6 is not supported.

Step 2

(Optional) Use the show install request command to display the operation ID of the add operation and its status.

Example:

RP/0/RP0/CPU0:ios#show install request

You can use the operation ID later to run the activate command.

Step 3

Use the show install repository command to display packages added to the repository.

Example:

RP/0/RP0/CPU0:ios#show install repository
6 package(s) in XR repository:
    ncs1004-mini-x-7.0.1
    ncs1004-mini-x-7.2.1
    ncs1004-mpls-2.0.0.0-r711
    ncs1004-k9sec-2.1.0.0-r721.x86_64
    ncs1004-xr-7.2.1
    ncs1004-mpls-te-rsvp-2.1.0.0-r711

Packages appear only after the install add operation is complete.

Step 4

Use the show install inactive command to display inactive packages present in the repository.

Example:

RP/0/RP0/CPU0:ios#show install inactive
6 inactive package(s) found:
    ncs1004-mini-x-7.0.1
    ncs1004-mini-x-7.2.1
    ncs1004-mpls-2.0.0.0-r711
    ncs1004-k9sec-2.1.0.0-r721.x86_64
    ncs1004-xr-7.2.1
    ncs1004-mpls-te-rsvp-2.1.0.0-r711

You can activate only inactive packages.

Step 5

Use the install activate package_name command to set the package configurations to active on NCS 1004.

Example:

RP/0/RP0/CPU0:ios#install activate ncs1004-mini-x-7.2.1 ncs1004-k9sec-2.1.0.0-r721.x86_64
Thu Feb  7 11:25:09.229 UTC
Feb 07 11:25:10 Install operation 26 started by root:
  install activate pkg ncs1004-mini-x-7.2.1 ncs1004-k9sec-2.1.0.0-r721.x86_64
Feb 07 11:25:10 Package list:
Feb 07 11:25:10     ncs1004-mini-x-7.2.1 ncs1004-k9sec-2.1.0.0-r721.x86_64
Feb 07 11:25:17 Install operation will continue in the background
Feb 07 11:25:10 Install operation 26 finished successfully

New features and software fixes take effect. This operation runs in asynchronous mode. The install activate command runs in the background, and the EXEC prompt is returned.

Note

 

To activate an RPM of a lower version after a higher version is already active, use the force option. You can do this in two ways:

  • Add the RPM with the lower version to the repository and then force the activation: 
    install add source repository ncs1004-xr-7.2.1
install activate ncs1004-xr-7.2.1 force
  • Use the install update command: 
    install update source repository ncs1004-xr-7.2.1

If you use the operation ID, all the packages added in the specified operation are activated together. For example, if five packages are added in operation 8, running install activate id 8 activates all five packages together.

Step 6

Use the show install active command to display packages that are active.

Example:

RP/0/RP0/CPU0:ios#show install active
Mon Mar 11 07:31:12.302 UTC
Node 0/RP0/CPU0 [RP]
  Boot Partition: xr_lv19
  Active Packages: 5
    ncs1004-mini-x-7.2.1
    ncs1004-mpls-2.0.0.0-r711
    ncs1004-k9sec-2.1.0.0-r721.x86_64
    ncs1004-xr-7.2.1
    ncs1004-mpls-te-rsvp-2.1.0.0-r711

Step 7

Use the install commit system command to commit the newly active software.

Example:

RP/0/RP0/CPU0:ios#install commit system
Thu Feb  7 11:34:04.207 UTC
Feb 07 11:34:05 Install operation 27 started by root:
  install commit system
Feb 07 11:34:06 Install operation will continue in the background
Feb 07 11:34:19 Install operation 27 finished successfully

Note

 

If you perform a manual or automatic system reload without completing the transaction with the install commit command during a system update, the system reverts to its state prior to the install transaction, including any configuration changes. Only the log is preserved for debugging. This action clears all configuration rollback points. You cannot roll back to or view any commits made before the install rollback event. New commits made after the install rollback event start from commit ID "1000000001".

Table 11. Install packages: related commands

Related command

Purpose

show install log

Displays the log information for the install process. Use this information for troubleshooting in case of installation failure.

show install package

Displays the details of the packages added to the repository. Use this command to identify individual components of a package.

install prepare

Makes preactivation checks on an inactive package to prepare it for activation.

show install prepare

Displays the list of packages that have been prepared and are ready for activation.

The packages are installed, activated, and committed on NCS 1004. New features and fixes become available, and the repository displays the active and inactive packages.

What to do next

  • After performing a system upgrade, upgrade FPDs using the upgrade hw-module location all fpd all command from Cisco IOS XR mode. Monitor the FPD upgrade progress using the show hw-module fpd command.

  • Reload NCS 1004 if BIOS, BP_SSD, and CPU_SSD are in RLOAD REQ state. Use the hw-module location 0/RP0 reload command.

  • Verify the installation using the install verify packages command.

  • Uninstall the packages or SMUs if their installation causes issues on NCS 1004. See Uninstall packages.


Note

ISO images cannot be uninstalled. However, you can perform a system downgrade by installing an older ISO version.

Install prepared packages

Complete this task to upgrade the system and install packages by using the prepare operation.

You can perform a system upgrade or feature upgrade by activating the ISO image file, packages, and SMUs. It is possible to prepare these installable files before activation. During the preparation phase, preactivation checks are made. The system also loads the components of the installable files onto the NCS 1004 setup. The preparation process runs in the background, and NCS 1004 is fully usable during this time. When the prepare phase completes, the prepared files are activated instantaneously.

The advantages of preparing before activation are:

  • If the installable file is corrupted, the preparation process fails, providing an early warning. A corrupted file that is activated directly may cause NCS 1004 to malfunction.

  • Directly activating an ISO image takes considerable time, and NCS 1004 is unavailable during this period. If you prepare the image first, it runs asynchronously. When you activate the prepared image, activation takes less time, which reduces downtime.

Procedure

Step 1

Add the required ISO image and packages to the repository.

For more information, see Install packages.

Step 2

Use the show install repository command to verify that the required installable files are available in the repository.

Example:

RP/0/RP0/CPU0:ios#show install repository
Fri Mar 15 11:31:53.352 IST
12 package(s) in XR repository:
    ncs1004-mpls-1.0.0.0-r241146I.x86_64
    ncs1004-k9sec-1.0.0.0-r2411.x86_64
    ncs1004-xr-24.1.1.46I
    ncs1004-healthcheck-1.0.0.0-r241146I.x86_64
    ncs1004-mpls-te-rsvp-1.0.0.0-r2411.x86_64
    ncs1004-xr-24.1.1
    ncs1004-mini-x-24.1.1.46I
    ncs1004-mpls-1.0.0.0-r2411.x86_64
    ncs1004-mini-x-24.1.1
    ncs1004-healthcheck-1.0.0.0-r2411.x86_64
    ncs1004-k9sec-1.0.0.0-r241146I.x86_64
    ncs1004-mpls-te-rsvp-1.0.0.0-r241146I.x86_64

Packages appear only after the install add operation is complete.

Step 3

Use one of these commands to prepare the packages:

  • install prepare package_name
  • install prepare id operation_id

Example:

RP/0/RP0/CPU0:ios#install prepare ncs1004-mini-x-7.2.1 ncs1004-k9sec-2.1.0.0-r721.x86_64

Or

RP/0/RP0/CPU0:ios#install prepare id 8

The preparation process runs in asynchronous mode. The install prepare command runs in the background and the EXEC prompt is returned.

If you use the operation ID, all packages added in the specified operation are prepared together. For example, if five packages are added in operation 8, running install prepare id 8 prepares all five packages together.

Step 4

Use the show install prepare command to verify that all the required packages appear in the output.

Example:

RP/0/RP0/CPU0:ios#show install prepare

Step 5

Use the install activate package_name command to activate the prepared packages.

Example:

RP/0/RP0/CPU0:ios#install activate ncs1004-mini-x-7.2.1 ncs1004-k9sec-2.1.0.0-r721.x86_64

All prepared packages are activated together. This action applies the package configurations on NCS 1004.

Step 6

Use the show install active command to display the packages that are active.

Step 7

Use the install commit system command to commit the recently activated software.

Example:

RP/0/RP0/CPU0:ios#install commit system
Table 12. Install prepared packages: related commands

Related command

Purpose

show install log

Displays the log information for the install process. Use this information for troubleshooting in case of install failure.

show install package

Displays the details of the packages added to the repository. Use this command to identify individual components of a package.

install prepare clean

Clears the prepare operation and removes the packages from the prepared state.

Prepared packages are activated immediately with minimal downtime. The system detects any corrupted files before activation to prevent issues.

What to do next

  • After performing a system upgrade, upgrade FPDs using the upgrade hw-module location all fpd all command from Cisco IOS XR mode. Monitor the FPD upgrade progress using the show hw-module fpd command.

  • Reload NCS 1004 if BIOS, BP_SSD, and CPU_SSD are in RLOAD REQ state. Use the hw-module location 0/RP0 reload command.

  • Verify the installation using the install verify packages command.

  • Uninstall the packages or SMUs if their installation causes issues on NCS 1004. See Uninstall packages.


Note

ISO images cannot be uninstalled. However, you can perform a system downgrade by installing an older ISO version.

Uninstall packages

Complete this task to uninstall a package when you want to remove features or revert a patch.

Packages added in XR mode cannot be uninstalled from System Admin mode, and the other way round.


Note

Installed ISO images cannot be uninstalled. Additionally, kernel SMUs that install a third-party SMU on host, XR mode, and System Admin mode cannot be uninstalled. However, a subsequent installation of an ISO image or kernel SMU overwrites the existing installation.

This flowchart demonstrates how to uninstall a package.

Figure 2. Uninstalling packages workflow
Uninstalling packages workflow

Procedure

Step 1

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

Example:

RP/0/RP0/CPU0:ios#show install active
Mon Mar 11 07:31:12.302 UTC
Node 0/RP0/CPU0 [RP]
  Boot Partition: xr_lv19
  Active Packages: 5
    ncs1004-mini-x-7.2.1
    ncs1004-mpls-2.0.0.0-r711
    ncs1004-k9sec-2.1.0.0-r721.x86_64
    ncs1004-xr-7.1.1
    ncs1004-mpls-te-rsvp-2.1.0.0-r711

You can deactivate only active packages.

Step 2

Use one of these commands to deactivate the package:

  • install deactivate package_name
  • install deactivate id operation_id

Example:

RP/0/RP0/CPU0:ios#install deactivate ncs1004-k9sec-2.1.0.0-r721.x86_64

Or

RP/0/RP0/CPU0:ios#install deactivate id 8

All features and software patches associated with the package are deactivated. You can specify multiple package names to deactivate them simultaneously.

If you use the operation ID, all packages added in the specified operation are deactivated together. You do not have to deactivate the packages individually.

Step 3

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

Example:

RP/0/RP0/CPU0:ios#show install inactive
Mon Mar 11 08:07:46.504 UTC
1 inactive package(s) found:
    ncs1004-k9sec-2.1.0.0-r721.x86_64

The deactivated packages are now listed as inactive packages. You can remove only inactive packages from the repository.

Step 4

Use the install remove package_name command to remove the inactive packages from the repository.

Example:

RP/0/RP0/CPU0:ios#install remove ncs1004-k9sec-2.1.0.0-r721.x86_64

Use the install remove command with the id operation-id keyword and argument to remove all packages added for the specified operation ID.

Step 5

Use the install commit system command to commit the newly active software.

Example:

RP/0/RP0/CPU0:ios#install commit system

Step 6

Use the show install repository command to display the packages available in the repository.

Example:

RP/0/RP0/CPU0:ios#show install repository
Mon Mar 11 08:11:55.780 UTC
4 package(s) in XR repository:
     ncs1004-xr-7.2.1 version=7.2.1 [Boot image]
     ncs1004-mini-x-7.2.1
     ncs1004-mpls-2.0.0.0-r711
     ncs1004-mpls-te-rsvp-2.1.0.0-r711

The removed package does not appear in the output.

The selected package and its associated features or patches are fully deactivated and removed from the NCS 1004 software repository.

What to do next

Install the required packages. See Install packages.

FPD automatic upgrade

FPD automatic upgrade is a system capability that

  • upgrades FPD firmware versions of all the components to the latest version along with software activation,

  • ensures all the FPD components show CURRENT status after the software upgrade, and

  • retains the upgraded FPD version even when the software image is rolled back to the original version.

From Release 7.9.1, FPD automatic upgrade is enabled by default. You can manually disable it using the fpd auto-upgrade disable command. Before upgrading from a release earlier than Release 7.9.1 to Release 7.9.1, clear any existing FPD configuration using the no fpd auto-upgrade command to ensure that the automatic upgrade is active after the upgrade.

Feature history

Table 13. Feature history

Feature name

Release information

Feature description

Automatic FPD upgrade

Cisco IOS XR Release 7.9.1

The automatic FPD upgrade functionality is now enabled by default. It upgrades the FPD components' firmware version to the latest version. This enhancement eliminates the need to explicitly enable the functionality using the fpd auto-upgrade enable command. As a result, the software upgrade is simplified, and the system always maintains the latest state of the FPD firmware version.


Note

From Release 25.4.1, the automatic FPD upgrade process is supported in 1.2T, 1.2TL, QDD, and QXP line cards. It is not supported in the OTN-XP line card.


Note

FPD automatic upgrade is supported for the BP_SSD and CPU_SSD FPDs only if the SSDs are programmed with the latest firmware. FPD automatic upgrade for BP_SSD and CPU_SSD works without manual intervention when upgrading from Release 7.5.2 to a later release. If upgrading from a release earlier than Release 7.5.2 to Release 7.5.2, SSDs use the old firmware. In this scenario, manually upgrade BP_SSD and CPU_SSD FPDs, even if FPD automatic upgrade is enabled.


Note

FPD automatic upgrade is not supported on the LC_DP_MOD_FW FPD of the OTN-XP card because the upgrade affects traffic.

Note

FPD automatic upgrade is not supported for POWMAN_CFG. During a system upgrade to Release 7.5.2 or a later release, manually upgrade POWMAN_CFG if it is not running the latest version. Manually upgrading POWMAN_CFG does not affect traffic.

Enable FPD automatic upgrade

Enable FPD automatic upgrade so that FPD firmware components are upgraded to the latest version during software activation. This eliminates manual intervention.

Procedure

Step 1

Use the fpd auto-upgrade enable command to enable FPD automatic upgrade.

Example:


RP/0/RP0/CPU0:ios# configure
RP/0/RP0/CPU0:ios(config)# fpd auto-upgrade enable
RP/0/RP0/CPU0:ios(config)# commit
RP/0/RP0/CPU0:ios(config)# end

Step 2

Use the show running-config | inc fpd command to verify whether FPD automatic upgrade is enabled.

Example:


RP/0/RP0/CPU0:ios# show running-config | inc fpd
Thu Feb  7 10:43:44.822 UTC
Building configuration...
fpd auto-upgrade enable

The output confirms that FPD automatic upgrade is enabled when fpd auto-upgrade enable appears in the running configuration.

FPD automatic upgrade is enabled. During the next software activation, all supported FPD components are upgraded automatically and display the CURRENT status in the show hw-module fpd output.

show hw-module fpd output with FPD automatic upgrade enabled

This example shows all the FPDs in CURRENT status after a software upgrade with FPD automatic upgrade enabled.

RP/0/RP0/CPU0:ios# show hw-module fpd
Mon Nov 11 16:25:24.365 UTC
Auto-upgrade: Enabled
                                                                         FPD Versions
                                                                        ==============
Location   Card type             HWver FPD device       ATR Status    Running   Programd
-----------------------------------------------------------------------------------------
0/0        NCS1K4-1.2T-K9        2.0   LC_CPU_MOD_FW        CURRENT   240.44    240.44
0/0        NCS1K4-1.2T-K9        1.0   LC_OPT_MOD_FW        CURRENT     1.38      1.38
0/1        NCS1K4-1.2TL-K9       2.0   LC_CPU_MOD_FW        CURRENT   240.44    240.44
0/1        NCS1K4-1.2TL-K9       1.0   LC_OPT_MOD_FW        CURRENT     1.38      1.38
0/RP0      NCS1K4-CNTLR-K9       5.0   CSB_IMG           S  CURRENT     0.260     0.200
0/RP0      NCS1K4-CNTLR-K9       5.0   TAM_FW               CURRENT    36.08     36.08
0/RP0      NCS1K4-CNTLR-K9       3.14  BIOS              S  CURRENT     6.60      6.60
0/RP0      NCS1K4-CNTLR-K9       1.4   BP_SSD               CURRENT   130.00    130.00
0/RP0      NCS1K4-CNTLR-K9       5.0   CPU_FPGA             CURRENT     3.14      3.14
0/RP0      NCS1K4-CNTLR-K9       1.4   CPU_SSD              CURRENT   130.00    130.00
0/RP0      NCS1K4-CNTLR-K9       3.18  POWMAN_CFG           CURRENT     3.40      3.40
0/PM0      NCS1K4-AC-PSU         0.1   PO-PriMCU            CURRENT     2.70      2.70
0/SC0      NCS1004               2.0   BP_FPGA              CURRENT     1.25      1.25
0/SC0      NCS1004               2.0   XGE_FLASH            CURRENT    18.04     18.04

Manual POWMAN_CFG upgrade during FPD automatic upgrade

FPD automatic upgrade does not support POWMAN_CFG. If POWMAN_CFG displays NEED UPGD after a software upgrade, perform a manual upgrade. The provided output shows the show hw-module fpd command results before the manual upgrade. 

RP/0/RP0/CPU0:ncs1004-129# show hw-module fpd
Tue Nov 21 15:55:27.689 UTC
Auto-upgrade: Disabled
                                                                         FPD Versions
                                                                        ==============
Location   Card type             HWver FPD device       ATR Status    Running   Programd
-----------------------------------------------------------------------------------------
0/0        NCS1K4-2-QDD-C-K9     1.0   LC_CPU_MOD_FW        NEED UPGD  80.10     80.10
0/0        NCS1K4-2-QDD-C-K9     1.0   LC_OPT_MOD_FW        CURRENT     1.38      1.38
0/2        NCS1K4-1.2TL-K9       3.0   LC_CPU_MOD_FW        CURRENT    75.20     75.20
0/2        NCS1K4-1.2TL-K9       1.0   LC_OPT_MOD_FW        CURRENT     1.38      1.38
0/3        NCS1K4-1.2TL-K9       3.0   LC_CPU_MOD_FW        CURRENT    75.20     75.20
0/3        NCS1K4-1.2TL-K9       1.0   LC_OPT_MOD_FW        CURRENT     1.38      1.38
0/RP0      NCS1K4-CNTLR-K9       5.0   CSB_IMG           S  CURRENT     0.200     0.200
0/RP0      NCS1K4-CNTLR-K9       5.0   TAM_FW               CURRENT    36.08     36.08
0/RP0      NCS1K4-CNTLR-K9       1.14  BIOS              S  CURRENT     5.50      5.50
0/RP0      NCS1K4-CNTLR-K9       5.4   BP_SSD               CURRENT    75.00     75.00
0/RP0      NCS1K4-CNTLR-K9       5.0   CPU_FPGA             CURRENT     1.14      1.14
0/RP0      NCS1K4-CNTLR-K9       5.4   CPU_SSD              CURRENT    75.00     75.00
0/RP0      NCS1K4-CNTLR-K9       3.18  POWMAN_CFG           CURRENT     3.40      3.40
0/PM0      NCS1K4-DC-PSU         0.1   PO-PriMCU            CURRENT     1.12      1.12
0/PM1      NCS1K4-DC-PSU         0.1   PO-PriMCU            CURRENT     1.12      1.12
0/SC0      NCS1004               2.0   BP_FPGA              CURRENT     1.25      1.25
0/SC0      NCS1004               2.0   XGE_FLASH            CURRENT    18.04     18.04

To upgrade POWMAN_CFG manually:

  1. Initiate the FPD upgrade:

    RP/0/RP0/CPU0:ios# upgrade hw-module location 0/RP0 fpd POWMAN_CFG

    POWMAN_CFG moves to RLOAD REQ state:

    0/RP0      NCS1K4-CNTLR-K9       3.18  POWMAN_CFG           RLOAD REQ   2.50      2.50

  2. Reload the route processor (RP) to complete the upgrade:

    sysadmin-vm:0_RP0# hw-module location 0/RP0 reload noprompt

    After reload, POWMAN_CFG shows CURRENT status and the upgrade is complete.

NCS 1004 SSD FPD upgrade support

SSD FPD upgrade support is a capability that

  • enables the chassis SSD FPD (BP_SSD) and controller SSD FPD (CPU_SSD) to be upgraded to newer firmware versions, and

  • reports a NOT READY status in the show hw-module fpd output for SSD FPDs when the system runs a release earlier than the one that first qualified each SSD model.

If you run the show hw-module fpd command in releases earlier than those supporting each chassis SSD (BP_SSD) and controller SSD (CPU_SSD), the output displays NOT READY for the STATUS column of BP_SSD and CPU_SSD. The NOT READY status does not affect the FPD's function.

SSD FPD status in supported and unsupported releases

These examples show how the show hw-module fpd command output differs depending on whether the running release supports the installed SSD model.

SSD FPD status in a supported release

Command
RP/0/RP0/CPU0:ios#show hw-module fpd

In this output, the STATUS of BP_SSD and CPU_SSD is CURRENT, indicating that the chassis and controller SSD FPDs are running the current release firmware.

Output
Wed Jun 4 05:37:09.037 UTC

Auto-upgrade: Enabled
                                                                         FPD Versions
                                                                        ==============
Location   Card type             HWver FPD device       ATR Status    Running   Programd
-----------------------------------------------------------------------------------------
0/0        NCS1K4-2-QDD-C-K9     1.0   LC_CPU_MOD_FW         CURRENT    80.10     80.10
0/0        NCS1K4-2-QDD-C-K9     1.0   LC_OPT_MOD_FW         CURRENT     1.38      1.38
0/1        NCS1K4-2-QDD-C-K9     1.0   LC_CPU_MOD_FW         CURRENT    80.10     80.10
0/1        NCS1K4-2-QDD-C-K9     1.0   LC_OPT_MOD_FW         CURRENT     1.38      1.38
0/RP0      NCS1K4-CNTLR-B-K9     4.0   CSB_IMG            S  CURRENT     0.200     0.200
0/RP0      NCS1K4-CNTLR-B-K9     4.0   TAM_FW                CURRENT    36.08     36.08
0/RP0      NCS1K4-CNTLR-B-K9     1.14  BIOS               S  RLOAD REQ   4.70      4.70
0/RP0      NCS1K4-CNTLR-B-K9     5.4   BP_SSD                CURRENT    75.00     75.00
0/RP0      NCS1K4-CNTLR-B-K9     4.0   CPU_FPGA              CURRENT     1.14      1.14
0/RP0      NCS1K4-CNTLR-B-K9     5.4   CPU_SSD               CURRENT    75.00     75.00
0/RP0      NCS1K4-CNTLR-B-K9     3.18  POWMAN_CFG            CURRENT     3.40      3.40
0/PM1      NCS1K4-AC-PSU         0.1   PO-PriMCU             CURRENT     2.70      2.70
0/SC0      NCS1004               2.0   BP_FPGA               CURRENT     1.25      1.25
0/SC0      NCS1004               2.0   XGE_FLASH             CURRENT    18.04     18.04

SSD FPD status in an unsupported release

Command
RP/0/RP0/CPU0:ios#show hw-module fpd

In this output, the STATUS of BP_SSD and CPU_SSD is NOT READY, indicating that the chassis and controller SSD FPDs are running firmware from an unsupported release.

Output
Wed Jun  4 05:37:09.037 UTC

Auto-upgrade:Enabled
                                                                         FPD Versions
                                                                        ==============
Location   Card type             HWver FPD device       ATR Status    Running   Programd
-----------------------------------------------------------------------------------------
0/0        NCS1K4-2-QDD-C-K9     1.0   LC_CPU_MOD_FW         CURRENT    80.10     80.10
0/0        NCS1K4-2-QDD-C-K9     1.0   LC_OPT_MOD_FW         CURRENT     1.38      1.38
0/1        NCS1K4-2-QDD-C-K9     1.0   LC_CPU_MOD_FW         CURRENT    80.10     80.10
0/1        NCS1K4-2-QDD-C-K9     1.0   LC_OPT_MOD_FW         CURRENT     1.38      1.38
0/RP0      NCS1K4-CNTLR-B-K9     4.0   CSB_IMG            S  CURRENT     0.200     0.200
0/RP0      NCS1K4-CNTLR-B-K9     4.0   TAM_FW                CURRENT    36.08     36.08
0/RP0      NCS1K4-CNTLR-B-K9     1.14  BIOS               S  RLOAD REQ   4.70      4.70
0/RP0      NCS1K4-CNTLR-B-K9     0.0   BP_SSD                NOT READY              0.00
0/RP0      NCS1K4-CNTLR-B-K9     4.0   CPU_FPGA              CURRENT     1.14      1.14
0/RP0      NCS1K4-CNTLR-B-K9     0.0   CPU_SSD               NOT READY              0.00
0/RP0      NCS1K4-CNTLR-B-K9     3.18  POWMAN_CFG            CURRENT     3.40      3.40
0/PM1      NCS1K4-AC-PSU         0.1   PO-PriMCU             CURRENT     2.70      2.70
0/SC0      NCS1004               2.0   BP_FPGA               CURRENT     1.25      1.25
0/SC0      NCS1004               2.0   XGE_FLASH             CURRENT    18.04     18.04

Verify SSD model name and release

Ensure the installed SSD model is qualified for firmware upgrade in the target release by checking its model and firmware version.

Before upgrading SSD FPDs, you must verify that your SSD model and firmware are supported for upgrade in the target release. Compare your results with the SSD FPD upgrade matrix to confirm compatibility.

Procedure

Step 1

Use the admin command to enter the administrator mode.

Example:


RP/0/RP0/CPU0:ios#admin
Wed Jun  4 11:47:09.156 UTC
Last login: Thu May 29 11:59:29 2025 from 192.0.0.4

root connected from 192.0.0.4 using ssh on sysadmin-vm:0_RP0
sysadmin-vm:0_RP0#

Step 2

Use the show smart-monitor | inc "SmartCtl|\Model:|\Firm" command to check the SSD model name and firmware version.

Example:

sysadmin-vm:0_RP0#show smart-monitor | inc "SmartCtl|\Model:|\Firm"

The output displays the SSD model name and firmware version. The SmartCtl info for sda block provides the controller SSD FPD information. The SmartCtl info for sdb block provides the chassis SSD FPD information.

Output example
Tue Jun 24 06:44:19.927 UTC
======== SmartCtl info for sda ========
Device Model:     Micron_5100_MTFDDAK240TCB
Firmware Version: D0MU075
======== SmartCtl info for sdb ========
Device Model:     Micron_5100_MTFDDAV240TCB
Firmware Version: D0MU075

Step 3

Verify the SSD model name against the release in which the upgrade is supported in the SSD FPD upgrade matrix.

You have verified whether the installed SSD model and firmware on NCS 1004 are eligible for FPD upgrade in your target release.

SSD FPD upgrade matrix

Use these tables to determine which SSD models are qualified for FPD upgrade and the minimum Cisco IOS XR release required. Cross-reference the SSD model name you identified using the Verify SSD model name and release procedure.

Table 14. Upgrade matrix for controller SSD FPDs

SSD model name

FPD version

FPD upgrade supported from release

SOLIDIGM SSDSC2KB240GZ

130

25.x.x and later

Micron_5400_MTFDDAK240TGA

0.2

24.1.1

INTEL SSDSC2KB240GZ

120

7.10.1, 24.1.1

INTEL SSDSC2KB240GZ

111

7.10.1

INTEL SSDSC2KB240G8

132

7.5.2

Micron_5100_MTFDDAK240TCB

51

7.5.2

Micron_5300_MTFDDAK240TDS

0.1

7.5.2
Table 15. Upgrade matrix for chassis SSD FPDs

SSD model name

FPD version

FPD upgrade supported from release

SOLIDIGM SSDSCKKB240GZ

130

25.x.x and later

Micron_5400_MTFDDAV240TGA

0.2

24.1.1

INTEL SSDSCKKB240GZ

120

7.10.1, 24.1.1

INTEL SSDSCKKB240GZ

111

7.10.1

INTEL SSDSCKKB240G8

132

7.5.2

Micron_5100_MTFDDAV240TCB

51

7.5.2

Micron_5300_MTFDDAV240TDS

0.1

7.5.2

Upgrade firmware

You must upgrade the FPD firmware of the route processor and the line cards after upgrading to the latest software release. This task also provides instructions for upgrading the FPD firmware of SSDs located on the chassis SSD (BP_SSD) and the route processor SSD (CPU_SSD). This upgrade is supported from R7.5.2.

Table 16. Feature history

Feature name

Release information

Feature description

FPD upgrade support for SSDs

Cisco IOS XR Release 7.5.2

The FPDs of the SSDs on the chassis and on the route processor can now be upgraded. This feature allows you to maintain the FPD versions of SSDs with the latest firmware, including enhancements and bug fixes. If an FPD upgrade is required, the One Or More FPDs Need Upgrade Or Not In Current State alarm is raised on the route processor.


Note

The Provisioning In Progress alarm is raised on the slice or line card during the FPD upgrade and automatically clears after the upgrade completes. This alarm does not affect traffic.


Note

Follow this sequence to upgrade the FPDs of the OTN-XP card:

  1. LC_CPU_MOD_FW

  2. LC_DP_MOD_FW

  3. LC_CFP2_PORT_<0/1>

From Release 7.5.2, the FPDs of the SSDs on the chassis and the route processor can be upgraded. FPD upgrades of BP_SSD and CPU_SSD do not impact traffic.

Procedure

Step 1

Use the show hw-module fpd command to check the status of the FPDs.

Verify the status of the FPDs of the line cards in these examples.

Example:

RP/0/RP0/CPU0:ios# show hw-module fpd                                          
Fri May 29 11:17:52.980 UTC                                                                                                                                   
                                                               FPD Versions                                                                                   
                                                               =================                                                                              
Location   Card type             HWver FPD device       ATR Status   Running Programd                                                                         
-----------------------------------------------------------------------------------                                                                           
0/0        NCS1K4-1.2T-K9        2.0   LC_CPU_MOD_FW        CURRENT   21.19   21.19                                                                           
0/0        NCS1K4-1.2T-K9        1.0   LC_OPT_MOD_FW        CURRENT    2.04    2.04                                                                           
0/1        NCS1K4-OTN-XP         3.0   LC_CPU_MOD_FW        NEED UPGD 21.18   21.18                                                                           
0/1        NCS1K4-OTN-XP         3.0   LC_DP_MOD_FW         CURRENT    6.10    6.10                                                                           
0/2        NCS1K4-OTN-XP         3.0   LC_CPU_MOD_FW        NEED UPGD 21.18   21.18                                                                           
0/2        NCS1K4-OTN-XP         3.0   LC_DP_MOD_FW         CURRENT    6.10    6.10                                                                           
0/3        NCS1K4-OTN-XP         3.0   LC_CPU_MOD_FW        NEED UPGD 21.18   21.18                                                                           
0/3        NCS1K4-OTN-XP         3.0   LC_DP_MOD_FW         CURRENT    6.10    6.10                                                                           
0/RP0      NCS1K4-CNTLR-K9       4.0   CSB_IMG           S  CURRENT    0.200   0.200                                                                          
0/RP0      NCS1K4-CNTLR-K9       4.0   TAM_FW               CURRENT   36.08   36.08                                                                           
0/RP0      NCS1K4-CNTLR-K9       1.14  BIOS              S  CURRENT    4.30    4.30                                                                           
0/RP0      NCS1K4-CNTLR-K9       4.0   CPU_FPGA             CURRENT    1.14    1.14                                                                           
0/PM0      NCS1K4-DC-PSU         0.1   PO-PriMCU            CURRENT    1.12    1.12                                                                           
0/PM1      NCS1K4-DC-PSU               PO-PriMCU            NOT READY                                                                                         
0/SC0      NCS1004               2.0   BP_FPGA              CURRENT    1.25    1.25                                                                           
0/SC0      NCS1004               2.0   XGE_FLASH            CURRENT   18.04   18.04

From R7.5.2, you can verify the status of the FPDs of the SSDs in this example.

Example:

RP/0/RP0/CPU0:ios# show hw-module fpd
Thu Oct  7 12:44:43.532 UTC

Auto-upgrade:Disabled
                                                                 FPD Versions                                                                                   
                                                               =================                                                                              
Location   Card type             HWver FPD device       ATR Status   Running Programd                                                                         
----------------------------------------------------------------------------------- 
0/0        NCS1K4-2-QDD-C-K9     1.0   LC_CPU_MOD_FW        CURRENT    21.31     21.31 
0/0        NCS1K4-2-QDD-C-K9     1.0   LC_OPT_MOD_FW        CURRENT     1.26      1.26    
0/1        NCS1K4-2-QDD-C-K9     0.0   LC_CPU_MOD_FW        CURRENT    21.31     21.31    
0/1        NCS1K4-2-QDD-C-K9     1.0   LC_OPT_MOD_FW        CURRENT     1.26      1.26    
0/2        NCS1K4-2-QDD-C-K9     1.0   LC_CPU_MOD_FW        CURRENT    21.31     21.31    
0/2        NCS1K4-2-QDD-C-K9     1.0   LC_OPT_MOD_FW        CURRENT     1.26      1.26    
0/3        NCS1K4-2-QDD-C-K9     0.0   LC_CPU_MOD_FW        CURRENT    21.31     21.31    
0/3        NCS1K4-2-QDD-C-K9     1.0   LC_OPT_MOD_FW        CURRENT     1.26      1.26    
0/RP0      NCS1K4-CNTLR-K9       4.0   CSB_IMG           S  CURRENT     0.200     0.200   
0/RP0      NCS1K4-CNTLR-K9       4.0   TAM_FW               CURRENT    36.08     36.08    
0/RP0      NCS1K4-CNTLR-K9       1.14  BIOS              S  CURRENT     5.30      5.30    
0/RP0      NCS1K4-CNTLR-K9       5.4   BP_SSD               NEED UPGD  71.00     71.00    
0/RP0      NCS1K4-CNTLR-K9       4.0   CPU_FPGA             CURRENT     1.14      1.14    
0/RP0      NCS1K4-CNTLR-K9       5.4   CPU_SSD              NEED UPGD  71.00     71.00    
0/PM1      NCS1K4-AC-PSU         0.1   PO-PriMCU            NEED UPGD   2.51      2.51    
0/SC0      NCS1004               2.0   BP_FPGA              CURRENT     1.25      1.25    
0/SC0      NCS1004               2.0   XGE_FLASH            CURRENT    18.04     18.04

Step 2

Use the upgrade hw-module command to upgrade the FPDs.

Example:

This example shows how to upgrade the FPD image of a line card. 

RP/0/RP0/CPU0:ios# upgrade hw-module location all fpd all

This command upgrades the FPDs of line cards. The FPD upgrade process for line cards may take three to five minutes. After the upgrade, the device automatically reloads. When the process completes, all FPDs, including BIOS, display the CURRENT status.

Example:

From R7.5.2, this example shows how to upgrade the FPD image of BP_SSD. 

RP/0/RP0/CPU0:ios# upgrade hw-module location 0/RP0 fpd BP_SSD

Example:

From R7.5.2, this example shows how to upgrade the FPD image of CPU_SSD. 

RP/0/RP0/CPU0:ios# upgrade hw-module location 0/RP0 fpd CPU_SSD

Step 3

Use the show hw-module fpd command to verify the FPD status after the upgrade.

Example:

RP/0/RP0/CPU0:ios# show hw-module fpd   
Fri May 29 11:30:24.492 UTC

Auto-upgrade:Disabled
                                                                         FPD Versions
                                                                        ==============
Location   Card type             HWver FPD device       ATR Status    Running   Programd  
-----------------------------------------------------------------------------------------
0/0       NCS1K4-2-QDD-C-K9 1.0   LC_CPU_MOD_FW              CURRENT    21.31     21.31    
0/0       NCS1K4-2-QDD-C-K9 1.0   LC_OPT_MOD_FW              CURRENT     1.26      1.26    
0/1       NCS1K4-2-QDD-C-K9 0.0   LC_CPU_MOD_FW              CURRENT    21.31     21.31    
0/1       NCS1K4-2-QDD-C-K9 1.0   LC_OPT_MOD_FW              CURRENT     1.26      1.26    
0/2       NCS1K4-2-QDD-C-K9 1.0   LC_CPU_MOD_FW              CURRENT    21.31     21.31    
0/2       NCS1K4-2-QDD-C-K9 1.0   LC_OPT_MOD_FW              CURRENT     1.26      1.26    
0/3       NCS1K4-2-QDD-C-K9 0.0   LC_CPU_MOD_FW              CURRENT    21.31     21.31    
0/3       NCS1K4-2-QDD-C-K9 1.0   LC_OPT_MOD_FW              CURRENT     1.26      1.26    
0/RP0     NCS1K4-CNTLR-K9   1.14  BIOS              S        RLOAD REQ   5.10      5.10    
0/RP0     NCS1K4-CNTLR-K9   5.4   BP_SSD                     RLOAD REQ   71.00     71.00    
0/RP0     NCS1K4-CNTLR-K9   4.0   CPU_FPGA                   CURRENT      1.14      1.14    
0/RP0     NCS1K4-CNTLR-K9   5.4   CPU_SSD                    RLOAD REQ   71.00     71.00    
0/PM1     NCS1K4-AC-PSU     0.1   PO-PriMCU                  CURRENT      2.70      2.70    
0/SC0     NCS1004           2.0   BP_FPGA                    CURRENT     1.25      1.25    
0/SC0     NCS1004           2.0   XGE_FLASH                  CURRENT    18.04     18.04

Step 4

Use the hw-module location 0/RP0 reload command to reload NCS 1004 if FPDs show RLOAD REQ status.

After reload, verify the FPD status. If the upgrade fails, the status shows UPGD_FAIL. If the upgrade succeeds, the status shows CURRENT.

Example:

RP/0/RP0/CPU0:ios# show hw-module fpd   
Fri May 29 11:35:24.492 UTC

Auto-upgrade:Disabled
                                                                         FPD Versions
                                                                        ==============
Location   Card type             HWver FPD device       ATR Status    Running   Programd  
-----------------------------------------------------------------------------------------
0/0       NCS1K4-2-QDD-C-K9 1.0   LC_CPU_MOD_FW              CURRENT    21.31     21.31    
0/0       NCS1K4-2-QDD-C-K9 1.0   LC_OPT_MOD_FW              CURRENT     1.26      1.26    
0/1       NCS1K4-2-QDD-C-K9 0.0   LC_CPU_MOD_FW              CURRENT    21.31     21.31    
0/1       NCS1K4-2-QDD-C-K9 1.0   LC_OPT_MOD_FW              CURRENT     1.26      1.26    
0/2       NCS1K4-2-QDD-C-K9 1.0   LC_CPU_MOD_FW              CURRENT    21.31     21.31    
0/2       NCS1K4-2-QDD-C-K9 1.0   LC_OPT_MOD_FW              CURRENT     1.26      1.26    
0/3       NCS1K4-2-QDD-C-K9 0.0   LC_CPU_MOD_FW              CURRENT    21.31     21.31    
0/3       NCS1K4-2-QDD-C-K9 1.0   LC_OPT_MOD_FW              CURRENT     1.26      1.26    
0/RP0     NCS1K4-CNTLR-K9   1.14  BIOS              S        CURRENT     5.30      5.30    
0/RP0     NCS1K4-CNTLR-K9   5.4   BP_SSD                     CURRENT    75.00     75.00    
0/RP0     NCS1K4-CNTLR-K9   4.0   CPU_FPGA                   CURRENT     1.14      1.14    
0/RP0     NCS1K4-CNTLR-K9   5.4   CPU_SSD                    CURRENT    75.00     75.00    
0/PM1     NCS1K4-AC-PSU     0.1   PO-PriMCU                  CURRENT     2.70      2.70    
0/SC0     NCS1004           2.0   BP_FPGA                    CURRENT     1.25      1.25    
0/SC0     NCS1004           2.0   XGE_FLASH                  CURRENT    18.04     18.04

Note

 

FPD upgrades from Release 7.0.1 to later releases do not affect traffic. The upgrade of LC_OPT_MOD_FW FPD during the transition from R7.0.0 to R7.0.1 impacts traffic

Note

 

FPD upgrade of LC_CPU_MOD_FW does not affect traffic. However, upgrading the LC_DP_MOD_FW FPD does impact traffic.

All FPDs on NCS 1004, including line cards and SSDs, are upgraded and show the CURRENT status. The device operates with the latest firmware, ensuring reliability and compatibility.