System Setup and Software Installation Guide for Cisco Optical Site Manager, IOS XR

PDF

Cisco Optical Site Manager installation workflow

Updated: March 2, 2026

Want to summarize with AI?

Log in

Overview

Learn how to install and configure Cisco Optical Site Manager on NCS 1010 , NCS 1014, NCS 1004, or NCS 1001 platforms.

This workflow helps you install and configure Cisco Optical Site Manager. You will set up Cisco Optical Site Manager, configure it for standalone or high availability (HA) operation, manage interfaces, and activate the application as needed.

Before you begin

Verify that the installation requirements are met before proceeding. For details, see Cisco Optical Site Manager installation prerequisites for NCS 1000 devices.

Perform these tasks to install and configure Cisco Optical Site Manager on NCS 1010 or NCS 1014 platforms.

Procedure

1.

Install Cisco Optical Site Manager on NCS 1010, NCS 1014, NCS 1004, or NCS 1001 platforms. For more details, see Install Cisco Optical Site Manager on NCS 1010 or NCS 1014 or Install Cisco Optical Site Manager on NCS 1001 or NCS 1004.
2.

Configure Cisco Optical Site Manager in standalone or high availability mode. For more details, see Configure Cisco Optical Site Manager on NCS 1000.
3.

Perform these tasks to setup Cisco Optical Site Manager:

  1. Enable or disable Cisco Optical Site Manager interfaces individually. For more details, see Enable or disable Cisco Optical Site Manager north-bound interfaces.

    Note

    By default, these interfaces are enabled

    • NETCONF

    • RESTCONF

    • Interactive Web-UI

  2. Activate Cisco Optical Site Manager. For more details, see Activate Cisco Optical Site Manager.

Cisco Optical Site Manager installation prerequisites for NCS 1000 devices

This section lists the prerequisites for installing Cisco Optical Site Manager.

These requirements must be met before using Cisco Optical Site Manager to manage NCS 1000 devices.

  • All the Cisco NCS 1000 devices on the network are reachable from the device hosting Cisco Optical Site Manager.

  • SSH is configured on all the devices.

  • Netconf-Yang agent is configured to use SSH for communication.

  • The SSH rate limit is set to 600.

  • Before Release 24.3.1, use the MgmtEth0/RP0/CPU0/1 interface for auto-onboarding of directly connected devices (peer devices). The interface uses IP addresses 192.168.1.1/30 and 192.168.1.2/30.

  • Static routes are added on devices that belong to different subnets or configured as peer devices. For more details, see Configure static routes on peer devices.

Enable NETCONF over SSH on host devices

Enable NETCONF over SSH so that Cisco Optical Site Manager can connect to host devices to perform configuration and monitoring. Also, enable NETCONF on each Cisco Optical Site Manager host device.

Before you begin

Follow these steps to enable netconf:

Procedure

1.

Enter the configuration mode using the configure terminal command.

Example:

RP/0/RP0/CPU0:ios#configure terminal
2.

Enable NETCONF-YANG agent over SSH connection using the netconf-yang agent ssh command.

Example:

RP/0/RSP0/CPU0:ios(config)# netconf-yang agent ssh
3.

Configure the device to use SSH protocol v2 using the ssh server v2 command.

Note

Only SSH version 2 is supported. Cisco Optical Site Manager does not accept SSH version 1 connections.

Example:

RP/0/RP0/CPU0:ios(config)# ssh server v2
4.

Set the rate limit for incoming SSH connection requests to 600 per minute using the ssh server rate-limit rate-limit command.

Example:

RP/0/RP0/CPU0:ios(config)# ssh server rate-limit 600
5.

Enable NETCONF protocol over SSH connection using the ssh server netconf command.

Example:

RP/0/RP0/CPU0:ios(config)# ssh server netconf
6.

Commit the changes using the commit command.

After you enable NETCONF, Cisco Optical Site Manager can establish a secure communication with the device using the NETCONF protocol over SSH.

This example describes the commands to enable NETCONF over SSH on the host devices:

RP/0/RP0/CPU0:ios# configure terminal
RP/0/RSP0/CPU0:ios(config)# netconf-yang agent ssh
RP/0/RP0/CPU0:ios(config)# ssh server v2
RP/0/RP0/CPU0:ios(config)# ssh server rate-limit 600
RP/0/RP0/CPU0:ios(config)# ssh server netconf

