The following list points to the installation requirements for different Routed Optical Networking components.

• Cisco Optical Network Planner

• Cisco WAN Automation Engine 7.5.0

• Cisco NCS 2000 Shelf Virtualization Orchestrator 12.3.x

• Cisco Crosswork Cluster, Crosswork Data Gateway, and Crosswork Applications

• Cisco Optical Network Controller 2.0

• Cisco Evolved Programmable Network Manager 6.1

• Cisco Network Services Orchestrator 5.7.6.2

  • Cisco NSO Routed Optical Networking Core Function Pack 1.0

  • Cisco NSO Transport-SDN Function Pack Bundle User Guide 4.1

  • Cisco Network Services Orchestrator DLM Service Pack Installation Guide 4.4.0

Perform these steps to add SR-PCE providers, NSO providers, and routers to Crosswork Network Controller.

Note	When you add or import devices, or create providers, you need to specify the credential profile.

1. Log in to the Crosswork user interface.

2. To create a credential profile, choose Device Management > Credential Profiles from the main menu. See Manage Credential Profiles.

   1. For the NSO credential profile, the connectivity type must be set to NETCONF and HTTPS. Optionally, HTTP can also be defined if HTTPS is not used in NSO.

      

   2. The SR-PCE credential profile requires HTTP credentials to communicate with the SR-PCE Northbound API.

      

   3. The router credential profile requires at a minimum, the SNMPv2 or SNMPv3 and SSH connectivity types. NETCONF is optional. GNMi is used when utilizing GNMi to configure streaming telemetry sensors on the node.

      

3. Add the providers. See About Adding Providers.

   1. To add the SR-PCE or NSO provider, choose Administration > Manage Provider Access from the main menu. See Manage Providers.

   2. Add the NSO provider. See Add Cisco NSO Providers.

      Select the credential profile created for NSO. Select the family as NSO. The Device Key may be set to either the HOST_NAME or INVENTORY_ID depending on the specific deployment.

      The following image demonstrates the connectivity to NSO’s RESTCONF API over SSL using port 8888 and NETCONF using the default port of 2022. Since the Routed Optical Networking NSO CFP utilizes the XR NETCONF NED, the Cisco-IOS-XR model is not applicable and may be set to any version.

      

   3. Add the SR-PCE provider. See Add Cisco SR-PCE Providers.

      Select the credential profile created for SR-PCE. Select the family type as SR_PCE. The connectivity type for SR-PCE must be the HTTP. In the following image, the default API port of 8080 is specified. When the Property Key, "auto-onboard" is set to a Property value, "off", Crosswork Network Controller does not automatically add nodes that are discovered via the SR-PCE IGP topology to the device inventory. Devices must be added through the Crosswork Network Controller UI or inventory API.

      

4. Validate communications with one or more providers. Check on the provider's reachability using the steps in Get Provider Details.

5. Onboard devices. See Add Devices Through the UI.

   1. The Administration State, Reachability Check, and Credential Profile are mandatory elements. The Host Name must be used if the NSO provider device key is set to the Host Name value. If the NSO provider device key is set to Inventory ID that field must be populated. The Software Type, Software Version, UUID, Serial Number, MAC address, and Product Type are filled by device discovery. Optionally, tags can be applied to the device. The GNMI encoding type can be set to JSON or PROTO.

      

      Optionally, location information can be entered. Latitude and Longitude information place the node at a specific location on a geographic map.

      Add the previously configured NSO provider as a provider for the device.

      

   2. Attach the devices to an active Cisco Crosswork Data Gateway pool to manage them (device discovery).

      Review the Data Gateways pane (see Overview of Cisco Crosswork Data Gateway). The operational state of the Cisco Crosswork Data Gateway pool to which you want to attach devices must be Up.

      Follow the steps in Attach Devices to Cisco Crosswork Data Gateway.

      

Prerequisite

When you work with Crosswork Hierarchical Controller adapters you are required to use credentials. These credentials are used for authentication when a device is assigned to an adapter. The same credentials may be shared by multiple adapters. The credentials are added under the Services > Device Manager > Credentials tab in the Crosswork Hierarchical Controller GUI. The adapters needed for the Routed Optical Networking solution are:

Note	If Cisco Optical Network Controller and Crosswork Network Controller are on the same Crosswork cluster, they can use the same credential profile.

