Cisco Crosswork Data Gateway 2.0 Release Notes

This document describes the features, limitations, and bugs for Cisco Crosswork Data Gateway 2.0.

Change History

The following table lists changes to this document since its initial release.

Table 1. Document Change History

Date

Change

2021-12-21

Added an Important Notes section with details about the vulnerability in Apache Log4j Library Affecting Cisco Products: December 2021.

2021-04-16

Initial Release.

Introduction

Cisco Crosswork Data Gateway is a model-driven scalable data collection platform that enables real-time data collection from multi-protocol capable devices, thereby reducing the need for multiple collection points for multiple applications requiring data from the network.

Cisco Crosswork Data Gateway offers central visibility into services collecting data and the type of data being collected. It can also be used to feed external data destinations (such as, an external Kafka or gRPC server) in addition to Crosswork applications.

Cisco Crosswork Data Gateway is not a standalone product and is expected to be used with other Cisco applications via either Crosswork on-premise or Crosswork Cloud. There is no separate software license needed for Cisco Crosswork Data Gateway. See Compatibility Information for Crosswork Data Gateway 2.0.

Use of Cisco Crosswork Data Gateway to forward data to third-party destinations is only supported when using the Crosswork Data Gateway with Crosswork On Premise applications and requires a separate license.

Release Dates

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

Table 2. Crosswork Data Gateway 2.0 Release Dates

Version

Filename

Date

2.0 cw-na-dg-2.0.0-18-release-20210409.ova

2021-04-16

2.0

cw-na-dg-2.0.0-18-release-qcow2-pkg.tar.gz

2021-04-16

Features and Enhancements in Crosswork Data Gateway 2.0

This section lists the features delivered in Crosswork Data Gateway 2.0:

Feature

Description

Collectors

  • gNMI

  • Syslog

Added support for two additional data collection methods:

  • gRPC Network Management Interface (gNMI) based telemetry data collection (only gNMI Dial-In streaming telemetry data based on subscription)

  • Syslog-based events collection from network devices using the following formats:

    • RFC5424

    • RFC3164

Added secure gNMI and secure syslog support.

  • Support provided for Device TLS certificate management from the Cisco Crosswork UI.

Licensing

Added license compliance check for non-Crosswork active collection jobs

Deploy Cisco Crosswork Data Gateway as per application and network size

Cisco Crosswork Data Gateway On Premise deployment supports two profiles:

  • Standard

    - To be used with all On Premise Crosswork applications, except Crosswork Change Automation and Health Insights
  • Extended

    - To be used with Cisco Crosswork Change Automation and Health Insights

Deploy Cisco Crosswork Data Gateway on Cisco Cloud Services Platform(CSP) 5000

Provides the option to deploy Cisco Crosswork Data Gateway on Cisco Cloud Services Platform (Cisco CSP) 5000

Auto-enrollment of Cisco Crosswork Data Gateway instance with Cisco Crosswork

After the Crosswork Data Gateway VM is installed, it registers with Cisco Crosswork automatically

Cisco Crosswork Data Gateway High Availability

Create and manage a Cisco Crosswork Data Gateway pool to ensure that devices are managed and data collection occurs with minimal to no disruption

Collection Optimization

Optimizes collection requests to reduce redundant data collections.

Secure communication between Cisco Crosswork Data Gateway and specified data destination

Crosswork Data Gateway allows you to enable secure communication between itself and the specified data destination that is, a Crosswork application or external Kafka.

Collection Job Monitoring

Crosswork Data Gateway provides central visibility into services collecting data and type of data being collected.

Custom Device Package Support

Allows third-party device data collection by means of custom device packages. Lets you deploy three types of custom packages:

  1. CLI Device Package

  2. SNMP MIB Package

  3. SNMP Device Package

Collection Vitals

Exposes vitals of its services allowing you to monitor overall health of Crosswork Data Gateway. The vitals include Base VM performance metrics and reachability of each instance.

Enhanced support in CLI Device Packs for third party

Crosswork Data Gateway allows you to upload custom CLI device packages along with their corresponding YANG models to monitor device health indicators for third-party devices.

Option to change the MTU of vNIC2 when deployed with 3 vNICs

