Cisco Optical Automation Solution for Protected Point-to-Point Managed Optical Fiber Network

PDF

Cisco Optical Automation Solution for Protected Point-to-Point Managed Optical Fiber Network

Cisco IOS XR and Cisco Optical Site Manager software maintenance update

Want to summarize with AI?

Log in

Use this reference to choose the software maintenance update installation method for Cisco IOS XR devices and Cisco Optical Site Manager hosts.


Select the installation method that matches the required fixes and the reload control needed for the maintenance window.

Software maintenance update overview

A software maintenance update (SMU) is a software patch that is installed on a Cisco IOS XR device. An SMU is built for a specific release, component, and platform, and is provided for urgent issues.

The Cisco Optical Site Manager image is bundled as a Cisco IOS XR RPM. Therefore, a Cisco Optical Site Manager SMU is delivered as a Cisco IOS XR SMU. A Cisco Optical Site Manager SMU is always a reload SMU.

In a Cisco Optical Site Manager high availability deployment, install the SMU on the standby device before installing it on the active device. For more details, see Install a Cisco Optical Site Manager SMU.

Installation method selection

Confirm the required SMU and installation method with the Cisco account team. This table helps you choose the workflow before you install the SMU.

Table 1. SMU installation method selection

If

Then

You need to install a Cisco IOS XR software image and selected SMUs in one operation.

Build a Golden ISO and use the install replace command from the Cisco IOS XR CLI. See Install software maintenance updates by using a Golden ISO.

You do not need control over reload timing.

Use the install source command. This method automatically applies the changes, including reload or restart actions as required, and reduces the number of commands needed for SMU installation without changing the entire image. See Install a software maintenance update by using the install source command.

You need to install multiple SMUs together and control reload timing.

Use the install package add source command. This method requires explicit apply and commit actions. See Install software maintenance updates by using the install package add source command.


Install software maintenance updates by using a Golden ISO

Install the Cisco IOS XR software image and selected SMUs in one operation by using a Golden ISO.

A Golden ISO (GISO) is a customized ISO that includes the standard base image with basic functional components, additional RPMs, SMUs, and configuration files. A Golden ISO upgrades the device to a version that has a predefined list of SMUs in a single operation.

Follow these steps to install SMUs by using a Golden ISO.

