Cisco Crosswork Optimization Engine 4.0 Release Notes
This document provides information about Cisco Crosswork Optimization Engine, including product overview, new features and functionality, compatibility information, and known issues and limitations.
Overview of Cisco Crosswork Optimization Engine
Network operators are facing challenges to support the exponential growth of network traffic while addressing the pressure to efficiently run network operations. They need a toolset to help automate bandwidth optimization and efficiently steer traffic with little operator intervention. Cisco Crosswork Optimization Engine fulfills this need by providing real-time network optimization capabilities that allow operators to effectively maximize network utility as well as increase service velocity.
Looking at the following figure, Cisco Crosswork Optimization Engine is built to fulfill the need for a closed-loop optimization loop as described under “Near Real-Time Feedback Loop”. Through Cisco Crosswork Optimization Engine, the operator is able to define the optimization intent, implement the intent, and continuously monitor, track, and react to maintain the original intent.

Real-time Visibility
To run their network effectively, end-to-end visibility is important to any network operator. Cisco Crosswork Optimization Engine not only provides this visibility, but also the ability to visualize the network across different layers (optical to IP) and the relationship between each layer. Cisco Crosswork Optimization Engine leverages IETF-standard BGP-LS protocol to discover IP network automatically, including the following features:
-
Real-time visibility: Provides the network operator with a true representation of the actual topology
-
Hierarchical topology view: Enables operators to define the different levels of granularity in the topology visualization
Simplified SR-TE Policy and RSVP-TE Tunnel Lifecycle Management
Cisco Crosswork Optimization Engine also provides an easy to use UI and API to manage and monitor the TE tunnel lifecycle. The UI and API enables the network operator to perform the following tasks:
-
Visualize SR-TE (SR-MPLS and SRv6) policies and RSVP-TE tunnels.
-
Create, modify, and remove SR-MPLS policies and RSVP-TE tunnels using an intuitive workflow
-
Continuously track SR-MPLS policies and RSVP-TE tunnels and use dynamic path computations to maintain SLA objectives
-
Preview an SR-MPLS policy or RSVP-TE tunnel before deploying it to the network
Extensibility through Feature Packs
Crosswork Optimization Engine feature packs provide congestion mitigation and closed loop bandwidth optimization. A user defines the bandwidth optimization intent and the tools implement the intent, and continuously monitor, track, and react to maintain the original intent. A user can also define network congestion thresholds and configure whether to have the tool automatically remediate congestion or provide mitigation suggestions the operator can choose to act upon.
Due to licensing or the configuration of the role associated with your user account, you may not be able to access all of the features and functions. For licensing and ordering information, work with your Cisco Partner or Cisco Sales representative to review options described in the "Cisco Crosswork Optimization Engine Ordering Guide".
What's New
This section lists new features and changes delivered in Cisco Crosswork Optimization Engine 4.0. For system requirements information, see the Cisco Crosswork Infrastructure and Applications Installation Guide.
|
Feature |
What's New? |
||
|---|---|---|---|
|
Segment Routing Tree Segment Identifier (Tree-SID) Visualization |
You can now visualize Tree-SID policies implemented in a network that uses the Segment Routing Path Computation Element (SR-PCE) using path computation element protocol (PCEP). You can view the Tree-SID details of the root, transit, leaf, and bud nodes. Visualization provides an easier way to confirm that Tree-SID is implemented correctly in your network.
|
||
|
Traffic Engineering Dashboard |
Crosswork Optimization Engine now supports TE Dashboard that provides a summary of SR-MPLS, RSVP-TE tunnel, SRv6, and Tree-SID policy information. To view the historical data, from the main menu, choose Traffic Engineering > Traffic Engineering. For every policy/tunnel, there is a new Historical Data tab that displays the traffic history and the path and state change event for the same. TE Dashboard also shows underutilized policies and top 'n' policies by events. The configuration for TE affinity, and unused utilization threshold can be found in . |
||
|
Policy and Tunnel Provisioning |
|
||
|
SRv6 Support |
|
||
|
Flexible Algorithm Support |
|
||
|
Global PCE Maximum Latency Support |
Crosswork now supports the global maximum latency value that is set manually on the PCE (via the CLI or NETCONF). For example: Device-IOS-XR-771(config-pce)#constraints bounds cumulative type latency <max-latency-value>If this value is configured on the device, then the SR-PCE will only allow LSPs within the threshold. This feature applies to dynamic policies with the metric type set to Latency. This is useful for advanced network users who are interested in paths with a lower latency.
|
||
|
Local Mitigation Congestion (LCM) |
For more information, see Configure LCM. |
||
|
Device PCEP Session Details |
Device PCEP session information is now displayed in the Device Details page (Traffic Engineering topology map > device-icon > Details tab). |
||
|
Bandwidth on Demand (BWoD) |
Extended existing support for MSDs to PCC-initiated BWoD policies. BWoD now computes a path to comply with the manually
configured MSD constraint ( |
||
|
Device Grouping |
Device group visualization enhancements have been made. For more information, see View Device Group to Filter you Topolygy View. |
||
|
Multivendor Support |
You now have the ability to customize Device Package templates to support certain vendor specific traffic statistics. Contact your Cisco Crosswork Customer Experience representative for details. |
||
|
APIs |
The following API features have been updated:
For more information, see the Cisco Crosswork Network Automation API Documentation on Cisco DevNet. |
Compatibility Information
The following table details Crosswork Optimization support for IOS Versions, SR-PCE, and Cisco devices. A later table indicates compatibility with Cisco Crosswork applications, NSO Function Packs, and browsers.
Cisco IOS Support
SR-PCE Cisco IOS version 7.7.1 has been validated to work with Crosswork Optimization Engine 4.0 features. Other listed PCC versions are supported, but may not support all Crosswork Optimization Engine features because of PCC version limitations.
![]() Note |
Software Maintenance Updates (SMUs) are required for both PCC/Headend and SR-PCE versions indicated in the table. To download the Cisco IOS XR versions and updates, see the IOS XR Software Maintenance Updates (SMUs) document. The correct SMUs to download will have "Optima" or the bug ID appended to the filename. For example: asr9k-x64-6.6.3.Optima.tar or xrv9k-7.3.1.CSCvy63506.tar. |
|
Cisco IOS XR or XE Version |
Cisco ASR 9000 (32-bit) |
Cisco ASR 9000 (64-bit) |
Cisco XRv 90001 | Cisco 8000 series | Cisco NCS 5500 series |
Cisco NCS 540 series2 |
Cisco NCS 560 series |
Cisco ASR 920 |
Cisco ASR 903 RSP 3 |
|---|---|---|---|---|---|---|---|---|---|
|
6.5.3 |
|
|
|
|
|
|
|
NA |
NA |
|
6.6.3 |
|
|
|
|
|
|
|
NA |
NA |
|
6.7.2 |
|
|
|
|
|
|
NA |
NA |
|
|
7.0.2 |
|
|
|
|
|
|
|
NA |
NA |
|
7.1.2 |
|
|
|
|
|
|
|
NA |
NA |
|
7.2.1 |
|
|
|
|
|
|
|
NA |
NA |
|
7.3.1 |
|
|
|
|
|
|
|
NA |
NA |
|
7.3.2 |
|
|
|
|
|
|
|
NA |
NA |
|
7.4.1 |
|
|
|
|
|
|
|
NA |
NA |
|
7.4.2 |
|
|
|
|
|
|
|
NA |
NA |
|
7.5.2 |
|
|
|
|
|
|
|
NA |
NA |
|
7.6.1 |
|
|
|
|
|
|
|
NA |
NA |
|
7.7.1 |
|
|
|
|
|
|
|
NA |
NA |
|
17.4.13 |
NA |
NA |
NA |
NA |
NA |
NA |
NA |
|
|
|
17.5.1 |
NA |
NA |
NA |
NA |
NA |
NA |
NA |
|
|
|
17.6.3 |
NA |
NA |
NA |
NA |
NA |
NA |
NA |
|
|
|
17.7.1 |
NA |
NA |
NA |
NA |
NA |
NA |
NA |
|
|
|
17.8.1 |
NA |
NA |
NA |
NA |
NA |
NA |
NA |
|
|
![]() Note |
|
Cisco Crosswork Application, NSO Function Pack, and Browser Support
The following table lists software versions that have been tested and are known to be compatible with Cisco Crosswork Optimization Engine. For complete installation requirements, see the Cisco Crosswork Infrastructure 4.3 and Applications Installation Guide.
| Hardware/Software | Supported Version |
|---|---|
|
Cisco Crosswork Infrastructure |
Version 4.3 |
|
Cisco Crosswork Data Gateway |
Version 4.0 |
|
Function Packs |
|
|
Browsers |
|
Scale Support
The following number of devices, and SR-TE policies (SR-MPLS and SRv6) and RSVP-TE tunnels are supported.
![]() Note |
These scale numbers have been qualified on a 3 node cluster system setup with 4 CDG VMs (each with 2.5 K) and 6 SR-PCE pairs (12 SR-PCEs total). |
|
Feature |
Scale Support |
|---|---|
|
Devices |
10,000 |
|
Total Network Interface Scale |
650,000 |
|
Provision of SR-TE policies and RSVP-TE tunnel (PCE-initiated) |
60,000 |
|
Visualization of IGP links |
100,000 |
Upgrade Crosswork Optimization Engine Feature Packs
If you have enabled feature packs (LCM, Bandwidth Optimization, or BWoD) in Crosswork Optimization Engine 3.0 and want to upgrade to Crosswork Optimization Engine 4.0, you must perform the following tasks prior to upgrading:
LCM and Bandwidth Optimization (BWOpt)
-
From the LCM or Bandwidth Optimization Configuration page:
-
Set the Delete Tactical SR Policies when Disabled option to False. This task must be done prior to disabling LCM or BWOpt so that tactical polices deployed by LCM or BWOpt remain in the network after the upgrade.
-
Set the Enable option to False. If LCM or BWOpt remains enabled, there is a chance that tactical policies may be deleted after the upgrade.
-
Note all options (Basic and Advanced) in the LCM or BWOpt Configuration page so that you can confirm the same configuration has been migrated after the upgrade.
-
-
Export the current list of interfaces managed by LCM or BWOpt (Traffic Engineering > Local Congestion Mitigation or Bandwidth Optimization > Interface Threshold > Export icon). Confirm the interfaces are valid by reimporting the CSV file without errors. For more information, see "Add Individual Interface Thresholds" in the Cisco Crosswork Optimization Engine 4.0 User Guide.
-
After the upgrade, wait until the Traffic Engineering page shows all the nodes and links before enabling LCM or BWOpt.
Note:
After the system is stable and before enabling domains for LCM, confirm that the migration of previously monitored interfaces has completed and that each domain has the expected configuration options.
-
Navigate to Administration > Alarms > All > Events and enter LCM to filter the Source column.
-
Look for the following event: "Migration complete. All migrated LCM interfaces and policies are mapped to their IGP domains". If this message does not appear wait for the Congestion Check Interval period (set in the LCM Configuration page), then restart LCM (Administration > Crosswork Manager > Optimization Engine > optima-lcm > ... > Restart).
-
Wait until the optima-lcm service changes from Degraded to Healthy state.
-
For each domain, navigate to the Configuration page and verify the options have been migrated successfully. If the domain configurations are incorrect, restart LCM (Administration > Crosswork Manager > Optimization Engine > optima-lcm > ... > Restart).
-
Check the Events page for the event mentioned above and the Configuration page to verify the options.
![]() Note |
|
BWoD
-
Set the Enable option to False. If BWoD remains enabled, there is a chance that tactical policies may be deleted after the upgrade.
-
Note all options (Basic and Advanced) in the BWoD Configuration page so that you can confirm the same configuration has been migrated after the upgrade.
-
After the upgrade, wait until the Traffic Engineering page shows all the nodes and links before enabling BWoD.
Product Documentation
The following table lists the guides that Cisco provides for Cisco Crosswork Optimization Engine. You can access all Cisco Crosswork Optimization Engine end user documentation at https://www.cisco.com/c/en/us/support/cloud-systems-management/crosswork-optimization-engine/model.html.
![]() Note |
We sometimes update the documentation after original publication. Therefore, you should always review the documentation on Cisco.com for any updates. |
|
Documentation Title |
What is Included |
|---|---|
|
Cisco Crosswork Optimization Engine 4.0 Release Notes |
This document |
|
Cisco Crosswork Infrastructure 4.3 and Applications Installation Guide |
Shared installation guide for all the Cisco Crosswork applications and their common infrastructure. Covers:
|
|
Cisco Crosswork Infrastructure 4.3 and Applications Administration Guide |
Shared administration guide for all the Cisco Crosswork applications and their common infrastructure. Covers:
|
|
|
|
Open Source Software Used in Cisco Crosswork Optimization Engine |
Lists of licenses and notices for open source software used in Cisco Crosswork Optimization Engine. |
|
API Documentation |
Advanced users can extend the Cisco Crosswork functionality using the APIs. API documentation is available on Cisco Devnet. |
Related Product Documentation
You can access documentation for all Cisco Crosswork products at https://www.cisco.com/c/en/us/support/cloud-systems-management/crosswork-network-automation/tsd-products-support-series-home.html
Known Issues and Limitations
The following section details the known issues and limitations for Cisco Crosswork Optimization.
Tree-SID
-
Only visualization of Tree-SID policies is supported. You cannot create, edit or delete Tree-SID policies from the UI.
-
Tree-SID paths for bud nodes are not displayed on the topology-map UI or in policy details.
-
Tree-SID policies are only supported on devices running Cisco IOS XR software.
-
Tree-SID policies are not deleted from the UI when the SR-PCE in HA mode is down.
-
PCE HA is not supported.
-
Tree-SID policies are not supported in Label Switch Multicast (LSM) routing. In cases where LSM is enabled, IGP updates and traffic utilization data are not supported.
-
LCM will not operate in portions of the network carrying Tree-SID LSPs.
-
On Cisco 8000 Series Routers, only static Tree-SID policies with leaf role are supported.
-
The RestConf API is not supported.
-
Tree-SID policy details do not show IPv6 router ID or Srv6 core information.
TE Dashboard
-
Traffic Utilization is not supported on Tree-SID and SRv6 policies.
-
You cannot view the IGP path on the historical data when an event is selected.
-
The metric type for BWOD policies are not visible on the TE Dashboard.
-
Hop count metric and BWOpt type are not shown in the TE Dashboard under metric/policy type.
-
State and Path change events are not visible in the Historic tab of a policy until you zoom in by 5 to 6 clicks.
-
PCC-initiated BWoD policies are not displayed in the TE Dashboard.
SRv6
-
Provisioning of SRv6 policies is not supported.
-
Traffic collection on SRv6 policies is not currently supported.
-
Visualization of PCC-initiated explicit path SRv6 policies is not supported
-
SRv6 is not supported on Bandwidth Optimization, Bandwidth on Demand, or Local Congestion Mitigation feature packs.
SR-MPLS
-
In the SR-MPLS provisioning screen and while previewing an SR-MPLS policy with an IPv6 address, a parsing error is displayed instead of correct error message: "Request Failed. Endpoint address is IPv6, IPv6 provisioning is not supported yet."
-
Updating the SID constraint on an existing policy is not allowed by the SR-PCE. The modification screen gives a successful update message, instead of a warning message that it is not allowed.
APIs
-
The Topology API cannot discover and report IPv6 Link-Local style links.
-
The Dashboard Export API cannot export CSV files to an external location. It can only export to /mnt/cw_glusterfs/bricks/rscoean/export.
Cisco Bug Search Tool
If you encounter problems while working with Cisco Crosswork, please check this list of open bugs. Each bug ID in the list links to a more detailed description and workaround. You can use the Cisco Bug Search Tool to search for bugs.
-
Go to the Cisco Bug Search Tool.
-
Enter your registered Cisco.com username and password, and click Log In.
The Bug Search page opens.

Note
-
To search for all Cisco Crosswork bugs, from the Product list select and enter additional criteria (such as bug ID, problem description, a feature, or a product name) in the Search For field. Examples: "Optimization Engine" or "CSCwc62479".
-
When the search results are displayed, use the filter tools to narrow the results. You can filter the bugs by status, severity, and so on.
![]() Tip |
To export the results to a spreadsheet, click Export Results to Excel. |
Accessibility Features
For a list of accessibility features in Cisco Crosswork Optimization Engine, visit https://www.cisco.com/c/en/us/about/accessibility/voluntary-product-accessibility-templates.html (VPAT) website, or contact accessibility@cisco.com.
All product documents except for some images, graphics, and charts are accessible. If you would like to receive the product documentation in audio format, braille, or large print, contact accessibility@cisco.com.
Obtain Additional Information
Information about Cisco products, services, technologies, and networking solutions is available from various online sources.
-
Sign up for Cisco email newsletters and other communications at:
-
Visit the Cisco Customer Experience website for the latest technical, advanced, and remote services to increase the operational reliability of your network. Go to:
-
Obtain general networking, training, and certification titles from Cisco Press publishers at:
Support and Downloads
The Cisco Support and Downloads website provides online resources to download documentation, software, and tools. Use these resources to install and configure the software and to troubleshoot and resolve technical issues with Cisco products and technologies.
Access to most tools on the Cisco Support and Downloads website requires a Cisco.com user ID and password.
For more information:


Feedback