What to do next

Configure static route on peer devices

Configure static routes on peer devices

Configure static route to ensure that the Cisco Optical Site Manager host device can reach its peer device for management and high availability communication.

In a high-availability setup, two Cisco Optical Site Manager devices located remotely are directly connected to each other through their MgmtEth interfaces.

  • Each device must have either a static route or a routing protocol configuration that defines how to reach the peer’s redundancy interface.

  • Static route configuration is optional.

Before you begin

Install Netconf.

Follow these steps to configure a static route on the peer devices:

Procedure

1.

Enter the configuration mode using the configure terminal command.

Example:

RP/0/RP0/CPU0:ios#configure terminal
2.

Enter the static router configuration mode using the router static command.

Example:

RP/0/RP0/CPU0:ios(config)#router static
3.

Configure the IPv4 unicast address static routes using the address-family ipv4 unicast 0.0.0.0/0 default gateway command.

Example:

RP/0/RSP0/CPU0:ios(config-static)#address-family ipv4 unicast 0.0.0.0/0 192.168.2.1
4.

Exit the configuration mode using the exit command.
5.

Verify the configuration using the show running-config router static command.

Example:

RP/0/RP0/CPU0:ios#show running-config router static
router static
 address-family ipv4 unicast
  0.0.0.0/0 192.168.2.1
 !
!
Caution

When using OLC, do not configure redistribute static under OSPF if there are static routes configured for any of the IP addresses belonging to OLT nodes or ILA nodes in optical network. This can cause OLC topology discovery failures and prevent control loops from operating properly.

The Cisco Optical Site Manager host device gains reliable network reachability to its peer devices, enabling effective management and failover operations.

This example describes the commands to configure a static route on the peer devices:

RP/0/RP0/CPU0:ios#configure terminal
RP/0/RP0/CPU0:ios(config)#router static
RP/0/RSP0/CPU0:ios(config-static)#address-family ipv4 unicast 0.0.0.0/0 192.168.2.1
RP/0/RSP0/CPU0:ios(config-static)#exit
RP/0/RP0/CPU0:ios#show running-config router static
router static
 address-family ipv4 unicast
  0.0.0.0/0 192.168.2.1
 !
!

What to do next

Install Cisco Optical Site Manager on NCS 1010 or NCS 1014

Cisco Optical Site Manager is an optional software component that can be installed on NCS 1010 or NCS 1014 platforms. If Cisco IOS XR is already installed, you can install Cisco Optical Site Manager manually using the provided .rpm files. You can download the Cisco Optical Site Manager software image from the Software Download page.

Table 1. Supported software packages and device management capacities for NCS 1010 and NCS 1014

Cisco Optical Site Manager hosting platform

Supported software package in repository

Device management capacity

NCS 1010

Eight

Can manage NCS 1010, NCS 1014, NCS 1004, and NCS 1001 devices.

NCS 1014

Eight

Can manage NCS 1014, NCS 1004, and NCS 1001 devices.

Before you begin

Download the NCS1010/NCS1020 and NCS1014 IOS XR Software optional-rpms optional package from Software Download page.

Follow these steps to install Cisco Optical Site Manager:

Procedure

1.

Copy all the .rpm files in the cosm folder of the downloaded package to the device storage.
2.

Add the Cisco Optical Site Manager package source folder to the Cisco IOS XR software management system in synchronous mode using the install package add source file: rpm-folder synchronous command.

Example:

RP/0/RP0/CPU0:ios#install package add source file:/harddisk:/cosm/ synchronous
Install add operation 2.1.1 has started

Installation in synchronous mode is optional and runs in the foreground and waits for the operation to complete before returning control to the user.
3.

Install the Cisco Optical Site Manager RPM in synchronous mode using the install package add package-name synchronous command.

Example:

RP/0/RSP0/CPU0:ios#install package add xr-cosm synchronous
4.

Apply the latest changes in synchronous mode on the NCS 1000 device using the install apply restart synchronous command.

Example:

RP/0/RP0/CPU0:ios#install apply restart synchronous
The latest changes are applied to all processes, including the impacted processes.
5.

Commit the changes using the install commit synchronous command.

Example:

RP/0/RP0/CPU0:ios#install commit synchronous
6.

Verify that Cisco Optical Site Manager rpm is installed using the show install active | include xr-cosm command.

Example:

