Cisco Crosswork Change Automation and Health Insights retrieves real-time information from the network, analyzes the data, and uses APIs to apply network changes automatically. The Cisco Crosswork Network Automation platform brings together streaming telemetry, big data, and model-driven application programming interfaces (APIs) to redefine service provider network operations.

Cisco Crosswork Change Automation and Health Insights enables service providers to quickly deploy intent-driven, closed-loop operations. The platform provides a ready-to-use solution supporting the following use cases:

  • Monitor key performance indicators (KPIs) in real time.

  • Prepare network changes triggered by changes in KPIs and automatically roll out these changes.

  • Perform predictive maintenance.

  • Automate change-impact and remediation.

To support the various use cases within the Cisco Crosswork Network Automation platform, consistent telemetry is required. Rich Cisco telemetry is collected using different types of collectors available within the platform.

Functionality added in Cisco Crosswork Change Automation and Health Insights 3.1

This section lists the new features/functionalities delivered in Cisco Crosswork Change Automation and Health Insights 3.1.


Features marked “BETA” provide limited functionality in this release. The intention is to fully support these features in the next release.

Install and Configuration

  • Upgrade support to 3.1 version.

  • Software patching support.

  • BETA: IPv6 deployment mode support.

Inventory Management

  • Inventory Key usage is deprecated for 3.1 and replaced with default node policy.

  • Information about elements impacted added to the job information.

  • CSV import functionality support for adding and updating inventory.

  • Search Criteria support added.

Change Automation

  • Versioning and updated tracking of plays.

  • Impact analysis – API interaction with WAE Playbook.

  • Support for NSO Ansible modules to enable multi-vendor playbooks.

  • Parallel execution on device groups.

  • Information on playbook compatibility with each device/OS.

  • Parallel Software/SMU upgrades.

Health Insights

  • Ability to organize KPIs into a single manageable entity (KPI Profile) that user can enable on a single device or multiple devices.

  • Ability to create custom alerts using alert groups. Alert groups contain boolean expressions with KPIs within a profile.

  • Ability to enable alert forwarding and alert groups to an HTTP endpoint. The general device alerts and alert groups can be differentiated.

Monitor and Troubleshoot

  • Smart licensing registration, and integration with Cisco Smart Software Manager (direct mode, on-prem and proxy support).

  • Backup and restore support for database and configuration.

  • Ability to update the default user properties.

  • Lightweight Directory Access Protocol (LDAP) server support.

  • API grouping for user role creation.

  • Password policies updated.

Collection Services

  • Cisco Crosswork Change Automation and Health Insights 3.1 uses Cisco Crosswork Data Gateway as the scalable collection architecture between the network and application to collect data.

  • Support for CLI, SNMP and MDT data collection methods.

  • Ability to optimize collection requests to reduce redundancy.

  • External data destination support for third party applications (Kafka, gRPC) access to network data.

  • Ability to monitor collection jobs.

  • Custom device package support for third party device data collection.

Release Dates

Cisco releases updated builds on the Cisco Support & Download site when needed.

Table 1. Version 3.1.x Release Dates
Version Build Filename Date





Compatibility Information

The following table lists hardware and software versions that have been tested and are known to be compatible with Cisco Crosswork Change Automation and Health Insights. For complete installation requirements, see the Cisco Crosswork Change Automation and Health Insights Installation Guide.


This release supports new deployments and migration from older versions of Cisco Crosswork Change Automation and Health Insights.

Hardware/Software Supported Version

Hardware platform

Cisco Unified Computing System (UCS) B or C series


You can deploy on any host that meets the minimum hardware configurations supported by ESXi 6.5.

Hypervisor and vCenter

  • VMware ESXi 6.5 Update 2 or later.

  • VMware vCenter Server 6.5 (Update 2d or later), 6.7 (Update 1).

Cisco Network Services Orchestrator(Cisco NSO)

  • Version

  • IOS XR Network Element Driver (NED) version 7.13.9

  • IOS XE NED version 6.36