To add the adapters, perform the following steps:

1. In the applications bar in Crosswork Hierarchical Controller, select Services > Device Manager > Adapters.

2. Click Add new adapter.

3. Enter the adapter details:

   • Adapter Type: Select an adapter type from the list of available adapter types currently installed in Crosswork Hierarchical Controller.

   • Adapter Name: Unique user defined name of this adapter type instance (there can be several instances of the same adapter type).

4. To configure the adapter, select the adapter in the Adapters pane. Configure the parameters as displayed in the following images.

   • Crosswork Network Controller Adapter:

     Note	API version for Crosswork Network Controller must be V2.

     

     Note	The Full Data Fetch Interval must be set to 300s or higher in a production network.

     The following parameters must be configured for Crosswork Network Controller notifications and collection.

     

   • IOS-XR Adapter

     

     Note	The Polling Cycle should not be less than 300s in a production network. Concurrency can be increased. The Logging Level must be set to Info if everything is working correctly.

     The following collection parameters must be configured. These parameters collect optical power values for the link assurance application.

     

     The status of the devices must be ok in the Devices tab after the addition and completion of a successful collection cycle.

     

     To add routers to Crosswork Hierarchical Controller, click the Managed Devices tab and then + Add Device.

     

     It is recommended to use the hostname+hco (ron-8201-1-hco) or the device IP address. The device must be assigned a site for it to be displayed in the Explorer UI.

     Assign both the IOS-XR and Crosswork Network Controller adapter type to the device. Do not enable discovery for the Crosswork Network Controller adapter.

     

   • Cisco Optical Network Controller Adapter

     The Polling cycle must be set to 300s or higher in a production network. Polling retrieves TAPI SIPs, topology, and connectivity services. The URL in the following figure is for the Cisco Optical Network Controller cApp installed on the CW cluster.

     

     The optical nodes are discovered automatically from Cisco Optical Network Controller. Nodes must be assigned a site for it to be displayed in the Explorer UI.

     

   • Crosswork Network Controller Crosswork Data Gateway Adapter

     Crosswork Network Controller Crosswork Data Gateway adapter is used to collect telemetry data via gNMI to the router. In Crosswork Network Controller, the routers must be configured with the gNMI protocol with the encoding type set to “PROTO” and the GNMI capability enabled. In IOS XR, the routers must be configured for gRPC so that Crosswork Data Gateway can create gNMI telemetry subscriptions.

     

     The Crosswork Data Gateway adapter is configured to connect to Crosswork Network Controller controlling Crosswork Data Gateway instance. It can be the same as the Crosswork Network Controller used for the topology or a different Crosswork Network Controller. The collection parameters describe the supported telemetry collection jobs. The statistics show up in the physical interface statistics and in the Link Assurance application.

     

   • The device name in Cisco Crosswork Hierarchical Controller must match the device name in Crosswork Network Controller for successful deployment. If successful, you will see Cisco Crosswork Hierarchical Controller as a new destination in Crosswork Network Controller. This is setup by Cisco Crosswork Hierarchical Controller and user interaction is not required. As Crosswork Data Gateway is enabled on devices, new collection jobs are populated. A single collection job is available for each router collecting multiple KPIs.

     

     

Perform the following steps to provision the Routed Optical Networking ML service using the NSO Web UI.

1. To add a new device, perform these steps:

   1. In the Device manager, click the + to add a new device. Specify a name for the new device. Click Confirm.

      

   2. After creating the new device, click the device name to fill required and optional parameters. In this screen, the required parameters are the authgroup and IP address of the device.

      

   3. Scroll down in the device configuration screen. Click the “device-type” to bring up the device type selection screen. The device-type that is supported in the Routed Optical Networking ML FP is IOS-XR CLI NED.

      

   4. Click the blue NETCONF text to select the proper NED. The Routed Optical Networking ML FP requires the use of the cisco-iosxr-nc-7.3 NED.

      

   5. Click the Commit manager to view the NSO CLI configuration being applied. Click Commit to save the device configuration to NSO.

      

