Migrate Cisco Optical Site Manager between standalone and high availability modes | System Setup and Software Installation Guide for Cisco Optical Site Manager, IOS XR

Provides details about the requirements and procedures that help you migrate Cisco Optical Site Manager from standalone to high availability mode or from high availability to standalone mode.

Cisco Optical Site Manager standalone and high availability migration requirements

Review these requirements before you migrate Cisco Optical Site Manager from standalone to high availability, or from high availability to standalone.

Migration scope

Cisco Optical Site Manager supports migration between standalone and high availability modes through the IOS XR CLI. The cosm reconfigure command applies committed Cisco Optical Site Manager configuration changes on the device that continues to host Cisco Optical Site Manager, without requiring you to deactivate and activate the application again or losing the Cisco Optical Site Manager database.

This table describes the supported migration flows.

Table 1. Cisco Optical Site Manager migration flows
Migration flow	Use	Result
Standalone to high availability	Adds Cisco Optical Site Manager redundancy configuration to the standalone device and activates Cisco Optical Site Manager on the peer device.	Cisco Optical Site Manager preserves persistent data on the active device. The peer device joins the deployment as standby.
High availability to standalone	Removes one Cisco Optical Site Manager device from a high availability deployment.	Cisco Optical Site Manager continues to run on the remaining device in standalone mode. Cisco Optical Site Manager data is deleted from the decommissioned device.

Requirements and restrictions

This table lists the requirements and restrictions for Cisco Optical Site Manager standalone and high availability migration.

Table 2. Cisco Optical Site Manager migration requirements
Requirement	Description
Supported platforms	Cisco Optical Site Manager supports this migration flow on Cisco NCS 1010 and Cisco NCS 1014 devices.
IP version	The migration flow supports IPv4 addresses only in this release.
Configuration interface	Use the IOS XR CLI and the `cosm reconfigure` command. Migration through the Cisco Optical Site Manager web UI, NETCONF, and RESTCONF is not supported.
Device state before standalone-to-high-availability migration	Only the first device must run Cisco Optical Site Manager. The peer device must have Cisco Optical Site Manager installed, but not activated.
Software and Cisco Optical Site Manager settings	Both devices must run the same Cisco IOS XR software version and use the same Cisco Optical Site Manager credentials, northbound interface enablement state, and northbound interface port settings.
High availability reachability	Both devices must reach each other through the configured redundancy interfaces. The redundancy gateway IP address must be reachable from both devices and must be different from the peer IP address. Use the same redundancy gateway IP address on both devices.
Peer device onboarding	Before you activate Cisco Optical Site Manager on the peer device, onboard the peer device in the Cisco Optical Site Manager Devices tab and wait until Sync Status shows sync-completed, alarm synchronized.
Certificate cleanup	Delete harddisk:/data/COSM/certs/host.cert before you run `cosm reconfigure` when the Cisco Optical Site Manager management IP address changes and the certificate contains the previous management IP address. When you migrate from high availability to standalone, also remove the high availability certificate directory for the peer device.
Operational state	Do not start the migration while a software download or activation operation is in progress. Keep power stable and do not reload or switch over the device during `cosm reconfigure`.
Backup and disaster recovery files	Create a new database backup before starting the migration and after the migration or rollback completes. For standalone-to-high-availability migration, use a newly generated disaster recovery file by Cisco Optical Site Manager because the old standalone backup and disaster recovery file are not valid for the migrated deployment.

Migration status values

This table describes the status values that help you verify Cisco Optical Site Manager migration progress.

Table 3. Cisco Optical Site Manager migration status values
Status value	Description
`APP_ACTIVATED`	Cisco Optical Site Manager is active on the device.
`APP_DEACTIVATED`	Cisco Optical Site Manager is deactivated on the device.
`ACTIVE`	The device hosts the active Cisco Optical Site Manager instance.
`ACTIVE (standby not connected)`	The device hosts the active Cisco Optical Site Manager instance, but the standby Cisco Optical Site Manager instance is not connected yet. This state can appear after you reconfigure the first device and before you activate Cisco Optical Site Manager on the peer device. This state appears after redundancy is configured on the SA device but before Cisco Optical Site Manager is reconfigured.
`STANDBY` with connected active peer information	The device hosts the standby Cisco Optical Site Manager instance and is connected to the active Cisco Optical Site Manager instance.
`Configuration changes`	The `show cosm status` command displays committed Cisco Optical Site Manager configuration changes that are not yet applied by `cosm reconfigure`.
sync-completed, alarm synchronized	The peer device is synchronized in the Cisco Optical Site Manager Devices tab before you activate Cisco Optical Site Manager on that peer device.

