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

PDF

High availability for NCS 1000

Updated: March 2, 2026

Want to summarize with AI?

Log in

Overview

This topic describes Cisco Optical Site Manager high availability (HA), including its architecture, roles, interfaces, and configuration on NCS 1000 devices. Use this topic to understand how Cisco Optical Site Manager maintains management continuity by using active and standby roles, shared management interfaces, and redundancy interfaces that support failover during device or link failures.

Cisco Optical Site Manager High Availability (HA) provides continuous management and operational resilience for Cisco optical devices. By deploying two instances, one as Active and the other as Standby, HA ensures that device management remains uninterrupted even if one instance fails.

How does Cisco Optical Site Manager high availability ensure operational continuity?

Cisco Optical Site Manager High Availability (HA) provides a robust solution for managing device operations by utilizing dual application instances and specialized network interfaces.

The main features of Cisco Optical Site Manager high availability include:

  • Two devices must be able to communicate with each other, allowing their respective Cisco Optical Site Manager instances to coordinate application roles (active or standby) and manage operations.

  • Each device requires a Cisco Optical Site Manager management interface configured with the same IP address, starting in a shutdown state. This interface automatically transitions between UP and DOWN states based on whether the device is active or standby.

  • A dedicated Cisco Optical Site Manager redundancy interface is used to establish the high availability communication channel and typically serves as the device’s management interface.

  • When in the active role, Cisco Optical Site Manager binds the HA server to the redundancy interface’s IP address on port 5454.

  • When in the Standby role, Cisco Optical Site Manager connects to the peer’s redundancy interface IP address on port 5454 to communicate with the active instance.

HA roles and interfaces

  • Active role: manages all device operations and binds the HA server to its redundancy interface and port.

  • Standby role: monitors the active instance and connects to the peer’s redundancy IP and port. It is ready to take over if needed.

  • Redundancy interface: network interface used solely for HA communication between Cisco Optical Site Manager instances.

  • Management interface: interface with the same IP address on both devices, managed automatically depending on the instance role.

Note

High availability is not supported on NCS 1004 and NCS 1001.

Configure Cisco Optical Site Manager in high availability on NCS 1000

Configure High Availability (HA) on Cisco Optical Site Manager is to enable fast recovery from faults in the optical transport network and to maintain service continuity by switching to standby components when active ones fail.

Cisco Optical Site Manager HA configuration requires these interfaces configured.

  • cosm mgmt-interface-name: This interface must be configured with same IP address on both Cisco Optical Site Manager active and standby devices. This interface must be configured in a shutdown state and will automatically transition between UP and DOWN states based on the role (Active or Stand-By) assigned by the application.

  • cosm redundancy interface-name: This interface must be configured with the redundancy interface and is used to establish the high availability communication channel and is typically the interface used for device management.

  • redundancy gateway-ip: Specifies the gateway IP address (for example, 10.0.2.1) used by Cisco Optical Site Manager to reach peer devices or for routing HA traffic in environments where a direct path to the peer is not available.

Before you begin

Verify that Cisco Optical Site Manager rpm is installed. For more details, see Install Cisco Optical Site Manager on NCS 1010 or NCS 1014.

Follow these steps to configure Cisco Optical Site Manager in HA mode on a NCS 1010 or NCS 1014 device:

Procedure

1.

Enter into the IOS XR and Cisco Optical Site Manager configuration modes.

Example:

RP/0/RP0/CPU0:ios#configure terminal
RP/0/RSP0/CPU0:ios(config)# cosm
2.

Configure the gateway IP address.

Example:

RP/0/RP0/CPU0:ios(config-cosm)# redundancy gateway-ip 10.0.2.1
3.

Configure the peer IP address.

This is the IP address of the peer device running the Cisco Optical Site Manager HA instance.

Example:

RP/0/RP0/CPU0:ios(config-cosm)# redundancy peer-ip 10.0.1.12