Procedure

  1. Check the md5sum value of the downloaded Golden ISO.

    Example:

    [syedsaah@vxr-sirius-04 Image]$ md5sum ncs1010-golden-x86_64-25.1.1-Feb27Drop2.iso
    44dcd5214add0314116d109918bb926f  ncs1010-golden-x86_64-25.1.1-Feb27Drop2.iso
  2. Copy the image from the workspace or local directory to the node.

    Example:

    [syedsaah@vxr-sirius-04 Image]$ scp ncs1010-golden-x86_64-25.1.1-Feb27Drop2.iso cisco@4.33.7.61:/harddisk:/
    Password:
    ncs1010-golden-x86_64-25.1.1-Feb27Drop2.iso                                                               100% 2497MB  85.5MB/s   00:29
  3. Access the device shell and verify that the copied image is available in /harddisk:/.

    Example:

    RP/0/RP0/CPU0:P2A_DT_07#run
    Mon Feb 23 13:29:40.542 IST
    [node0_RP0_CPU0:~]$ cd /harddisk\:
    [node0_RP0_CPU0:/harddisk:]$ ls -ltra | grep -i ncs1010-golden-x86_64-25.1.1-Feb27Drop2.iso
    -rwxrwxrwx.  1 root  root          2618347520 Feb 23 13:27 ncs1010-golden-x86_64-25.1.1-Feb27Drop2.iso
  4. Verify that the md5sum value of the copied image matches the value calculated before the copy.

    Example:

    [node0_RP0_CPU0:/harddisk:]$ md5sum ncs1010-golden-x86_64-25.1.1-Feb27Drop2.iso
    44dcd5214add0314116d109918bb926f  ncs1010-golden-x86_64-25.1.1-Feb27Drop2.iso
  5. Install the software image from /harddisk:/.

    Example:

    RP/0/RP0/CPU0:P2A_DT_07#install replace harddisk:/ncs1010-golden-x86_64-25.1.1-Feb27Drop2.iso commit noprompt
    Mon Feb 23 13:31:48.714 IST
    Install replace operation 204 has started
    Install operation will continue in the background
  6. After the node is up, check the software version and the status of the install process.

    Example:

    RP/0/RP0/CPU0:P2A_DT_07#show version
    Mon Feb 23 13:50:15.241 IST
    Cisco IOS XR Software, Version 25.1.1 LNT
    Copyright (c) 2013-2025 by Cisco Systems, Inc.
    
    Build Information:
     Built By     : swtools
     Built On     : Fri Feb 20 08:58:11 UTC 2026
     Build Host   : iox-ucs-037
     Workspace    : /auto/srcarchive12/prod/25.1.1/ncs1010/ws
     Version      : 25.1.1
     Label        : 25.1.1-Feb27Drop2
    
    cisco NCS1010 (C3758 @ 2.20GHz)
    cisco NCS1010-SA (C3758 @ 2.20GHz) processor with 32GB of memory
    P2A_DT_07 uptime is 7 minutes
    NCS 1010 - Chassis
    
    RP/0/RP0/CPU0:P2A_DT_07#show install request
    Mon Feb 23 13:50:29.368 IST
    
    User request: install replace /harddisk:/ncs1010-golden-x86_64-25.1.1-Feb27Drop2.iso commit
    Operation ID: 204
    State:        Success since 2026-02-23 13:46:53 UTC+05:30
    
    Current activity:    No install operation in progress
  7. Verify the active package summary.

    Example:

    RP/0/RP0/CPU0:P2A_DT_07#show install active summary
    Mon Feb 23 13:51:05.379 IST
    Active Packages:    XR: 156    All: 1400
    Label:              25.1.1-Feb27Drop2
    XR Software Hash:      3b41e8017f18853a6a9c1a9d5b3463a4c91b07e2cace3b746ef5a755138c3210
    
    Optional Packages                                                        Version
    ---------------------------------------------------- ---------------------------
    xr-bgp                                                            25.1.1v1.0.0-1
    xr-cosm                                                           25.1.1v1.0.3-1
    xr-healthcheck                                                    25.1.1v1.0.0-1
    xr-ipsla                                                          25.1.1v1.0.0-1
    xr-is-is                                                          25.1.1v1.0.0-1
    xr-lldp                                                           25.1.1v1.0.0-1
    xr-mpls-oam                                                       25.1.1v1.0.0-1
    xr-netflow-stubs                                                  25.1.1v1.0.0-1
    xr-netsim                                                         25.1.1v1.0.0-1
    xr-olc                                                            25.1.1v1.0.0-1
    xr-ospf                                                           25.1.1v1.0.0-1
    xr-perfmgmt                                                       25.1.1v1.0.0-1
    xr-track                                                          25.1.1v1.0.0-1
    
    Mandatory Packages With Active Bugfixes                                  Version
    ---------------------------------------------------- ---------------------------
    xr-diskboot                                                       25.1.1v1.0.1-1
    xr-ncs1010-core                                                   25.1.1v1.0.1-1
    xr-ncs1010-dri                                                    25.1.1v1.0.1-1
    xr-ncs1010-forwarder                                              25.1.1v1.0.1-1
    xr-ncs1010-fpd                                                    25.1.1v1.0.2-1
    xr-ncs1010-os-oe                                                  25.1.1v1.0.1-1
    
    Active Fixes (count: 7):
      CSCwn69606: xr-diskboot, xr-ncs1010-dri, xr-ncs1010-os-oe
      CSCwq77633: xr-ncs1010-core
      CSCwr31650: xr-ncs1010-forwarder
      CSCwr67302: xr-cosm
      CSCws04319: xr-cosm
      CSCws41649: xr-ncs1010-fpd
      CSCws74922: xr-ncs1010-fpd
  8. Verify the committed package summary.

    Example:

    RP/0/RP0/CPU0:P2A_DT_07#show install committed summary
    Mon Feb 23 13:51:31.334 IST
    Committed Packages: XR: 156    All: 1400
    Label:              25.1.1-Feb27Drop2
    XR Software Hash:      3b41e8017f18853a6a9c1a9d5b3463a4c91b07e2cace3b746ef5a755138c3210
    
    Optional Packages                                                        Version
    ---------------------------------------------------- ---------------------------
    xr-bgp                                                            25.1.1v1.0.0-1
    xr-cosm                                                           25.1.1v1.0.3-1
    xr-healthcheck                                                    25.1.1v1.0.0-1
    xr-ipsla                                                          25.1.1v1.0.0-1
    xr-is-is                                                          25.1.1v1.0.0-1
    xr-lldp                                                           25.1.1v1.0.0-1
    xr-mpls-oam                                                       25.1.1v1.0.0-1
    xr-netflow-stubs                                                  25.1.1v1.0.0-1
    xr-netsim                                                         25.1.1v1.0.0-1
    xr-olc                                                            25.1.1v1.0.0-1
    xr-ospf                                                           25.1.1v1.0.0-1
    xr-perfmgmt                                                       25.1.1v1.0.0-1
    xr-track                                                          25.1.1v1.0.0-1
    
    Mandatory Packages With Committed Bugfixes                               Version
    ---------------------------------------------------- ---------------------------
    xr-diskboot                                                       25.1.1v1.0.1-1
    xr-ncs1010-core                                                   25.1.1v1.0.1-1
    xr-ncs1010-dri                                                    25.1.1v1.0.1-1
    xr-ncs1010-forwarder                                              25.1.1v1.0.1-1
    xr-ncs1010-fpd                                                    25.1.1v1.0.2-1
    xr-ncs1010-os-oe                                                  25.1.1v1.0.1-1
    
    Committed Fixes (count: 7):
      CSCwn69606: xr-diskboot, xr-ncs1010-dri, xr-ncs1010-os-oe
      CSCwq77633: xr-ncs1010-core
      CSCwr31650: xr-ncs1010-forwarder
      CSCwr67302: xr-cosm
      CSCws04319: xr-cosm
      CSCws41649: xr-ncs1010-fpd
      CSCws74922: xr-ncs1010-fpd