Migrate Cisco Optical Site Manager from standalone to high availability

Migrate a running standalone Cisco Optical Site Manager deployment to high availability while preserving persistent Cisco Optical Site Manager data on the active device.

In this task, Device-1 is the device that runs Cisco Optical Site Manager in standalone mode. Device-2 is the peer device that joins the high availability deployment as standby. The cosm reconfigure command applies the committed Cisco Optical Site Manager redundancy configuration on Device-1 without deleting the Cisco Optical Site Manager database on Device-1.

Follow these steps to migrate Cisco Optical Site Manager from standalone to high availability.

Procedure

Log in to Device-1 and verify that Cisco Optical Site Manager is running in standalone mode.
1. Display the Cisco Optical Site Manager running configuration on Device-1.
  Example:
```
DEVICE-1# show running-config cosm
cosm mgmt-interface-name <standalone-management-interface>
```
2. Verify the Cisco Optical Site Manager status on Device-1.
  Example:
```
DEVICE-1# show cosm status
COSM state: APP_ACTIVATED
Role: ACTIVE
```
The show cosm status command shows that the Cisco Optical Site Manager state is APP_ACTIVATED and the role is ACTIVE.
Log in to Device-2 and verify that Cisco Optical Site Manager is installed, but not activated.
Example:
```
DEVICE-2# show cosm status
COSM state: APP_DEACTIVATED
AppMgr app state: DEACTIVATED
Role: UNKNOWN
```
The show cosm status command shows that the Cisco Optical Site Manager state is APP_DEACTIVATED.
In the Cisco Optical Site Manager web UI, onboard Device-2 from the Devices tab of the Cisco Optical Site Manager web UI.

Wait until Sync Status shows sync-completed, alarm synchronized for Device-2.
Configure the Cisco Optical Site Manager high availability settings on Device-1 and commit the configuration.
1. Enter IOS XR global configuration mode and Cisco Optical Site Manager configuration mode on Device-1.
  Example:
```
DEVICE-1# configure terminal
DEVICE-1(config)# cosm
```
2. Configure the Cisco Optical Site Manager management interface and high availability interface.
  Example:
```
DEVICE-1(config-cosm)# mgmt-interface-name <type> <number>
DEVICE-1(config-cosm)# redundancy interface-name <type> <number>
```
3. Configure the peer IP address for Device-2 and the gateway IP address.
  Example:
```
DEVICE-1(config-cosm)# redundancy peer-ip <device-2-redundancy-interface-IP-address>
DEVICE-1(config-cosm)# redundancy gateway-ip <gateway-IP-address>
```
4. Commit the configuration changes and exit all configuration modes.
  Example:
```
DEVICE-1(config-cosm)# commit
DEVICE-1(config-cosm)# end
```
Use the IP address assigned to the redundancy interface on Device-2 for redundancy peer-ip.
Verify that Device-1 has committed Cisco Optical Site Manager configuration changes that still require reconfiguration.
Example:
```
DEVICE-1# show cosm status
COSM state: APP_ACTIVATED
Last error: No error
Role: ACTIVE (standby not connected)
Configuration changes:
```
The output can show Role: ACTIVE (standby not connected) and a Configuration changes section before you run cosm reconfigure. Cisco Optical Site Manager may be unavailable until the reconfiguration is complete.
If the Cisco Optical Site Manager management IP address changes and the certificate contains the previous management IP address, delete the Cisco Optical Site Manager host certificate on Device-1.
1. Display the certificate directory.
  Example:
