This guide is for experienced network administrators who want to use Cisco Crosswork Change Automation and Health Insights in their network. This guide assumes that you are familiar with the following topics:
Networking technologies and protocols (IS-IS, BGP, and so on)
Network monitoring and troubleshooting
Familiarity with the different operating systems used on devices that form your network, such as Cisco IOS-XR, ISO-XE, and
Overview of Cisco Crosswork Change Automation and Health Insights
Cisco Crosswork Network Automation is a microservices-based platform that brings together streaming telemetry, big data and application programming interfaces
(APIs) to redefine service provider network operations.
Cisco Crosswork Network Automation enables multiple use cases, including those targeted by Cisco Crosswork Change Automation and Health Insights:
Continuous real-time monitoring of key performance indicators (KPIs)
Routinizing scheduled network maintenance and network reconfiguration tasks
Linking optimization and remediation playbooks to KPIs in order to streamline response to network events
Begining with release 3.1 the data collection functionality has been separated out into its own VM and software package called
Cisco Crosswork Data Gateway. Cisco Crosswork Data Gateway gathers all the information from the monitored devices and forwards it to Cisco Crosswork Change Automation and Health Insights for analysis and processing. Cisco Crosswork Change Automation and Health Insights can then be used by the operator to manage the network or respond to changes in the network. Apart from Cisco Crosswork Change Automation and Health Insights, Cisco Crosswork Data Gateway can also be used for external data collection integration. Cisco Crosswork Change Automation and Health Insights uses Cisco Network Services Orchestrator (Cisco NSO) as the default provider to manage the devices according to their expected functions, including configuring any required
model-driven telemetry (MDT) sensor paths for data collection. Cisco NSO is vital in supplying device management and configuration-maintenance services
This guide explains how to use both Cisco Crosswork Change Automation and Health Insights and Cisco Crosswork Data Gateway.
Licenses determine the applications you can use and the numbers of devices that Cisco Crosswork Change Automation and Health Insights can manage.
Change Automation and Health Insights are separately licensed applications.
Cisco Crosswork Data Gateway license is included in Cisco Crosswork Change Automation and Health Insights license apart from Cisco Crosswork Data Gateway API access for external data collection integration which is separately licensed.
To purchase a Cisco Crosswork Change Automation and Health Insights license, contact your Cisco account representative. Do not make copies of licenses.
For demonstrations and field trials, Cisco Crosswork Change Automation and Health Insights can be used without a license for up to 90 days.
Log In and Log Out
The Cisco Crosswork Change Automation and Health Insights user interface is browser based. It supports the following browsers:
Google Chrome, version 70 or later
Mozilla Firefox, version 60 or later
Open a web browser and enter:
The Cisco Crosswork Change Automation and Health Insights browser-based user interface displays the login window. Enter your username and password.
The default Cisco Crosswork Change Automation and Health Insights administrator user name and password is admin. This account is created automatically at installation (see Administrative Users Created During Installation). The initial password for this account must be changed during installation verification, as explained in the Cisco Crosswork Change Automation and Health Insights Installation Guide. Cisco strongly recommends that you keep the default administrator credential secure, and never use it for routine logins.
Instead, create new user accounts with appropriate privileges and their own credentials (as explained in Add Users) and use only those accounts for all subsequent user logins.
Click Log In.
When you access Cisco Crosswork Change Automation and Health Insights from your browser for the first time, some browsers display a warning that the site is untrusted. When this happens, follow
the prompts to add a security exception and download the self-signed certificate from the server. After you do this, the browser
accepts the Cisco Crosswork Change Automation and Health Insights server as a trusted site in all subsequent logins.
You might need to log in again when you cross-launch from one application to another.
A cross-launched application might remain open even after you log out of Cisco Crosswork Change Automation and Health Insights.
If this is your first time logging in using your own user account, you will be prompted to create a new password for your
To log out, click in the top right of the Cisco Crosswork Change Automation and Health Insights main window and choose Log out.
Use the Main Window Controls
The Cisco Crosswork Change Automation and Health Insights main window (also known as the dashboard) provides the controls and dashboard displays described below.
Table 1. Main Window Controls
More: Toggles the main menu between compact mode, which requires you to click on each menu icon before you can select the options
under it, and expanded mode, which displays the entire menu and lets you pick options directly.
Network Visualization Tile: Summarizes overall device and link health across the network, showing the current number of high-use, degraded, or down
links. Click on the Show Topology Map link at the bottom of the tile to open the Network Visualization application and get more details.
Health Insights Tile: Summarizes the number of devices and KPIs reporting problems. Click on the View Health Insights Dashboard link at the bottom of the tile to open the Health Insights application and get more details.
Change Automation Tile: The ring chart summarizes the state of Playbook execution, showing how many of your playbooks are running, scheduled to
run, succeeded, and failed. Click on the View Change Automation Dashboard link at the bottom of the tile to the Change Automation application and get more details.
The icon lets you access the list of current notifications, alerts and messages.
The About icon displays the current version of Cisco Crosswork Change Automation and Health Insights.
The User Account icon lets you view the currently logged in user's name, change your password, and log out.
Home: Returns you to the Dashboard from any other window. The dashboard tiles on this window provide at-a-glance views of the
most important data in your network.
Change Automation Menu: Lets you select from the options available in the Change Automation application, which automates the process of deploying changes to the network. Click the blue View Change Automation Dashboard link at the bottom of the Change Automation tile to bypass the menu and open the Change Automation application directly.
Inventory Management Menu: Lets you select from the options available in the Inventory Management application, which lets you add, organize, update and view information about the devices in your network; manage the providers,
tags, and credential profiles you use; and view Job History for all device-related tasks.
Health Insights Menu: Lets you select from the options available in the Health Insights application, which allows you to view the Alert Dashboard, Manage KPIs and KPI Profiles, enable or disable KPI Profiles on
selected devices, and see the KPI Profile Job History. Click the blue Show Health Insights Dashboard link at the bottom of the Health Insights tile to bypass the menu and open the Health Insights application directly.
Network Visualization Menu: Lets you select from the options available in the Network Visualization application, which presents both a geographical and a logical map view of the devices in your network, their topology and
the links between them, the general condition of those devices and links, and other information. Click the blue Show Topology Map link at the bottom of the Network Visualization tile to bypass the menu and open the Network Visualization application directly.
Admin Menu: Lets you access the Administrative section of the user interface, where you can:
Collect Cisco show-tech and logs
Monitor system activity and restart services
Manage users, roles, AAA TACACS+, and AAA LDAP servers
Manage Cisco Crosswork Data Gateway and collection jobs
Register with Cisco Smart Licensing
Set, Sort and Filter Table Data
Many Cisco Crosswork Change Automation and Health Insights windows show database records in tables. For example: You will see tables in the Devices and Credentials windows accessed directly from Inventory Management, and also in the Links window accessed via the topological map in Network Visualization.
Any window with a table will also provide column selection, sorting, and filter functions that let you control the database
records shown in the tables and help you locate particular records quickly.
Click to display a list of all the fields in the database for the kind of data record displayed in the table. You can choose which
fields you want to display as table columns by checking or unchecking the box next to any field in the list. Your choices
are enabled immediately and are permanent.
For example: In the Devices window shown below, we have unchecked the UUID field which is normally shown as part of the default Devices table, but now removed. We have also checked the Node IP field, adding it to the table.
You can also sort all the records displayed in the table according to the data in any one column by clicking that column's
To sort the records in ascending order, click the column title once.
To sort the records in descending order, click the column title again.
Sorting takes place immediately. You can only have one active sort at a time. The example Links window, below, shows an active sort on the Link Type field.
You can also filter the table to show only the records you want, using a quick filter or an advanced filter. Many tables have
all these features enabled by default. If you cannot see the quick and advanced filter features displayed on a window with
a table, click .
The quick filter displays only the records that match the value you enter above the column in the quick filter field (see item 2, below). Filtering takes place immediately, as you type.
The advanced filter narrows the content in the table by applying a filter that includes both a value and a logical operator,
such as Equals, Starts with, Contains, and so on. Click in the column header to access the advanced filter (see items 4 and 5, below).
In addition to these quick and advanced filters, you can also use tags to filter the devices shown in the Devices window and on the Network Topology map (see Filter Devices by Tags).
Sort active icon: This arrow icon indicates that the user has sorted the links by clicking on the column header. The arrow's direction shows
that the table is sorted by Link Type, in ascending order.
Quick filter field: Type a text or numeric value in this field to show only the links that match the value you enter. The field shows the values
you entered for both quick and advanced filters.
Filter active icon: This icon shows that a quick or advanced filter is currently applied to the data in this column.
Advanced filter icon: Click , shown in each column header, to specify an advanced filter on that column, using logical operators as well as alphanumerical
Filter criteria fields: These fields appear in a popup next to the column after you click the icon. Set the filter criteria by selecting the logical operator from the drop down list in the first field, and then entering
the filter value in the second field. Your criteria will be applied immediately. You will then be prompted to enter more operators
and values, and to decide if you want to concatenate them using logical AND or OR. The quick filter field shows the values
you entered (but not the operators). Logical operators include Equals, Not equal, Starts with, Ends with, Contains, and Not