Cisco Crosswork Data Gateway provides you the option to change the MTU of vNIC2 when you deploy it with 3 NICs.

Configure timezone of Base VM

Allows you to configure the operational timezone of the Cisco Crosswork Data Gateway.

Option to use Cisco Crosswork UI to request Crosswork Data Gateway showtech

Option to download the Cisco Crosswork Data Gateway VM’s showtech file on demand from Cisco Crosswork UI.

Option to enable dg-tac user

Added ability to enable dg-tac user to enable deeper troubleshooting than Base UI will allow.

Compatibility Information for Crosswork Data Gateway 2.0

Crosswork Data Gateway 2.0 can be deployed with on-premise Crosswork applications only.

Cisco Crosswork Data Gateway release 2.0 has been validated in conjunction with the following Crosswork applications:

  • Cisco Crosswork Network Controller 2.0

  • On-premise Crosswork applications

    • Cisco Crosswork Change Automation and Health Insights 4.0

    • Cisco Crosswork Optimization Engine 2.0

    • Cisco Crosswork Active Topology 2.0

    • Cisco Crosswork Zero Touch Provisioning 2.0

Crosswork Data Gateway provides two on-Premise deployment options:

  • Standard: To be used with any on-premise Crosswork applications, except Cisco Crosswork Health Insights.

  • Extended: Required when using Crosswork Data Gateway with Cisco Crosswork Health Insights and optional if using other on-premise Crosswork applications.

You can deploy Cisco Crosswork Data Gateway as a VM on a host that meets the following minimum requirements:

Table 3. Cisco Crosswork Data Gateway 2.0 VM Requirements for on-premise deployment

Requirement

Description

Data Center

VMware

  • VMware vCenter Server 6.7 Update 3g or later (ESXi 6.7 Update 1 installed on hosts)

  • VMware vCenter Server 6.5 Update 2d or later (ESXi 6.5 Update 2 installed on hosts)

Cisco CSP

  • Cisco CSP 2.8.0.276 or later

    Allowed_hardware_list = ['UCSC-C220-M4S', 'UCSC-C240-M4SX', 'N1K-1110-X', 'N1K-1110-S','CSP-2100', 'CSP-2100-UCSD', 'CSP-2100-X1', 'CSP-2100-X2','CSP-5200', 'CSP-5216', 'CSP-5228','CSP-5400', 'CSP-5436', 'CSP-5444', 'CSP-5456']

Memory

  • Standard: 32 GB

  • Extended: 96 GB (must be used with Cisco Crosswork Health Insights)

Disk space

  • Standard: 55 GB (Minimum)

  • Extended: 550 GB (Minimum)

vCPU

  • Standard: 8

  • Extended: 16

Interfaces

Minimum: 1

Maximum: 3

Cisco Crosswork Data Gateway can be deployed with either 1, 2, or 3 interfaces as per the combinations below:

No. of NICs

vNIC0

vNIC1

vNIC2

1
  • Management Traffic

  • Control/Data Traffic

  • Device Access Traffic

2*
  • Management Traffic

  • Control/Data Traffic

  • Device Access Traffic

3*
  • Management Traffic

  • Control/Data Traffic

  • Device Access Traffic

  • Management traffic: for accessing the UIs and command line and passing configuration information between servers (for example, a Crosswork application to Crosswork Data Gateway).

  • Control/Data traffic: for data and configuration transfer between Cisco Crosswork Data Gateway and Crosswork applications and other external data destinations.

  • Device access traffic: for device management (NSO or a Crosswork application to the devices as a result of KPI configuration or playbook execution) and telemetry data being forwarded to the Cisco Crosswork Data Gateway.

(*) - For live deployments, we recommend one interface for all the management traffic (VMs to DNS, NTP, and the network you will use to access and manage the applications), second interface for the data network (connection between Cisco Crosswork and the Cisco Crosswork Data Gateway VM) and third interface to communicate with devices in the network.

IP Addresses

1, 2, or 3 IPv4/IPv6 addresses based on the number of interfaces you choose to use.

Note 
Cisco Crosswork does not support dual stack configurations. Therefore, ALL addresses for the environment must be either IPv4 or IPv6.

NTP Servers