```
DEVICE-1# dir harddisk:/data/COSM/certs/
host.cert is listed.
<device-2-redundancy-interface-IP-address>-COSM is listed.
```
2. Delete the Cisco Optical Site Manager host certificate.
  Example:
```
DEVICE-1# delete harddisk:/data/COSM/certs/host.cert
Delete harddisk:/data/COSM/certs/host.cert[confirm]
```
3. Confirm the delete prompt.

Run cosm reconfigure on Device-1 and monitor the reconfiguration progress.

The PROTNA alarm is expected until Device-2 connects as the standby Cisco Optical Site Manager instance.

Run the reconfigure command.

Example:

DEVICE-1# cosm reconfigure
Deactivating : execute 'show cosm status' to monitor the progress

Monitor the reconfiguration progress.

Example:

DEVICE-1#show cosm status 
Mon Feb  2 10:52:23.327 UTC
COSM state: APP_ACTIVATED
AppMgr app state: ACTIVATED
AppMgr container state: RUNNING
Container status: Up 3 days
Last error: No error
COSM version: 26.1.1.P1D0108
Role: ACTIVE (connected standby 2.2.2.2-COSM)

Configuration changes:
 
 interface Loopback1
- ipv4 address 5.5.5.5 255.255.255.255
+ ipv4 address 3.3.3.3 255.255.255.255
 !

Device-1 shows the Cisco Optical Site Manager state as APP_ACTIVATED, Last error: No error, and Role: ACTIVE (standby not connected).

Verify the current configuration on Device 1 using the show running-config cosm command.

Example:

RP/0/RP0/CPU0:HAN-1#show running-config cosm 
Wed Feb  4 10:26:59.324 UTC
cosm
 redundancy peer-ip 2.2.2.2
 redundancy gateway-ip 192.168.1.2
 redundancy interface-name Loopback0
 mgmt-interface-name Loopback1
!

Configure and activate Cisco Optical Site Manager on Device-2 as the standby peer.
1. Enter IOS XR global configuration mode and Cisco Optical Site Manager configuration mode on Device-2.
  Example:
```
DEVICE-2# configure terminal
DEVICE-2(config)# cosm
```
2. Configure the Cisco Optical Site Manager management interface and high availability interface.
  Example:
```
DEVICE-2(config-cosm)# mgmt-interface-name <type> <number>
DEVICE-2(config-cosm)# redundancy interface-name <type> <number>
```
3. Configure the peer IP address for Device-1 and the gateway IP address.
  Example:
```
DEVICE-2(config-cosm)# redundancy peer-ip <device-1-redundancy-interface-IP-address>
DEVICE-2(config-cosm)# redundancy gateway-ip <gateway-IP-address>
```
4. Configure the Cisco Optical Site Manager username and password.
  Example:
```
DEVICE-2(config-cosm)# user-name <username>
DEVICE-2(config-cosm)# user-password <password>
```
5. Commit the configuration changes and exit all configuration modes.
  Example:
```
DEVICE-2(config-cosm)# commit
DEVICE-2(config-cosm)# end
```
6. Activate Cisco Optical Site Manager on Device-2.
  Example:
```
DEVICE-2# cosm activate
Activating : execute 'show cosm status' to monitor the progress
```
7. Verify that Device-2 connects as the standby Cisco Optical Site Manager instance.
  Example:
```
DEVICE-2# show cosm status
COSM state: APP_ACTIVATED
AppMgr app state: ACTIVATED
AppMgr container state: RUNNING
Last error: No error
Role: STANDBY (connected active <device-1-redundancy-interface-IP-address>-COSM)
```
Device-2 shows the Cisco Optical Site Manager state as APP_ACTIVATED, Last error: No error, and the role as STANDBY. The status also shows that Device-2 is connected to the active Cisco Optical Site Manager instance.
Verify the migrated high availability deployment.
Confirm these post-migration checks:
- Device-1 runs as the active Cisco Optical Site Manager instance.
- Device-2 runs as the standby Cisco Optical Site Manager instance.
- The peer device is synchronized in the Cisco Optical Site Manager Web UI.
- The PRONTA alarm is automatically cleared after the standby Cisco Optical Site Manager instance connects.

