Crosswork KPIs

This repository contains Crosswork 3.0 KPIs that can be used to interact with Crosswork Health Insights.
These KPIs are provided by Cisco along with the software release. No modification will be accepted.
Custom KPIs can be created in the Crosswork-Custom-KPI repository.

Requirements

Following are required to use the KPIs:

Cisco Crosswork Network Change Automation and Health Insights 3.0 +
Cisco NSO 4.5.5 +

Documentation:

Please refer to the documentation at the following link to understand how to use the KPIs.
Cisco Crosswork DevNet page.
Alert forwarding page describes data format of alert messages.

Usage

Example usage of the KPIs can be found in Crosswok Postman Collection

Use Case

Cisco Crosswork Change Automation and Health Insights relies on network telemetry to retrieve real-time information from the network, analyze the data, and use APIs to apply network changes automatically. For example, in a large network with hundreds of devices, it can take months to pre-check the network, perform a software maintenance update, and post-check. Cisco Crosswork Change Automation and Health Insights speeds up that process by automating the manual steps.

Cisco Crosswork Change Automation and Health Insights enables you to:

Monitor key performance indicators (KPIs) in real time
Prepare network changes triggered by changes in KPIs
Roll out these changes automatically
Perform predictive maintenance
Automate change-impact and security analysis

Change Automation

Change Automation automates the process of deploying changes to the network. Users define and orchestrate network states and changes via an embedded Ansible Playbook. Change Automation organizes and pushes configuration changes to Cisco Network Service Orchestrator (NSO), which deploys them to the network. Change Automation also verifies network changes with the same streaming telemetry that Health Insights uses to monitor KPIs.

Health Insights

Health Insights monitors KPIs and performs automated, programmable troubleshooting analysis in real time. Health Insights provides dynamic analytical modules that let network operators monitor, detect, and generate alerts for network events based on their own, user-defined logic. Coupled with Change Automation, Health Insights provides a platform to address changes to the network infrastructure dynamically.

For more information on the Cisco Crosswork Network Automation platform, visit the Cisco Crosswork Network Automation page on the Web.

APIs

Enabling external integration, development and customization is at the core of the Cisco Crosswork Network Automation platform. Each product in the platform supports this by providing easy-to-use APIs that cover all or most of each product's functions, including functions that are created exclusively for access via APIs.

For example, developers can use the Cisco Crosswork Network Automation REST APIs for the following applications and functions

Health Insights APIs: Create, execute, or get the status of KPIs.
Change Automation APIs: Schedule, get the status of, or abort Playbook jobs.
Alerting Services APIs: Get lists of and subscribe to alerts.
Device Lifecycle Management and Inventory (DLMI) APIs: Retrieve device inventory data, update nodes, and retrieve credentials.

For a quick hands-on introduction to the API capabilities, see the "Getting Started" section below. The "API References" section also offers detailed reference documentation on every available Cisco Crosswork Network Automation API.

Developers may use Cisco Crosswork Change Automation and Health Insight APIs free of license fees at this time. Cisco reserves the right to charge license fees for its APIs at some time in the future.