Software platform

  • Cisco IOS XR 6.2.x or later (recommended 6.5.x or later)

  • Cisco IOS XE 16.10 or later (limited functionality)

  • Cisco NX-OS (N7K - 8.4(1), N9K - 7.0(3) I7(2))


  • Google Chrome—70 or later

  • Mozilla Firefox—60 or later

Installation/Upgrade Paths

The following table lists the valid path for installing/upgrading to Cisco Crosswork Change Automation and Health Insights 3.1 from previous versions.

Table 2.

Current Cisco Crosswork Change Automation and Health Insights version

Install the following to upgrade to Cisco Crosswork Change Automation and Health Insights 3.1

Cisco Crosswork Change Automation and Health Insights 3.1

Cisco Crosswork Change Automation and Health Insights 3.0 > 3.1

See the relevant installation guide for installation prerequisites and procedures for Cisco Crosswork Change Automation and Health Insights versions.

Usage Guidelines and Important Notes

This section provides guidelines and important notes to consider when using Cisco Crosswork Change Automation and Health Insights.

Installation and Configuration

For configuration and installation procedures, see the Cisco Crosswork Change Automation and Health Insights Installation Guide.

  • Deploy Cisco Crosswork Change Automation and Health Insights on a highly available cluster (vSphere HA) with shared storage.

  • Use VMware vCenter and vSphere Web Client (flash mode) for OVA deployment.

  • Use the same NTP source and server to avoid time synchronization issues.

  • Confirm that the DNS and NTP servers are properly configured.

  • If the UI does not appear within 30 minutes after installation, log into the VM and check the installation logs for configuration errors. If necessary, collect logs to give to Cisco TAC (see the "Perform Administrative Tasks" chapter of the Cisco Crosswork Change Automation and Health Insights User Guide).

  • Use Terminal Access-Control System Plus (TACACS+), Lightweight Directory Access Protocol (LDAP) or Role-Based Access Control (RBAC) for auditing purposes.

  • During configuration, note the Cisco Crosswork Change Automation and Health Insights UI and CLI user names and passwords. You will not be able to recover the administrator password later because of security purposes.

  • In situations where Cisco Crosswork Change Automation and Health Insights is expected to work with PCE (PCE is used for L3 topology discovery) we recommend the use of dual PCEs.

Inventory Management

Use CSV files to quickly import and onboard device, credential, and provider information.

Health Insights

For information on how to use Health Insights, see the "Monitor Network Health and KPIs" chapter in the Cisco Crosswork Change Automation and Health Insights User Guide.

  • Group the KPIs within a KPI Profile for monitoring relevant device metrics. For best results, limit to adding 10 KPIs per KPI Profile. Maximum number of KPIs that can be supported within a KPI profile is 50.

  • For optimal performance, enable a KPI Profile in batches of 50 devices.

  • Link the playbook with KPI before enabling the corresponding KPI Profile on a device.

  • For best system performance, use the default KPI cadence.

Change Automation

For information on how to use Change Automation, see the "Automate Network Changes" chapter in the Cisco Crosswork Change Automation and Health Insights User Guide.

  • Use the scheduling feature to perform planned maintenance operations.

  • Use the Install and Uninstall packages to upgrade or downgrade software patches.

  • Use Change Automation from day 2 onwards.

  • Use Dynamic Group tags for simultaneous playbook execution across multiple devices. Currently Change Automation supports up to 20 concurrent playbook executions.

  • Configure the MOP timeout value appropriately, so that a timeout does not occur when running playbooks.

Collection Services

  • Mapping of devices to Cisco Crosswork Data Gateway is recommended to be done in batches of 300 devices to ensure optimal performance.

  • Use device groups when enabling collection jobs for better operational efficiency.

Monitor and Troubleshoot

For administrative and monitoring tasks see the "Perform Adminstrative Tasks" chapter in the Cisco Crosswork Change Automation and Health Insights Installation Guide.

  • Avoid restarting services (via UI or CLI) when troubleshooting Cisco Crosswork Change Automation and Health Insights.

  • Monitor and view application state, health, performance, and summary details from the Crosswork Manager window.

  • Use custom certificates signed by your local CA to avoid browser warning messages. To manage certificates, go to the Certificate Management application.

