This document provides information about Crosswork Data Gateway 3.1.0, including features, compatibility information, known issues and limitations.

Product Overview

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 Crosswork on-premise or Crosswork Cloud applications. There is no separate software license needed for Cisco Crosswork Data Gateway. 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.

What's New in Crosswork Data Gateway 3.1.0

Crosswork Data Gateway 3.1.0 release is aimed at enabling Cisco EPN Manager 6.0 application and consists of additional fixes for defects. For the complete list of the latest Crosswork Data Gateway features, see Features and Enhancements in Crosswork Data Gateway 3.0.

Compatibility Information for Crosswork Data Gateway 3.1.0

Crosswork Data Gateway provides two on-premise deployment profiles - Standard and Extended.

The following table lists the VM requirements for Cisco Crosswork Data Gateway 3.1.0:

Table 1. Cisco Crosswork Data Gateway 3.1.0 VM Requirements

Requirement

Description

Data Center

VMware

  • VMware vCenter Server 7.0, ESXi 7.0 or later installed on hosts

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

    Note

     
    Support for VMware vCenter Server 6.5 is deprecated and will be removed in the next release.

Cisco CSP

  • Cisco CSP 2.8.0.276 or later

    Allowed_hardware_list = ['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

Disk space

  • Standard: 55 GB (Minimum)

  • Extended: 554 GB (Minimum)

vCPU

  • Standard: 8

  • Extended: 16

Interfaces

Minimum: 1

Maximum: 3

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 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 Crosswork Data Gateway.

(*) - For live deployments, we recommend 3 NIC deployment, that is 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 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 following table lists the software versions with which Cisco Crosswork Data Gateway 3.1.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.1 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, 7.3.2, 7.4.1

gNMI

MDT

SNMP

Syslog

Note

 
Secure Syslog is not supported for versions 7.4.1 and 7.3.2.

CLI

NETCONF

gNMI Proto

KVGPB/TCP

IOS-XE

16.12.3, 17.2.1, 17.3.1, 17.4.1, 17.5.1

gNMI

SNMP

CLI

Syslog

NETCONF

NA
NX-OS

9.2.1, 9.3.1, 10.x

SNMP

CLI

Syslog

NA

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

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, see Cisco Devnet or contact Cisco Professional Services.

Cisco Crosswork Data Gateway 3.1.0 Documentation

The following table lists the documentation related to Cisco Crosswork Data Gateway 3.1.0.

Document Title

What is included

Cisco Crosswork Data Gateway 3.1.0 Release Notes

This document.

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

Cisco Crosswork Infrastructure 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 and Applications Administration 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

  • Monitoring Cisco Crosswork Data Gateway health

  • Troubleshooting

  • Configuring Cisco Crosswork Data Gateway Base VM.

Open Source used in Cisco Crosswork Data Gateway

Lists of licenses and notices for open source software used

Additional Related Documentation

This section provides links to additional related documentation for Cisco Crosswork Data Gateway 3.1.0

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 Cisco Crosswork Network Automation API Documentation on Cisco DevNet.

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.

If any product document could not be converted to the accessible formats, please contact the Cisco Customer Experience team.

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.