2. To configure the interlayer link service in NSO, perform these steps:

   1. In the Service manager, select the inter-layer-link service point from the drop-down list.

      

   2. Specify the end-point-device and the line-port. These are required values. The end-point-device is the 8201 router. Specify the router optics port that is connected to the optical line system add/drop port in the line-port field. Click Confirm.

      

   3. In the Configuration editor, edit the inter-layer-link service by clicking the newly created draft service to complete the information required. In this example, we add the site name, optical add/drop network element, and the optical add/drop port. The optical-controller field specifies the Optical Network Controller instance to be used for provisioning. This parameter is optional if a global instance is defined. A global Cisco Optical Network Controller instance can be set in NSO and will be used if the field is not populated. The add/drop port corresponds with the inventory ID of the physical port on the NCS1K-MD-64-C multiplexer corresponding to a frequency XXXX.YY. Both the RX and TX directions are included as part of the add/drop reference. In addition to specifying the network-element and add/drop in R/S/I/P form, a TAPI SIP can also be used to identify the add/drop port.

      

      These elements are the only required elements in the inter-layer-link service type.

   4. Perform Ols-domain optical-service-interface configuration.

      • Optical-controller specifies the Cisco Optical Network Controller instance managing the OLS.

      • Network-element specifies the optical element name as show in TAPI topology.

      • Optical-add-drop specifies the port to be used on the optical network element.

        

      • The optical-service-interface can also be added as a TAPI SIP UUID.

        

   5. Click the config tab in the Commit manager to see the NSO CLI configuration that will be committed to NSO.

      

   6. Click Commit in the upper right corner to commit the service. An end-to-end service requires two inter-layer-links, one for each router connected to its optical line system add/drop port.

      

   Note

   Next we add the multilayer end-to-end service to configure and provision both the optical line system and routers. We recommend you to click check-sync in the Device manager to ensure that the device configuration is properly in sync with NSO before provisioning. If the device is out of sync, initial provisioning fails.

3. To create Routed Optical Networking ML service, perform these steps:

   1. In the Service manager, select the Routed Optical Networking ML service point from the drop-down list. When we create the new Routed Optical Networking ML service, the required components are the service name, mode of the service (transponder or muxponder), and the bandwidth. The bandwidth corresponds to the line rate of the ZR/ZR+ optics. Click Confirm.

      

   2. In the Configuration editor, click the newly created service name for editing the additional parameters that are required for the service. In this example, we set the circuit-id name in the global parameters. The frequency is set by the optical controller based on the specified optical add/drop port. The dac-rate is set to the default value.

      Note

      User configuration global options are frequency and dac-rate If OLS provisioning is being performed and OLS can provide the frequency, it is optional, otherwise frequency must be provided. Dac-rate controls the TX shaping parameters: 1x1.25 = enabled, 1x1 = disabled. Leaving it blank uses system default of enabled, and can be used in most circumstances

   3. After the ols-domain is added, you must add end-points to the circuit. Two end-points are always required. The end-points are the routers with ZR/ZR+ optics.

      

   4. Add the end-point-device to the service. Click Confirm.

      

      After the end-point is created, click the end-point to edit the end-point parameters. The line-port is a required parameter and refers to the optics port on the router. In this example, this is the same as the line-port specified in the inter-layer-link service for the end-point router.

      

      The transmit-power is an optional parameter for end-to-end provisioning. If it is omitted the optical controller (Cisco Optical Network Controller) will provide the transmit power. Transmit power sets the transmit power, the value is in 100*value in 0.1dBm increments. For example, –100 is -10dBm. If no value is specified the default of -10dBM is used for QDD-400G-ZR-S or QDD-400G-ZRP-S, or 0dBm for DP04QSDD-HE0 (Bright ZR+). The transceiver-capability field specifies the optic type and is only required if no packet layer configuration is being performed. In this example, you are performing packet layer provisioning so specifying the transceiver capability is not required.

      Add the line-port of 0/0/0/20 to the Routed Optical Networking ML service.

      

   5. Click end-point to go back to the top-level endpoint configuration, click terminal-device-packet to configure Ethernet/IP parameters

      

      Note

      Ethernet/IP configuration is optional. Bundle configuration adds an interface to an existing bundle or creates a new bundle and adds the newly created IP interface to it. Interface configuration is used for configuring IP address parameters on newly created Ethernet interfaces. In this example we add a new Bundle and assign an IP address to the Bundle.

   6. Click the plus sign next to bundle to add a bundle, in this case with an identifier of 500. This creates a bundle interface Bundle-Ether 500 on the endpoint router

      The interface index for a bundle use case is always 0. In case of a non-bundle configuration in muxponder mode, the index can be 0–3 representing the number of interfaces created as part of the muxponder configuration.

      

   7. Click the bundle number and ip-address to configure an IP address on the bundle.

      

   8. Return to the top-level endpoint configuration, select the index 0 previously created and click membership to add the interface to the bundle

      

      Note	Bundle-id selects the previously created bundle. Mode sets the bundle LAG signaling mode. Active=LACP, passive=LACP listener only, on=No active signaling, inherit=Inherit signaling from Bundle interface configuration. Default is active.

   9. Return to the top level of the service configuration and similarly configure the second endpoint.

      

   10. Click ols-domain to enable OLS provisioning through Cisco Optical Network Controller.

       

   11. Select “Unlocked” under service-state, no additional configuration is necessary as all configuration needed for OLS provisioning is part of the interlayer link and the rest of the ron-ml service.

       

   12. Click SRLG to perform SRLG configuration

       

       Note

       Configuration options are to specify a preconfigured group, a list of numeric SRLG values, or a list of SRLG names associated with preconfigured name:value pairs. Each type can be populated in the same configuration. In this example we specify a list of explicit numeric values. An index is used along with the numeric value.