For releases 24.x.x and 25.x.x, verify that the redundancy interface-name IP address and the redundancy peer-ip address are not substrings of each other. For example, configuring 10.0.1.1 as the redundancy interface-name and 10.0.1.10 or 10.0.1.101 as the redundancy peer-ip (or vice-versa) causes Cisco Optical Site Manager HA to fail during startup.
4.

Configure the HA interface name.

This is the interface of the device running the Cisco Optical Site Manager HA instance, which is used for all HA traffic.

Example:

RP/0/RP0/CPU0:ios(config-cosm)# redundancy interface-name MgmtEth 0/RP0/CPU0/2
5.

Commit the changes and exit all configuration modes.

Example:

RP/0/RP0/CPU0:ios(config-cosm)# commit
RP/0/RP0/CPU0:ios(config-cosm)# end
6.

Perform these steps 1 to 6 on both the second Cisco Optical Site Manager host device.
7.

Verify the HA configuration on both host devices.

Example:

RP/0/RP0/CPU0:ios#show cosm status 
Fri Nov 14 10:26:44.215 UTC
COSM state: CLIENT_REGISTERED
AppMgr app state: UNKNOWN
AppMgr container state: UNKNOWN
Container status: Not present
Last error: 'Appmgr' detected the 'warning' condition 'Application not found'
Role: UNKNOWN

You can view the active and standby application status in the Device Software section of the Software Manager menu.

Note

If the HA node is on loopback, the MAC address of the HA device is displayed as N/A in the Devices section of the Device Configuration page.

This example explains how to configure Cisco Optical Site Manager HA on a NCS 1010 or NCS 1014 device.

RP/0/RP0/CPU0:ios#configure terminal
RP/0/RSP0/CPU0:ios(config)# cosm
RP/0/RP0/CPU0:ios(config-cosm)# redundancy gateway-ip 10.0.2.1
RP/0/RP0/CPU0:ios(config-cosm)# redundancy peer-ip 10.0.1.12
RP/0/RP0/CPU0:ios(config-cosm)# redundancy interface-name MgmtEth 0/RP0/CPU0/2
RP/0/RP0/CPU0:ios(config-cosm)# commit
RP/0/RP0/CPU0:ios(config-cosm)# end
RP/0/RP0/CPU0:ios#show cosm status 
Fri Nov 14 10:26:44.215 UTC
COSM state: CLIENT_REGISTERED
AppMgr app state: UNKNOWN
AppMgr container state: UNKNOWN
Container status: Not present
Last error: 'Appmgr' detected the 'warning' condition 'Application not found'
Role: UNKNOWN

What to do next

Enable or disable Cisco Optical Site Manager north-bound interfaces

HA commands for Cisco Optical Site Manager

These commands are used to configure HA in Cisco Optical Site Manager on a NCS 1000 device.
Command Description
configure Enters global configuration mode.
cosm user-name <username>

Configures Cisco Optical Site Manager application username.
cosm user-password <password>

Configures Cisco Optical Site Manager application password.
cosm mgmt-interface-name <type> <number>

Configures the Cisco Optical Site Manager management interface. All Cisco Optical Site Manager NBI services (web UI, NETCONF, RESTCONF) are available on this interface.
cosm redundancy interface-name <type> <number>

Configures Cisco Optical Site Manager high availability interface. The interface is used to communicate with the peer device.
cosm redundancy peer-ip <IP-address>

Configures the IP address of the peer device, where other Cisco Optical Site Manager is running.
cosm redundancy gateway-ip <IP-address>

Configures the IP address of a target device that is always reachable by both devices hosting Cisco Optical Site Manager in high availability. Configuring the same gateway IP on both devices is strongly recommended.

Cisco Optical Site Manager uses this target device to perform checks in certain high availability scenarios. The target device must be different from the cosm redundancy peer-ip. The target device may be the subnet gateway, the multilayer switch connecting the two devices, or another suitable device.
commit

Commits the changes.
end

Exits the global configuration mode.