The IPv4/IPv6 addresses or host names of the NTP servers you plan to use. If you want to enter multiple NTP servers, separate them with spaces. These should be the same NTP servers you use to synchronize devices, clients, and servers across your network. Confirm that the NTP IP address or host name is reachable on the network or installation will fail.

The Cisco Crosswork Data Gateway host and virtual machine must be synchronized to an NTP server or the initial handshake may fail with "certificate not valid" errors.

DNS Servers

The IPv4/IPv6 addresses of the DNS servers you plan to use. These should be the same DNS servers you use to resolve host names across your network.

DNS Search Domain

The search domain you want to use with the DNS servers (for example, cisco.com). You can only have one search domain.

Tested Cisco OS

The below table lists the software versions with which Cisco Crosswork Data Gateway 2.0 was tested. Cisco Crosswork Data Gateway allows you to expand device coverage by means of custom packages (see Section: Manage Custom Software Packages in Cisco Crosswork Infrastructure 4.0 and Applications Administration Guide).

OS Software Version Collection Protocols MDT Encoding
IOS-XR*

6.5.3, 6.6.2, 6.6.3, 7.0.1, 7.1.2, 7.2.1, 7.3.1

gNMI

MDT

SNMP

Syslog

CLI

gNMI Proto

KVGPB/TCP

IOS-XE

16.12.3, 17.2.1, 17.3.1, 17.4.1

gNMI

SNMP

CLI

Syslog

NA
NX-OS

9.2.1, 9.3.1

SNMP

CLI

Syslog

NA

*For MDT configuration via NSO on IOS-XR, use NSO NED 7.30 or 7.33.

Crosswork Data Gateway can collect data from compatible third-party devices using SNMP or gNMI collectors. For information about deploying and validating non-Cisco collections, go to Cisco Devnet or contact Cisco Professional services.

Important Notes

Log4j patch for Crosswork Data Gateway 2.0.0 is part of Crosswork Infrastructure Log4j patch version 4.0.1.

The Crosswork Infrastructure patch delivers related fixes for Crosswork Data Gateway automatically after activation. For more information, see Cisco Crosswork Patch for Apache Log4j Vulnerability.

Cisco Crosswork Data Gateway 2.0 Documentation

The following table lists the guides provided for Cisco Crosswork Data Gateway 2.0

Document Title

What is included

Cisco Crosswork Data Gateway 2.0 Release Notes

Provides an overview of the product, compatibility information, and important information that should be taken into consideration before using the product.

Cisco Crosswork Infrastructure 4.0 and Applications Installation Guide

Shared installation guide for all the Cisco Crosswork applications and their common infrastructure. Covers:

  • System requirements

  • Installation prerequisites

  • Installation instructions

  • Upgrade instructions

  • Uninstallation

Cisco Crosswork Infrastructure 4.0 and Applications Administrator Guide

Shared administration guide for all the Cisco Crosswork applications and their common infrastructure. Covers:

  • Overview of Cisco Crosswork Data Gateway

  • Managing Cisco Crosswork Data Gateway VMs

  • Managing Cisco Crosswork Data Gateway Pools

  • Managing external Data Destinations

  • Managing Custom Packages

  • Collection jobs

  • Configuring Cisco Crosswork Data Gateway Base VM.

  • Monitoring Cisco Crosswork Data Gateway health

  • Troubleshooting

Open Source used in Cisco Crosswork Data Gateway 2.0

Lists of licenses and notices for open source software used

Additional Related Documentation

This section provides links to documentation for products related to Cisco Crosswork Data Gateway at:

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.

Cisco Crosswork API Documentation

Advanced users can extend Cisco Crosswork product functions by using the product APIs. For more about the product APIs, see the Cisco Crosswork Network Automation API Documentation on Cisco DevNet.

Open Bugs in Crosswork Data Gateway 2.0

For list of open bugs in Cisco Crosswork Data Gateway 2.0, 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 a specific bug or to search for all bugs in a release.

  1. Go to the Cisco Bug Search Tool.

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

    The Bug Search page opens.


    Note

    If you do not have a Cisco.com 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.

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


Tip

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 accessibility@cisco.com.

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 Cisco Notification Tool.