Cisco Optical Site Manager runs in high availability mode. Device-1 hosts the active Cisco Optical Site Manager instance, and Device-2 hosts the standby Cisco Optical Site Manager instance.

What to do next

Create a new database backup after the migration completes.
Do not use the old standalone backup or disaster recovery file for the migrated high availability deployment.
If migration changes the management IP address of the active Cisco Optical Site Manager host device, update the corresponding device entry in Cisco Optical Site Manager with the new management IP address.
If a route processor (RP) swap is required, wait 2 to 3 minutes after the migration completes before you start the RP swap.

Migrate Cisco Optical Site Manager from high availability to standalone

Migrate a Cisco Optical Site Manager high availability deployment to standalone mode when you remove a peer device or roll back a standalone-to-high-availability migration.

In this task, the remaining device is the device that continues to run Cisco Optical Site Manager after the migration. The decommissioned device is the device that you remove from the Cisco Optical Site Manager high availability pair.

Warning
The cosm deactivate command deletes Cisco Optical Site Manager data from the device on which you run the command. Run this command only on the device that you want to remove from the Cisco Optical Site Manager deployment.

Before you begin

Identify the device that continues to host Cisco Optical Site Manager and the device that you want to remove from the high availability deployment.
Verify that the remaining device and the decommissioned device are reachable through the IOS XR CLI.
Record the standalone Cisco Optical Site Manager management interface configuration that the remaining device must use after migration.
Do not start the migration while a software download or activation operation is in progress.
Keep power stable during the cosm reconfigure operation. Do not reload or switch over the devices while reconfiguration is in progress.

Follow these steps to migrate Cisco Optical Site Manager from high availability to standalone.

Procedure

Verify the Cisco Optical Site Manager role on both devices.

Verify the Cisco Optical Site Manager role on the remaining device.

Example:

DEVICE-1# show cosm status
COSM state: APP_ACTIVATED
Last error: No error
Role: ACTIVE (connected standby <device-2-redundancy-interface-IP-address>-COSM)

Verify the Cisco Optical Site Manager role on the decommissioned device.

Example:

DEVICE-2# show cosm status
COSM state: APP_ACTIVATED
Last error: No error
Role: STANDBY (connected active <device-1-redundancy-interface-IP-address>-COSM)

Confirm which device shows Role: ACTIVE and which device shows Role: STANDBY.

If the decommissioned device is active, switch the active role to the remaining device.
1. Switch the active role to the remaining device.
  Example:
```
DEVICE-2# cosm switchover
The remaining device becomes the active Cisco Optical Site Manager instance.
```
2. Verify the role on the decommissioned device.
  Example:
```
DEVICE-2# show cosm status
COSM state: APP_ACTIVATED
Role: STANDBY (connected active <device-1-redundancy-interface-IP-address>-COSM)
```
The decommissioned device displays Role: STANDBY.
Deactivate Cisco Optical Site Manager on the decommissioned device.
1. Deactivate Cisco Optical Site Manager.
  Example:
```
DEVICE-2# cosm deactivate
All COSM data will be deleted, do you want to proceed? [y/N]:
Deactivating : execute 'show cosm status' to monitor the progress
```
2. Enter y at the confirmation prompt.
3. Verify the Cisco Optical Site Manager status on the decommissioned device.
  Example:
```
DEVICE-2# show cosm status
COSM state: APP_DEACTIVATED
AppMgr app state: DEACTIVATED
AppMgr container state: UNKNOWN
Last error: No error
Role: UNKNOWN
```
The decommissioned device shows the Cisco Optical Site Manager state as APP_DEACTIVATED and the role as UNKNOWN.
Remove the Cisco Optical Site Manager high availability configuration from the remaining device and commit the standalone Cisco Optical Site Manager configuration.
1. Enter IOS XR global configuration mode and Cisco Optical Site Manager configuration mode on the remaining device.
  Example:
```
DEVICE-1# configure terminal
DEVICE-1(config)# cosm
```
2. Remove the high availability interface, peer IP address, and gateway IP address.
  Example:
