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

PDF

Enable or disable Cisco Optical Site Manager north-bound interfaces

Updated: March 2, 2026

Want to summarize with AI?

Log in

Overview

Learn how to enable or disable Cisco Optical Site Manager north-bound interfaces (NETCONF, RESTCONF, and Web-UI) using IOS XR and COSM configuration modes. Use this procedure to configure interface availability, modify the default NETCONF port if required, and commit changes to control management access.

Cisco Optical Site Manager provides three north-bound interfaces. By default, all these interfaces are enabled. If required, individual interfaces can be disabled.

  • NETCONF

  • RESTCONF

  • Interactive Web-UI

Warning

Disabling all the interfaces will make Cisco Optical Site Manager inaccessible!

This configuration is optional and must be completed before activating Cisco Optical Site Manager on the device. Use the device's CLI in COSM configuration mode to enable or disable interfaces individually. The default NETCONF port is 2022. You may change this port during configuration.

Before you begin

Ensure that Cisco Optical Site Manager is configured Standalone or High Availability mode.

Follow these steps to enable or disable Cisco Optical Site Manager north-bound interfaces.

Procedure

1.

Enter IOS XR and COSM configuration modes using the configure terminal and cosm commands.

Example:

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

(Optional) Configure the NETCONF port if you want to use a port other than 2022 using the netconf port port-number command

Example:

RP/0/RP0/CPU0:ios(config-cosm)#netconf port 2021
Configures the specified port for the NETCONF SSH server. If no port is specified, port 2022 is used by default.
3.

Enable or disable the Cisco Optical Site Manager interfaces using the <interface-name> enable | disable command.

Example:

RP/0/RP0/CPU0:ios(config-cosm)# netconf enable
RP/0/RP0/CPU0:ios(config-cosm)# restconf disable
RP/0/RP0/CPU0:ios(config-cosm)# webui enable
Enables or disables the specified Cisco Optical Site Manager interfaces.
4.

Commit the changes using the commit command.

After configuration changes are committed, the application operates with the specified interface availability. Only enabled interfaces are accessible for management and monitoring, and disabled interfaces do not accept connections.

What to do next

Activate Cisco Optical Site Manager