This document provides information about Cisco Crosswork Data Gateway 3.0, including features, compatibility information, known issues and limitations.
Change History
The following table lists changes to this document since its initial release.
|
Date |
Change |
|---|---|
|
2022-12-15 |
Introduced the Scale Support section detailing the scale information. |
|
2021-12-21 |
Added an Important Notes section with details about the vulnerability in Apache Log4j Library Affecting Cisco Products: December 2021. |
|
2021-11-12 |
Initial Release. |
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.
Release Details
Cisco releases updated builds on the Cisco Support & Software Download site.
|
Version |
File name |
Date |
|---|---|---|
| 3.0 | cw-na-dg-3.0.0-36-release-20211105.ova |
2021-11-12 |
| 3.0 | cw-na-dg-3.0.0-36-release-20211105.tar.gz |
2021-11-12 |
Cisco Crosswork Data Gateway can be installed into a data center using either the Cisco Cloud Services Platform (CSP) or VMware. The file used for deployment is unique to each of these environments. Use:
-
*.ovafile - to install Crosswork Data Gateway on VMware. -
*.qcow2file - to deploy Crosswork Data Gateway on Cisco Cloud Services Platform (CSP).
Compatibility Information for Crosswork Data Gateway 3.0
Cisco Crosswork Data Gateway 3.0 supports only Crosswork on-premise applications.
Cisco Crosswork Data Gateway release 3.0 has been validated in conjunction with:
-
Cisco Crosswork Network Controller 3.0
-
On-premise Crosswork Applications
-
Cisco Crosswork Change Automation 4.1
-
Cisco Crosswork Health Insights 4.1
-
Cisco Crosswork Optimization Engine 3.0
-
Cisco Crosswork Active Topology 3.0
-
Cisco Crosswork Zero Touch Provisioning 3.0
-
Cisco Crosswork Service Health 3.0 (pre-launch)
-
Crosswork Data Gateway provides two on-premise deployment options:
-
Standard: To be used with any on-premise Crosswork applications, except Cisco Crosswork Health Insights and Cisco Crosswork Service Health.
-
Extended: Required when using Crosswork Data Gateway with Cisco Crosswork Health Insights and/or Cisco Crosswork Service Health.
You can deploy Cisco Crosswork Data Gateway as a VM on a host that meets the following minimum requirements:
|
Requirement |
Description |
|||||
|---|---|---|---|---|---|---|
|
Data Center |
VMware
Cisco CSP
|
|||||
|
Memory |
|
|||||
|
Disk space |
|
|||||
|
vCPU |
|
|||||
|
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 |
|
— |
— |
|||
| 2* |
|
|
— |
|||
| 3* |
|
|
|
|||
(*) - 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 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.
|
|||||
|
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. |
|||||
The following table lists the software versions with which Cisco Crosswork Data Gateway 3.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
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.
Scale Support
Crosswork Data Gateway (Standard deployment profile) is tested with up to 2000 devices integrated with Crosswork Network Controller running Crosswork Optimization Engine and Crosswork Active Topology. The number of Crosswork Data Gateway VMs required varies based on a combination of factors such as the number and type of collection jobs, the number of destinations data is forwarded to, and other variables. To determine if your configuration requires additional Crosswork Data Gateway VMs, see Monitor Crosswork Data Gateway Health and for information on how to add a Crosswork Data Gateway VM to the pool, see Attach Devices to a Crosswork Data Gateway.
Features and Enhancements in Crosswork Data Gateway 3.0
This section lists the features delivered in Crosswork Data Gateway 3.0:
|
Feature |
Description |
|---|---|
| View Crosswork Data Gateway profile information in Cisco Crosswork UI |
Crosswork Data Gateway profile type (Standard or Extended) is displayed in the Data Gateway Management page of the Cisco Crosswork UI. |
| Add custom ports for SNMP Trap and Syslog collection | Cisco Crosswork Data Gateway allows you to change the default ports and add custom ports for Syslog and SNMP Trap collectors. |
| New Crosswork Data Gateway Operational State "Not Ready" |
Introduced a new Operational state Not Ready to indicate that Crosswork Data Gateway is not ready to receive collection jobs because the south bound IP address of the Crosswork Data Gateway has not been configured yet. |
| Additional Crosswork Data Gateway options to check Crosswork Data Gateway connectivity to a destination |
Options to ping, traceroute and change log level of Crosswork Data Gateway components from Cisco Crosswork UI. |
| Download collector metrics |
Option to download metrics for all collection jobs for a Crosswork Data Gateway VM from the Cisco Crosswork UI or the Interactive Console. |
|
Restart a Crosswork Data Gateway Service from Cisco Crosswork UI. |
Option to restart individual services running on the Crosswork Data Gateway VM from the Cisco Crosswork UI. |
| NETCONF collector |
Introduced NETCONF based data collection which supports following types of collection:
|
| SNMP Collector Enhancements |
|
| gNMI Collector Enhancements |
|
| Support for custom gRPC requests |
Support to add a gNMI subscription by specifying sensor path as GRPCSensor. |
| Filter syslog events with Filters-based SyslogSensor |
Option to filter syslog events with Filters-based SyslogSensor that is based on is based on RegEx, PRI or severity-facility. Combining multiple filters (maximum 3 filters) with "AND" or "OR" is supported. |
| Enhanced Monitoring and Troubleshooting options |
Ability to view the state and health of the Crosswork Data Gateway VM using the Diagnostics menu from the Interactive Console. |
Important Notes
Log4j patch for Crosswork Data Gateway 3.0.0 is part of Crosswork Infrastructure Log4j patch version 4.1.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 3.0 Documentation
The following table lists the guides provided for Cisco Crosswork Data Gateway 3.0
|
Document Title |
What is included |
|---|---|
|
Cisco Crosswork Data Gateway 3.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 4.1 and Applications Installation Guide |
Shared installation guide for all the Cisco Crosswork applications and their common infrastructure. Covers:
|
|
Cisco Crosswork Infrastructure 4.1 and Applications Administration Guide |
Shared administration guide for all the Cisco Crosswork applications and their common infrastructure. Covers:
|
|
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.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.
Open Bugs in Crosswork Data Gateway 3.0
For list of open bugs in Cisco Crosswork Data Gateway 3.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.
-
Go to the Cisco Bug Search Tool.
-
Enter your registered Cisco.com username and password, and click Log In.
The Bug Search page opens.
Note -
To search for a specific bug, enter the bug ID in the Search For field.
Open Source
A list of open source software used in Cisco Crosswork can be found in Open Source Software Used in Crosswork Data Gateway 3.0.
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.
Feedback