4. In the Commit manager, click the config tab. The NSO CLI configuration for the end-to-end service is displayed. If the ols-domain component is not specified in the global configuration, no optical line system provisioning is performed, only router provisioning. You can preview and then commit the configuration.

   

5. Verify status in NSO UI.

   You can verify the status by inspecting the plan associated with the service. You can find the plan under the main ron-ml configuration which you can access by clicking the top portion of the service configuration. An example is highlighted in the following image.

   

   1. Inspect the plan by clicking on the newly created service

      

      If all steps are green and complete, the service has been properly deployed to the network

      

   2. Inspect router configuration.

      The show configuration commit changes last 1 command shows the CLI config applied to the device during the NSO provisioning.

      The show optics controller 0/0/0/20 command verifies the operational status.

      

1. To create the router DCO port to the NMC cross-connect:

   1. In the applications bar in the Crosswork Hierarchical Controller, click the NMC Cross Connections icon.

      

      The Network Media Channel (NMC) is the service across the optical line system of the network.

   2. Click the magnifying glass icon in the Router OCH port field.

      The application displays routers and ports with ZR/ZR+ transceivers in the Advanced tab in a new window. The description indicates whether it is a ZR or ZR+ transceiver.

   3. Select the router ZR/ZR+ optics interface. In this case, select ron-ncs57c3-1 0/0/0/20. Click OK after selecting the port. You can filter the selection criteria by clicking on the down arrow in each column.

      

   4. Click the magnifying glass icon in the Optical NMC port field.

      The app displays optical devices and ports. Due to the potentially long list of ports, it is best to filter the selection criteria.

      

      Select the optical add/drop port. In this case, select 0/1/0/6 port on ron2_olt1 and click OK.

      

      

   5. After the router and optical interfaces are selected, click Add to add the NMC cross-connect.

      

   6. Select and add second router port, ron-5504-1 0/0/0/0 and OLS add/drop port, ron2_olt2 0/3/0/6.

      

