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

PDF

Cisco Optical Site Manager admin plane

Updated: March 2, 2026

Want to summarize with AI?

Log in

Overview

This topic describes the Cisco Optical Site Manager admin plane, including its role in instance lifecycle management, high-availability coordination, and network configuration for NCS 2000 SVO card deployments.

Cisco Optical Site Manager admin planes are management interfaces that

  • install and manage Cisco Optical Site Manager network element instances,

  • coordinate active and standby roles between paired SVO cards, and

  • use shared network configuration data to automate instance deployment and recovery behavior for Cisco NCS 2000 SVO card deployments.

Core functions

The admin plane is available only for the Cisco NCS 2000 SVO card.

The admin plane provides a web user interface for creating, updating, monitoring, and deleting Cisco Optical Site Manager instances.

During instance creation, you can set the management interface address, while the admin plane selects the remaining parameters from the constraints defined in the shared configuration file.

The shared configuration file stores the networking data that both SVO cards use for admin plane operation.

High-availability behavior

In an SVO card deployment, two Cisco Optical Site Manager line cards reside in different ROADM node chassis and form a redundant pair.

The cards communicate through the HA network as the primary link and through the devices network as the secondary link. The primary link also replicates configuration transactions from the active Cisco Optical Site Manager instance to the related standby instance.

The admin planes automatically assign active and standby roles and perform automatic switchover when a software or hardware fault affects the active instance.

Administrative capabilities

The admin plane supports these common administrative actions:

  • Create the super user for the SVO card model.

  • Create, update, delete, and view Cisco Optical Site Manager instances of type ROADM, OLA, DGE, or TXP.

  • Control, monitor, and run health checks for Cisco Optical Site Manager instances.

  • Trigger automatic or manual switchovers between active and standby instances.

  • View network configuration parameters and the allowed or blocked IP address lists.

  • Download diagnostic log files and reset the SVO card to factory defaults.

Key limits

  • The super user must exist before you can log in to the admin plane.

  • The deployment supports only IPv4 address configuration.

  • Only one ROADM Cisco Optical Site Manager instance can exist; subsequent instances must use the OLA, DGE, or TXP type.

  • Resetting the SVO card removes all containers and configurations.

Log in to the admin plane

Use this task to access the Cisco Optical Site Manager admin plane.

Only the super user can log in to the admin plane.

Create the super user account before you log in.

Before you begin

Ensure that the super user account is created. See Create the admin user.

Procedure

1.

In a web browser, enter the admin plane URL: https://IP_address/login.
2.

Enter the username in the Username field.
3.

Enter the password in the Password field.
4.

Click Login.

The COSM Instances page opens.

Admin Plane home page

This topic explains admin plane home page in the Cisco Optical Site Manager admin plane. It describes key behavior, required inputs, and operational considerations so you can understand the feature before configuration, monitoring, or troubleshooting.

Side menu items

In the Cisco Optical Site Manager Admin Plane home page, the menu items are present in the left panel. The menu items allow you to monitor and troubleshoot Cisco Optical Site Manager instances, view certificates, and restart admin plane. The following list describes the menu items.

  • Instances—Create, edit, and monitor Cisco Optical Site Manager instances.

  • Diagnostics—Download log files to troubleshoot Cisco Optical Site Manager instances.

  • Networks—Configure networks and assign IP addresses.

  • Certificates—View and renew the self-signed admin plane certificates.

  • Statistics—Monitor and download collected memory allocation and usage details for each Cisco Optical Site Manager instance.

  • Tools

    • Utilities—Restart the admin plane, reset of SVO-LC card to factory defaults, and reset and erase all data to prepare the system for a fresh installation.

    • Properties—Configure admin plane properties, including monitor timeout and file transfer timeout.

  • Scripts—Create and manage custom scripts that extend the admin plane by adding UI and REST actions, validations, data exports, event-driven tasks, and scripted HA services.

  • Users—Create and manage user accounts for the Cisco Optical Site Manager Admin Plane.

Device synchronization and alarm status icon

The device synchronization and alarm status are indicated as a summary icon with changing colors close to the bell icon. The icon indicates the device synchronization and alarm status with respective colors. The icon color changes from lower to a higher priority. The icon statuses are:

  • Green—All the defined devices are connected and synchronized. The device status is alarm-synchronised.

  • Orange—One or more devices are disconnected or locked by the user. The device status changes as sync-not-started, sync-configuration, and sync-operational.

  • Red—One or more devices have sync-error, sync-not-completed, or out-of-sync-alarms.

Note

The icon appears only when you synchronize a device.

Bell icon (HA status)

The icon on the top right of the Cisco Optical Site Manager home page indicates the status of high availability network (primary link) and devices network (secondary link). The icon statuses are:

  • Green—Both the primary and secondary links are up. High availability is working successfully.

  • Yellow—A warning that the primary link is up but the secondary link is down.

  • Red—There are two cases:

    • Small red icon—The primary link is down but the admin planes are able to communicate because the secondary link is up.

    • Large red icon—Both the primary and secondary links are down and the server is functioning in standalone mode.

User profile icon

The user profile icon displays the username and the log out option for the user to exit the current Cisco Optical Site Manager session.