Overview of Crosswork Data Gateway
Cisco Crosswork Data Gateway is a secure, common collection platform for gathering network data from multivendor devices. It is an on-premise application deployed close to network devices and supports multiple data collection protocols including MDT, SNMP, CLI, gNMI, and Syslog.
![]() Note |
The NETCONF data collection support is deprecated starting from the Crosswork Network Controller 6.0 release. |
The number and deployment profiles (Standard or Extended) of Crosswork Data Gateways, also referered to as data gateways, you need depends on the number of devices supported, the amount of data being processed, the frequency at which it’s collected, and the network architecture.
When data gateway is deployed with Crosswork Infrastructure (also referred to as Cisco Crosswork in this guide), Cisco Crosswork acts as the controller application.
Crosswork Data Gateway uses the following concepts:
-
Crosswork Data Gateway Instance: A Crosswork Data Gateway or a data gateway instance that you install.
- Crosswork Data Gateway Profile: Data gateway supports the following deployment profiles:
-
Standard: for use with all Crosswork applications, except Crosswork Health Insights, and Crosswork Service Health (Automated Assurance).
-
Extended: for use with Crosswork Health Insights and Crosswork Service Health (Automated Assurance).
Attention
The Standard with Extra Resources profile is available as a limited-availability feature and must not be used while deploying data gateway in your data center.
-
-
Crosswork Data Gateway Pool: A logical unit of one or more data gateway instances with an option to enable high availability. When a data gateway instance goes down, Cisco Crosswork automatically replaces the instance with a spare instance from the pool to ensure that data collections have minimal disruption.
-
Crosswork Data Gateway: A data gateway instance that is assigned a virtual IP address when it is added to a data gateway pool.
Operations such as attaching or detaching devices, creating collection jobs happen on the data gateway.
-
Data Destination: Internal or external recipients of data collected by the data gateway. By default, Cisco Crosswork is defined as a data destination. Other destinations (external users) can be defined using the Cisco Crosswork UI or APIs.
-
Collection Job: A task that data gateway has to complete to collect data. Crosswork applications create collection jobs to check device reachability, collect telemetry data needed to determine network and service health. The Cisco Crosswork UI and API allow you to configure collection jobs for non-Crosswork applications.
-
Custom Software Packages: Files and device model definitions to extend device coverage and support data collection from currently unsupported devices.
![]() Note |
This chapter explains only the data gateway features that can be accessed via Cisco Crosswork UI. For more information about the Interactive Console of the data gateway instance and how to manage it, see Appendix A: Configure Crosswork Data Gateway Instance. |
Crosswork Data Gateway UI Overview
To open the Crosswork Data Gateway management view, log in to Cisco Crosswork and choose from the left navigation bar.
![Data Gateway Management Window](/c/dam/en/us/td/i/400001-500000/480001-490000/483001-484000/483398.png)
The Data Gateway Management page has three tabs:
-
Data gateways: Displays details of the virtual data gateways in the network. You can attach or detach devices to the Data Gateway from this tab.
-
Pools: Manages the data gateway pools.
-
Data gateways instances: Manages virtual the data gateway instances.
You can filter the tables by clicking the legends next to the donut chart visualization. For example, to view the pools with the administration state as Up, click the Up icon next to the Administration state chart. The table filters the pools with the state Up.
To select which columns will be displayed in the table, click the Settings icon in the top-right corner of the table and select the relevant check boxes. In order to hide the columns, clear the check boxes.
All the tables in the data gateway UI, allows you to multiselect the items by clicking the empty field and choosing Select all from the menu. All the selected items are displayed in the table. To clear the selection, click the X icon next to the selected item.
The following table explains the various columns in the Data Gateway Management page.
Column |
Description |
||
---|---|---|---|
Operational State |
Operational state of the data gateway instance. A data gateway instance has the following operational states:
|
||
Administration state |
Administration state of the data gateway instance. The state could be any of the following:
|
||
High availability status |
High availability status of a data gateway could be either:
|
||
Devices |
Number of devices attached to the data gateway pool. |
||
Name |
Name of the data gateway instance. Clicking the
Click the instance name to open the data gateway vitals page. The page displays the operations and health summary of a data gateway. |
||
Pool name |
Name of the data gateway pool. On clicking the pool name, the data gateway vitals page opens. |
||
Site name |
Site to which the data gateway instance is assigned.
|
||
Data gateway instance role |
Indicates the current role of the data gateway instance. The role could be any of the following:
|
||
Outage history |
Outage history of the data gateway instance over a period of 14 days. State aggregation for a day is done in the order of precedence as Error, Degraded, Up, Unknown and Not Ready. For example, if the data gateway instance went Unknown to Degraded to Up, color is displayed as Degraded (orange) for that day as Degraded takes precedence over Up and Unknown. If the data gateway was in Error state at any time during that day, the tile is Red. If the Data Gateway was not in Error but in Degraded State anytime of the day, the tile is Orange. If the data gateway was not in Error or Degraded state and was only Up, then the tile is Green. |
||
Average availability |
Value indicating the health of the data gateway instance. This percentage is calculated as the total time (in milliseconds) a data gateway was in UP state over the time between start time of first event and end time of last event.
|
||
Data gateway instance name |
Name of the data gateway that is created automatically when you add a data gateway instance to a pool. Clicking the
The Additional interface role information describes the interface roles available in data gateway. |
||
Attached device count |
Indicates the number of the devices that are attached to the data gateway pool. |
||
PDG identifier |
Unique identifier of the physical data gateway instance. |
||
Actions |
Click
|
You can configure the Crosswork Data Gateway dashlet in the Crosswork Home page > Dashboard. The dashboard allows you to customize the dashlet to display the summary of the data gateway instances and pools. For information on using Dashboard, see Overview of the Topology Map.