```
DEVICE-1(config-cosm)# no redundancy interface-name
DEVICE-1(config-cosm)# no redundancy peer-ip
DEVICE-1(config-cosm)# no redundancy gateway-ip
```
3. (Optional) Configure the standalone Cisco Optical Site Manager management interface.
  Example:
```
DEVICE-1(config-cosm)# mgmt-interface-name <type> <number>
```
4. Commit the configuration changes and exit all configuration modes.
  Example:
```
DEVICE-1(config-cosm)# commit
DEVICE-1(config-cosm)# end
```
Use the management interface that Cisco Optical Site Manager must use in standalone mode.

Verify that the remaining device has committed Cisco Optical Site Manager configuration changes that still require reconfiguration.

Example:

RP/0/RP0/CPU0:HAN-1#show cosm status 
Tue Jan 27 10:40:12.140 UTC
COSM state: APP_ACTIVATED
AppMgr app state: ACTIVATED
AppMgr container state: RUNNING
Container status: Up 3 days
Last error: No error
COSM version: 26.1.1.P1D0108
Role: ACTIVE

Configuration changes:
 cosm
- redundancy peer-ip 2.2.2.2
- redundancy gateway-ip 192.168.1.2
- redundancy interface-name Loopback0
- mgmt-interface-name Loopback1
-!
-
-interface Loopback1
- ipv4 address 5.5.5.5 255.255.255.255
+ mgmt-interface-name Loopback0
 !

The output can show Role: ACTIVE and a Configuration changes section before you run cosm reconfigure. Cisco Optical Site Manager still runs with the previous runtime configuration until reconfiguration completes.

If the Cisco Optical Site Manager management IP address changes and the certificate contains the previous management IP address, delete the Cisco Optical Site Manager host certificate on the remaining device.
1. Display the certificate directory.
  Example:
```
DEVICE-1# dir harddisk:/data/COSM/certs/
host.cert is listed.
<peer-redundancy-interface-IP-address>-COSM is listed.
```
2. Delete the Cisco Optical Site Manager host certificate.
  Example:
```
DEVICE-1# delete harddisk:/data/COSM/certs/host.cert
Delete harddisk:/data/COSM/certs/host.cert[confirm]
```
3. Confirm the delete prompt.

Remove the high availability certificate directory for the peer device from the remaining device.

Display the certificate directory.

Example:

DEVICE-1# dir harddisk:/data/COSM/certs/
<peer-redundancy-interface-IP-address>-COSM is listed.

Remove the high availability certificate directory for the peer device.

Example:

DEVICE-1# rmdir harddisk:/data/COSM/certs/<peer-redundancy-interface-IP-address>-COSM/
Do you want to delete directory : harddisk:/data/COSM/certs/<peer-redundancy-interface-IP-address>-COSM/ [y|n][y] ?

Confirm the remove directory prompt.

Run cosm reconfigure on the remaining device and monitor the reconfiguration progress.
1. Run the reconfigure command.
  Example:
```
DEVICE-1# cosm reconfigure
Deactivating : execute 'show cosm status' to monitor the progress
```
2. Monitor the reconfiguration progress.
  Example:
```
DEVICE-1# show cosm status
COSM state: APP_ACTIVATED
AppMgr app state: ACTIVATED
AppMgr container state: RUNNING
Last error: No error
Role: ACTIVE
```
The remaining device shows the Cisco Optical Site Manager state as APP_ACTIVATED, Last error: No error, and Role: ACTIVE.
Verify the migrated standalone deployment.
Confirm these post-migration checks:
- The remaining device runs as the active standalone Cisco Optical Site Manager instance.
- The decommissioned device no longer runs Cisco Optical Site Manager.
- The Devices tab of the Cisco Optical Site Manager web UI shows the expected managed devices.
If the removed device is decommissioned, remove it from the Devices tab of the Cisco Optical Site Manager web UI. If you migrate to standalone for another reason, skip this action.

Cisco Optical Site Manager runs in standalone mode on the remaining device.

What to do next

Create a new database backup after the migration completes. Use the new backup for future restore operations.