RP/0/RP0/CPU0:ios#show install active | include xr-cosm
Fri Nov 14 11:07:17.877 UTC
xr-cosm                                                           25.1.1v1.0.2-1

Cisco Optical Site Manager is installed on the device.

This example describe the commands to install Cisco Optical Site Manager:

RP/0/RP0/CPU0:ios#install package add source file:/harddisk:/cosm/ synchronous
RP/0/RSP0/CPU0:ios#install package add xr-cosm synchronous
RP/0/RP0/CPU0:ios#install apply restart synchronous
RP/0/RP0/CPU0:ios#install commit synchronous
RP/0/RP0/CPU0:ios#sh install active | include xr-cosm
Fri Nov 14 11:07:17.877 UTC
xr-cosm                                                           25.1.1v1.0.2-1

What to do next

Configure Cisco Optical Site Manager in Standalone or High Availability mode.

Install Cisco Optical Site Manager on NCS 1001 or NCS 1004

Cisco Optical Site Manager is an optional software component that can be installed on NCS 1001 or NCS 1004 platforms. If Cisco IOS XR is already running on your device, you can manually install Cisco Optical Site Manager using the supplied .rpm packages.

For release 25.4.1, NCS 1004 and NCS 1001 host devices do not support storing multiple software packages of the same release; downloading a new package of the same build replaces the existing one.

This table outlines the supported software package count and device management capacity based on the platform hosting Cisco Optical Site Manager.

Table 2. Supported software packages and device management capacities for NCS 1004 and NCS 1001

Cisco Optical Site Manager hosting platform

Supported software package in repository

Device management capacity

NCS 1001

One

Can manage up to two NCS 1001 devices—including the host device. Only NCS 1001 devices are supported for management.

NCS 1004

  • Before R26.1.1: One

  • From R26.1.1: Two

Can manage up to

  • three NCS 1004 devices and

  • three NCS 1001 devices.

Note

The software upgrade on the NCS1004 or NCS 1001 from Cisco Optical Site Manager does not succeed when using a mini ISO file.
Note

NCS 1001 does not support the iXPE boot of a golden ISO with Cisco Optical Site Manager.

Before you begin

Download the NCS1001 and NCS1004 IOS XR Software optional-rpms optional package from Software Download page.

Follow these steps to install Cisco Optical Site Manager on NCS 1001 or NCS 1004:

Procedure

1.

Copy the downloaded .rpm files to the device storage.
2.

Install the Cisco Optical Site Manager package source file in synchronous mode using the install add source <folder> <pkg name> synchronous command.

Example:

RP/0/RP0/CPU0:ios#install add source /harddisk:/cosm ncs1001-cosm-1.0.0.0-r253107I.x86_64.rpm synchronous
Install add operation 2.1.1 has started
3.

Identify the inactive Cisco Optical Site Manager package name using the show install inactive command.

Example:

The bold line in this example shows the inactive package name. You will use this package name to activate the package in the next step.

RP/0/RP0/CPU0:ios#show install inactive
Fri Apr 11 08:10:57.969 UTC
1 inactive package(s) found:
    ncs1001-cosm-1.0.0.0-r253107I
4.

Activate the package using the install activate <package name> synchronous command.

Example:

RP/0/RP0/CPU0:ios#install activate ncs1001-cosm-1.0.0.0-r253107I synchronous

Use the <package name> from the output of the show install inactive command.

Warning

Do not activate a base IOS XR GISO on a device that is running Cisco Optical Site Manager, as this action will remove the application.
5.

Commit the changes using the install commit command.

Example:

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

Cisco Optical Site Manager is installed on the device.

This example shows the commands to install Cisco Optical Site Manager on NCS 1001 or NCS 1004:

RP/0/RP0/CPU0:ios#install add source /harddisk:/cosm ncs1001-cosm-1.0.0.0-r253107I.x86_64.rpm synchronous
Install add operation 2.1.1 has started
RP/0/RP0/CPU0:ios#show install inactive
Fri Apr 11 08:10:57.969 UTC
1 inactive package(s) found:
    ncs1001-cosm-1.0.0.0-r253107I
RP/0/RP0/CPU0:ios#install activate ncs1001-cosm-1.0.0.0-r253107I synchronous
RP/0/RP0/CPU0:ios#install commit

What to do next

Configure Cisco Optical Site Manager in Standalone mode.