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 Optical Site Manager installation workflow

Updated: October 26, 2026

Want to summarize with AI?

Learn how to install and configure Cisco Optical Site Manager on NCS 1000 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 Prerequisites for devices managed by Cisco Optical Site Manager.

Perform these tasks to install and configure Cisco Optical Site Manager on NCS 1000 platforms.

Procedure

Install Cisco Optical Site Manager. For more details, see Install Cisco Optical Site Manager on NCS 1014.
Configure Cisco Optical Site Manager in standalone or high availability mode. For more details, see Supported configurations.
Activate Cisco Optical Site Manager. For more details, see Activate Cisco Optical Site Manager.

Install Cisco Optical Site Manager on NCS 1014

Cisco Optical Site Manager can be installed on NCS 1014 platforms in these two ways:

As part of a Golden ISO (GISO) image where the Cisco Optical Site Manager package is already bundled with Cisco IOS XR image.
On NCS 1014 platforms where Cisco IOS XR is already installed, you can install Cisco Optical Site Manager as an optional software component.

In the second scenario, you must manually install the Cisco Optical Site Manager software 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 1014
Cisco Optical Site Manager hosting platform	Deployment guidance	Device management capacity
NCS 1014	At a site with NCS 1014 and NCS 1001 devices, use NCS 1014 as the Cisco Optical Site Manager host and NCS 1001 as the managed device.	Can manage NCS 1014, NCS 1004, and NCS 1001 devices.

Before you begin

Before installing the Cisco Optical Site Manager RPM, verify whether the xr-cosm package is already active on the host device using comand show install active | include xr-cosm.

If the command displays an active xr-cosm package, the Cisco Optical Site Manager RPM is already included in the installed GISO. Skip the RPM installation steps and proceed with Cisco Optical Site Manager configuration and activation. If the command does not display the package, install the Cisco Optical Site Manager RPM.
Download and install 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

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

RP/0/RP0/CPU0:vmxCisco_T1#mkdir /misc/disk1/cosm
RP/0/RP0/CPU0:vmxCisco_T1# scp user@[RPM_SERVER]:/nobackup/ncs1010_image/*.rpm    /misc/disk1/cosm
Password: ********

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.
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
```
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
```
Commit the changes using the install commit synchronous command.
Example:
```
RP/0/RP0/CPU0:ios#install commit synchronous
```

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                                                           26.1.1v1.0.1-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                                                           26.1.1v1.0.1-1

What to do next

Configure Cisco Optical Site Manager in Configure Cisco Optical Site Manager in standalone mode for NCS 1014 or Cisco Optical Site Manager High Availability mode.

Configure Cisco Optical Site Manager in standalone mode for NCS 1014

Cisco Optical Site Manager can be configured in standalone mode on a single NCS 1014 device.

The configuration involves setting up Cisco Optical Site Manager interfaces, defining management interface parameters, and establishing user credentials for access.

Before you begin

Except for the mandatory parameters described in this procedure, retain the default values for all other configuration parameters unless your deployment requires different values.

Follow these steps to configure Cisco Optical Site Manager in standalone mode:

Procedure

Enter into the IOS XR and COSM configuration mode using the configure terminal and cosm commands.
Example:
```
RP/0/RP0/CPU0:ios#configure terminal
RP/0/RSP0/CPU0:ios(config)# cosm
```
Configure the device interface through which Cisco Optical Site Manager can be accessed by using the mgmt-interface-name MgmtEth R/S/I/P command.
Example:
```
RP/0/RP0/CPU0:ios(config-cosm)# mgmt-interface-name Loopback1
```
This is the interface used to reach Cisco Optical Site Manager. This interface can be a physical interface or a loopback interface.
Configure the username using the user-name user name command.
Example:
```
RP/0/RP0/CPU0:ios(config-cosm)# user-name cisco
```
Configure the password using the user-password password command.
Example:
```
RP/0/RP0/CPU0:ios(config-cosm)# user-password ***
```
Note

The Cisco Optical Site Manager username and password can be the same as, or different from, the XR host device credentials. These credentials are saved in the Cisco Optical Site Manager application database and are not displayed in the XR show running-config output.
Commit the changes and exit the configuration modes using the commit and end commands.
Example:
```
RP/0/RP0/CPU0:ios(config-cosm) commit
RP/0/RP0/CPU0:ios(config-cosm) end
```
Verify the configuration using the show running-config cosm command.
Example:

This example shows the standalone Cisco Optical Site Manager configuration.
```
RP/0/RP0/CPU0:ios#show running-config cosm
Fri Oct 18 12:53:47.056 UTC
cosm
 mgmt-interface-name Loopback1
!
```
The configured user-name and user-password are not displayed in the output of the show running-config cosm command.

Cisco Optical Site Manager is configured in the standalone mode.

Activate Cisco Optical Site Manager

After configuration is complete, activate Cisco Optical Site Manager to enable the application.

After configuring Cisco Optical Site Manager in standalone or high availability mode, including setting management interfaces, and user credentials, the application remains inactive until explicitly activated.

The configuration of interfaces used by Cisco Optical Site Manager should not be changed after activation.

Procedure

Activate Cisco Optical Site Manager using the cosm activate command.
Example:
```
RP/0/RP0/CPU0:ios# cosm activate
```
Verify the status of the application using the show cosm status command.

It may take a few minutes to activate Cisco Optical Site Manager.

After activating, wait for few minutes before logging in to the Cisco Optical Site Manager GUI.
Upon successful activation, the application transitions to an active state. Status commands display APP_ACTIVATED and ACTIVATED states.

This example shows the status of Cisco Optical Site Manager configured in standalone mode.

RP/0/RP0/CPU0:OLT-2#show cosm status
Fri Oct 18 13:06:09.862 UTCCOSM state: APP_ACTIVATED
AppMgr app state: ACTIVATED
AppMgr container state: RUNNING
Container status: Up 1 hours
Last error: No error
COSM version: 26.1.1.D0362

What to do next

Need help?

Open a support case

(Requires a Cisco Service Contract)

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.