The Golden ISO software changes are installed and committed on the device.


Install a software maintenance update by using the install source command

Install and commit a Cisco IOS XR or Cisco Optical Site Manager SMU by using the install source command.

The install source command automatically applies the changes, including reload or restart actions as required. Use this method to reduce the number of commands needed for SMU installation without changing the entire image.

Follow these steps to install an SMU by using the install source command.

Procedure

  1. Copy the SMU from the server to the device and confirm the md5sum value.

    Example:

    [root@NCS1k-ZTP smu]# scp /nobackup/cosm/smu/ncs1010-x86_64-25.1.1-CSCwp05477-swtools-2025-10-08-2334.tgz cixxx@10.xx.xx.xx:/harddisk:/
    
    [node0_RP0_CPU0:/harddisk:]$ md5sum ncs1010-x86_64-25.1.1-CSCwp05477-swtools-2025-10-08-2334.tgz
    4e156140f4481452599c44afbdadd13d  ncs1010-x86_64-25.1.1-CSCwp05477-swtools-2025-10-08-2334.tgz
  2. Install the SMU.

    Example:

    RP/0/RP0/CPU0:router#install source /harddisk:/ncs1010-x86_64-25.1.1-CSCwp05477-swtools-2025-10-08-2334.tgz
  3. Wait until the install request state changes to Success.

    Example:

    RP/0/RP0/CPU0:COSM_OLT-3_214#show install request
    Mon Oct 13 07:40:19.516 UTC
    
    User request: install source /harddisk:/ncs1010-x86_64-25.1.1-CSCwp05477-swtools-2025-10-08-2334.tgz
    Operation ID: 26.1
    State:        Success since 2025-10-13 07:38:28 UTC
    Current activity:    Await user input
    Time started:        2025-10-13 07:38:28 UTC
  4. Commit the install operation.

    Example:

    RP/0/RP0/CPU0:COSM_OLT-3_214#install commit
  5. Repeat this procedure for each SMU that you install individually.

    Each SMU is treated as a separate transaction.

The SMU is installed and committed on the device.


Install software maintenance updates by using the install package add source command

Install multiple SMUs together by using the install package add source command, and explicitly apply and commit the changes during the maintenance window.

Use this method when you need control over reload timing. The workflow requires explicit apply and commit actions.

Follow these steps to install SMUs by using the install package add source command.

Procedure

  1. Review the Cisco IOS XR package installation procedure for the target platform and release.

    For detailed steps, see Install additional RPMs and bug fixes.

  2. Add the required SMU packages by using the install package add source command.

  3. Apply the SMU package changes during the approved maintenance window.

  4. Commit the SMU package changes after validation is complete.

The selected SMUs are installed and committed on the device.