Known Issues and Limitations

The following are known issues, limitations, and workarounds in Cisco Crosswork Change Automation and Health Insights.


  • The application data Health Insights data from version 3.0 (Change Automation, Health Insights, Topology) cannot be migrated, as the schema has been updated in the version 3.1.

  • AAA remote authentication server settings, custom local users and custom roles are not retained in the migration from version 3.0 to version 3.1.

Change Automation

  • Sometimes, under certain load conditions, the execution of a Playbook times out. If it continues to fail for a specific device, try changing the device state to DOWN and UP again.

  • While scheduling playbooks across a dynamic group tag, the corresponding job set screen for the job in the Job History page will not display the relevant devices, until the job is scheduled for execution.

Inventory Management

Sometimes, NETCONF reachability times out for IOS XE devices. To recover, try changing the device state to DOWN and UP again.

Health Insights

  • After a KPI Profile is enabled, editing cadence & threshold parameter for any of the associated KPIs can be achieved as below:

    • Create a custom KPI with the required cadence & threshold parameters and associate with the existing KPI Profile.

    • Create a new KPI Profile with the relevant KPIs associated. Update the cadence & alert parameters before enabling this new KPI Profile.

    • Disable the KPI Profile & perform the modifications on relevant associated KPIs and re-enable the KPI Profile.

  • If the alert flag (on/off) is updated after the KPI Profile is enabled, and the operation is successful, then you will observe a corresponding job on HI Job History page with no details.

  • For custom KPIs:

    • Only one gather path should be specified when creating custom KPIs.

    • All leaf sensor paths are reserved for that KPI use only.

    • Multiple KPIs cannot use the same sensor path. Therefore, custom KPIs cannot share a sensor path with each other or with an existing default KPI that is active on a device.

  • Any Health Insights job stuck in the processing state and does not complete within the stipulated time out of 60 minutes, will fail.

Network Visualization

  • L2 links are discovered on topology utilizing either Customer Data Platform (CDP) or Link Layer Discovery Protocol (LLDP).

  • Point-to-point CDP or LLDP is supported in topology.

  • PCE is required for L3 link topology mapping.

  • Enable traps on routers to receive L2 link down and up status changes quickly. Otherwise, it may take one SNMP poll cadence (default is 5 minutes) to see the L2 link status change.

Collection Services

  • On a system that contains more than 250 devices, increase in the number of notifications may cause the collection job creations to be staggered.


  • The JSON Web Token is only valid up to 8 hours.

Smart Licensing

In rare cases, after the successful registration, the License Authorization Status in the Smart Licensing page is not changed and will continue to display as being in EVALUATION mode. As a consequence, the evaluation timer will be started and incorrect messages will be displayed to the user. As a workaround, please de-register and register the product again.

Cisco Bug Search Tool

You can use the Cisco Bug Search Tool to search for a specific bug or to search for all bugs in a release.

  1. Go to the Cisco Bug Search Tool.

  2. Enter your registered username and password, and click Log In.

    The Bug Search page opens.


    If you do not have a username and password, you can register here.

  3. Use any of these options to search for bugs, and then press Enter (Return) to initiate the search:

    — To search for a specific bug, enter the bug ID in the Search For field.

    — To search for bugs based on specific criteria, enter search criteria, such as a problem description, a feature, or a product name, in the Search For field.

    — To search for bugs based on products, enter or choose the product from the Product list. For example, enter Cisco Crossswork Change Automation or Cisco Crosswork Health Insights.

    — To search for bugs based on releases, in the Releases list choose whether to search for bugs affecting a specific release, bugs that were fixed in a specific release, or both. Then enter one or more release numbers in the Releases field.

  4. 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.


To export the results to a spreadsheet, click Export Results to Excel.

Accessibility Features

All product documents are accessible except for images, graphics and some charts. If you would like to receive the product documentation in audio format, braille, or large print, contact the Cisco Accessiblity Team on the Web or send email to .

Obtain Documentation and Submit a Service Request

For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What’s New in Cisco Product Documentation.

To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What’s New in Cisco Product Documentation RSS feed. The RSS feeds are a free service.