2. To provision the Routed Optical Networking IP link, perform these steps:

   1. In the applications bar in the Crosswork Hierarchical Controller, click the Services Manager icon.

      

   2. Select the Point to Point tab and click IP Link from the Create New P2P drop-down list to start the provisioning process.

      

      The IP Link Creation wizard appears.

      

   3. Enter the Cisco Crosswork Hierarchical Controller service name, description of the router optical controller, and the link type in the General tab.

      

      (Optional) Check the Router Configuration Only check box to configure only the router optical controller and IP information and not the optical line system. This configuration is used when the OCHNC is created outside Cisco Crosswork Hierarchical Controller.

      ​

      

   4. Select the two router ports in the service. This is done by selecting the Site and Port. ​The transmit power for each endpoint is an optional parameter. The default TX power is used if no value is provided.

      

   5. Click the magnifying glass icon to select the site. The site can be selected either by selecting from the list or by using the 3D Explorer.

      

   6. Click the magnifying glass icon to select the router port.

      The ports are displayed based on the following criteria:

      • Is a ZR/ZR+ interface

      • Has no existing optics configuration

      • Has a proper NMC cross-connect configured

      

   7. Select the second site using the 3D Explorer. VAL is the site of the other endpoint router and port.

      

   8. Select the second router port.

      

      Both the router ports are selected.

      

   9. (Optional) Enter the IP address information for interfaces. If IP addresses are not entered, ZR/ZR+ router optical configuration happens; however, IP addresses are not configured.

      

   10. In the optical path configuration, optical node exclusion can be configured. The frequency can be manually set in this step. In router only configuration, the frequency is mandatory. If OLS provisioning is performed, Cisco Optical Network Controller returns the proper frequency to be configured on the router endpoints; hence, the frequency may be omitted. In this case, the manual frequency is set to the same value returned by Cisco Optical Network Controller.

       

   11. Click Next to review the final configuration. Click Finish to start provisioning, or click Save to save for later provisioning.

       

   12. The progress of provisioning is shown in the Services Manager​.

       

   13. Click the Operations > Logs tab to view the provisioning API calls used and responses.

       

   14. If the provisioning is successful, the Configuration State field changes to INSTALLED state and the Operational State field changes to UP​ state.

       

   15. Click the Summary tab to see the new service link and click the square to show the new link in the 3D Explorer view​.

       

   16. 3D Explorer view highlights the new logical router link along with the underlying optical path that is shown in Green.

       

   17. Click Path to show the full multilayer path including each optical line system segment​.

       

3. The Link Assurance app can be used to inspect the end-to-end link path.

   

   Select a specific layer to show PM data (ZRM, OCH, and OTS layers only).

   

   Select a specific port to show PM data for the port​.

   

This section adds the 8201 router to EPNM for monitoring the PM parameters on the ZR or ZR+ optics.

1. To add a new device to EPNM choose Inventory > Device Management > Network Devices. Click Routers or a subgroup if it is already defined in the left panel.

   

2. Click the icon above the Network Devices table, then choose Add Device.

   

3. Configure the General, SNMP, and SSH parameters as seen in that following figures. Click Verify Credentials to validate that Cisco EPN Manager can reach the device. Click Add to add the device to EPNM.

   

   

   

4. To open the chassis view from the Network devices table, click the device name link. The following figure displays the chassis view of the 8201 router.

   

5. Click the QSFP-DD ZR+ port to see specific data about that port.

   

   Here you can view the port and specific optical channel and CoherentDSP entities.

   

6. Clicking the additional information icon for the optical channel and then the Optical Physical measurement tab displays the relevant optical PM values such as RX/TX signal power and OSNR values.

   

7. Clicking the additional information icon for the coherent DSP and then the FEC measurement tab displays the relevant coherent DSP FEC statistics such as PreFEC Bit Error Rate, Bit Error Rate Count (BIEC), and Uncorrected Words (UCW). The UCW value must remain 0.

   

The following figures display the current and historical performance monitoring data in EPNM that is specific to the ZR or ZR+ optics.

Perform the following steps to create KPI Profiles in Health Insights and enable them on the devices to monitor network health.

Note	Plan which Cisco-supplied KPIs you want to begin using, based on each device's function and the device performance characteristics you want to monitor. Review the Cisco-supplied KPIs documented in List of Health Insights KPIs. In the following image, you see the available default L1 optics KPIs.

1. Group the relevant KPIs to form a KPI Profile. A KPI profile can have many different KPIs assigned. In this case, the focus is only on some specific optics KPIs to add to the optics_profile KPI profile.

   

   See Create a New KPI Profile.

2. Enable the appropriate KPI Profiles on the devices you want to monitor. From the main menu, choose Performance Alerts > Enable/Disable KPI Profiles. Check the checkboxes of all the nodes to which the profile must be applied to, and click Enable KPI Profiles.

   Multiple nodes may be selected. In the following figure, we are applying the KPI profile to a single node.

   

3. Select the optics_profile KPI profile that was created in the previous step and click next to finalize enabling the KPI for the selected device.

   

4. The following image displays the final page before enabling the KPI profile for the router. After you click Enable, the appropriate configuration is applied to the router to begin streaming the telemetry sensors data for the selected optical KPIs.

   

   See Enable KPI Profiles on Devices.

5. To view alerts from network devices, see View Alerts for Network Devices.

   The following figure displays the RX and TX power of the QDD-400G-ZR-S transceiver.