Cisco Optical Site Manager installation

This chapter describes the Cisco Optical Site Manager installation.

Table 1. Feature History

Feature Name

Release Information

Feature Description

NCS 2000 Node Upgrade

 Cisco NCS 2000 Release 25.1.1

The NCS 2000 nodes will be upgraded from R11.x.x to R25.1.1 to transition the NCS 2000 node management from CTC to COSM.

The source releases that upgrade to R25.1.1 SSON are:

  • R11.1.2.3 SSON

  • R11.1.3 SSON

  • R11.1.3.2 SSON

  • R11.1.1.4 SSON

With this upgrade, you can manage the NCS 2000 nodes in the Node view of the COSM application. The node upgrade is a non-traffic-affecting operation and must be performed in the following order:

  1. NCS 2000 nodes that host the SVO line card.

  2. NCS 2000 nodes that do not have the SVO line card.

  3. NCS 2000 transponder nodes before adding them to the NCS 2000 nodes.

Cisco Optical Site Manager installation workflow on NCS 1010 or NCS 1014

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 Installation requirements.

Perform these tasks to install and configure Cisco Optical Site Manager on NCS 1010 or NCS 1014 devices.

Procedure

Step 1

Install Cisco Optical Site Manager on NCS 1010 or NCS 1014 device. For more details, see Install Cisco Optical Site Manager.

Step 2

Configure Cisco Optical Site Manager in standalone or high availability mode. For more details, see Configure Cisco Optical Site Manager in standalone mode or High availability for NCS 1000.

Step 3

Follow these tasks to setup Cisco Optical Site Manager:

  1. Enable or disable Cisco Optical Site Manager interfaces individually. For more details, see Enable or disable Cisco Optical Site Manager north-bound interfaces.

    Note

     

    By default, these interfaces are enabled

    • NETCONF

    • RESTCONF

    • Interactive Web-UI

  2. Activate Cisco Optical Site Manager. For more details, see Activate Cisco Optical Site Manager.

Installation requirements

This section lists the prerequisites for installing Cisco Optical Site Manager.

These requirements must be met before using Cisco Optical Site Manager to manage NCS 1000 devices.

  • All the Cisco NCS 1000 devices on the network are reachable from the device hosting Cisco Optical Site Manager.

  • SSH is configured on all the devices.

  • Netconf-Yang agent is configured to use SSH for communication.

  • The SSH rate limit is set to 600.

  • Before Release 24.3.1, use the MgmtEth0/RP0/CPU0/1 interface for auto-onboarding of directly connected devices (peer devices). The interface uses IP addresses 192.168.1.1/30 and 192.168.1.2/30.

  • Static routes are added on devices that belong to different subnets or configured as peer devices. For more details, see Configure static routes on peer devices.

Enable NETCONF over SSH on host devices

Enable NETCONF over SSH so that Cisco Optical Site Manager can connect to host devices to perform configuration and monitoring. Also, enable NETCONF on each Cisco Optical Site Manager host device.

Before you begin

Follow these steps to enable netconf:

Procedure

Step 1

Enter the configuration mode using the configure terminal command.

Example:

RP/0/RP0/CPU0:ios#configure terminal

Step 2

Enable NETCONF-YANG agent over SSH connection using the netconf-yang agent ssh command.

Example:

RP/0/RSP0/CPU0:ios(config)# netconf-yang agent ssh

Step 3

Configure the device to use SSH protocol v2 using the ssh server v2 command.

Note

 

Only SSH version 2 is supported. Cisco Optical Site Manager does not accept SSH version 1 connections.

Example:

RP/0/RP0/CPU0:ios(config)# ssh server v2

Step 4

Set the rate limit for incoming SSH connection requests to 600 per minute using the ssh server rate-limit rate-limit command.

Example:

RP/0/RP0/CPU0:ios(config)# ssh server rate-limit 600

Step 5

Enable NETCONF protocol over SSH connection using the ssh server netconf command.

Example:

RP/0/RP0/CPU0:ios(config)# ssh server netconf

Step 6

Commit the changes using the commit command.

After you enable NETCONF, Cisco Optical Site Manager can establish a secure communication with the device using the NETCONF protocol over SSH.

This example describes the commands to enable NETCONF over SSH on the host devices:

RP/0/RP0/CPU0:ios# configure terminal
RP/0/RSP0/CPU0:ios(config)# netconf-yang agent ssh
RP/0/RP0/CPU0:ios(config)# ssh server v2
RP/0/RP0/CPU0:ios(config)# ssh server rate-limit 600
RP/0/RP0/CPU0:ios(config)# ssh server netconf

What to do next

Configure static route on peer devices

Configure static routes on peer devices

Configure static route to ensure that the Cisco Optical Site Manager host device can reach its peer device for management and high availability communication.

In a high-availability setup, two Cisco Optical Site Manager devices located remotely are directly connected through their MgmtEth interfaces.

  • Each device must have either a static route or a routing protocol configuration that defines how to reach the peer’s loopback interface (for example, Loopback 1), using the peer’s MgmtEth interface as the next hop.

  • Static route configuration is optional.

Before you begin

Install Netconf.

Follow these steps to configure a static route on the peer devices:

Procedure

Step 1

Enter the configuration mode using the configure terminal command.

Example:

RP/0/RP0/CPU0:ios#configure terminal

Step 2

Enter the static router configuration mode using the router static command.

Example:

RP/0/RP0/CPU0:ios(config)#router static

Step 3

Configure the IPv4 unicast address static routes using the address-family ipv4 unicast 0.0.0.0/0 default gateway command.

Example:

RP/0/RSP0/CPU0:ios(config-static)#address-family ipv4 unicast 0.0.0.0/0 192.168.2.1

Step 4

Exit the configuration mode using the exit command.

Step 5

Verify the configuration using the show running-config router static command.

Example:

RP/0/RP0/CPU0:ios#show running-config router static
router static
 address-family ipv4 unicast
  0.0.0.0/0 192.168.2.1
 !
!

The Cisco Optical Site Manager host device gains reliable network reachability to its peer devices, enabling effective management and failover operations.

This example describes the commands to configure a static route on the peer devices:

RP/0/RP0/CPU0:ios#configure terminal
RP/0/RP0/CPU0:ios(config)#router static
RP/0/RSP0/CPU0:ios(config-static)#address-family ipv4 unicast 0.0.0.0/0 192.168.2.1
RP/0/RSP0/CPU0:ios(config-static)#exit
RP/0/RP0/CPU0:ios#show running-config router static
router static
 address-family ipv4 unicast
  0.0.0.0/0 192.168.2.1
 !
!

What to do next

Install Cisco Optical Site Manager.

Install Cisco Optical Site Manager

Cisco Optical Site Manager is an optional component available for installation. If Cisco IOS XR is already installed, you can install Cisco Optical Site Manager manually using the provided .rpm files. You can download the Cisco Optical Site Manager software image from the Software Download page.

Before you begin

  • Download 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

Step 1

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

Step 2

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.

Step 3

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

Step 4

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
The latest changes are applied to all processes, including the impacted processes.

Step 5

Commit the changes using the install commit synchronous command.

Example:

RP/0/RP0/CPU0:ios#install commit synchronous

Step 6

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                                                           25.1.1v1.0.2-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                                                           25.1.1v1.0.2-1

What to do next

Configure Cisco Optical Site Manager in Standalone or High Availability mode.