Cisco Crosswork Network Controller 7.2.x Administration Guide

PDF

Cisco Crosswork Network Controller 7.2.x Administration Guide

Device assignments and Data Gateway instance management

Updated: August 14, 2026

Want to summarize with AI?

Log in

Administration states of Data Gateways

An administration state is an operational mode that

  • controls the availability and maintenance status of Data Gateway

  • determines how upgrades and certificate updates are performed, and

  • affects communication between Crosswork and the Data Gateway.

The administration states are Up, Maintenance, Patch in-progress, and Patch failed.

Impact of maintenance mode on communication and upgrades

During maintenance, administrators can suspend communication between Data Gateway and Crosswork to perform upgrades. In maintenance mode, certificate updates and other modifications are allowed. Communication interruptions during maintenance temporarily pause job collection, which resumes when the connection is restored.

Note
A Data Gateway in the Assigned state cannot directly enter maintenance mode without first executing a manual failover or removing it from the pool.

If an administrator needs to change certificates, they place the Data Gateway in maintenance mode, perform the update, and set the state back to Up. Crosswork Network Controller resumes operations automatically once the Data Gateway is up.

Change the administration state of a Data Gateway

Change a Data Gateway's operational state, for example, to Maintenance mode during upgrades or maintenance.

When performing upgrades or maintenance, it may be necessary to temporarily suspend communication between Crosswork and a Data Gateway by setting the gateway to Maintenance mode. This enables administrators to update configurations or certificates as needed.

Use these steps to change the administration state of a Data Gateway.

Before you begin

Before switching to maintenance mode, ensure that the Data Gateway's role status meets the required conditions.

  • Verify that you have READ and WRITE permissions for both Data Gateway Manager APIs and Platform APIs in Global API permissions. Without these, you cannot change administration state via the Crosswork UI. For more information, see Global API Permissions.

  • Ensure the Data Gateway's role status meets all specified conditions before you change its state.

    • The Data Gateway may have a "Spare" role after failover or may be "Assigned" if it is the only node in a pool.

    • The Data Gateway's role status must comply with these conditions before changing state.

Procedure

1.

Go to Administration > Data Gateway Management > Data Gateway Instances.

Click the Data Gateway or pool name in the table to view its operations and health summary; this action opens the details page. To see enrollment details, including interface role information, click the info icon next to the Data Gateway instance name.
2.

For the Data Gateway you want to update, click the edit icon under the Actions column.

Figure 1. Data gateway instances
Data Gateway Instances Window
3.

Select the desired administration state such as "Active" or "Maintenance" for the Data Gateway.
The Data Gateway's administration state is updated, and it is placed into the selected state (for example, Maintenance mode for administrative operations).

What to do next

After maintenance, return the Data Gateway to Active state as needed for normal operation.

Attach devices to Data Gateway

Attach network devices to Crosswork Data Gateway to enable secure, centralized data collection across protocols.

Use this procedure when you need to add new devices for data collection to an existing Crosswork Data Gateway instance.

Before you begin

Verify that you are familiar with the prequsites to successfully attach the devices to the Data Gateway. For more information, see Device assignment prerequisites.

Procedure

1.

Navigate to Administration > Data Gateway Management > Data gateways.

2.

For the Crosswork Data Gateway where you want to attach devices, select Actions > Attach devices.

Figure 2. Attach devices
Attach Devices Window
The Attach devices window displays all available devices. In the Tags column, if tags are hidden, the UI displays the number of hidden tags. To view these tags, hover over the number (for example, +3).
3.

To attach all devices, select Attach all devices. Or, select individual devices to attach and choose Attach selected devices.
4.

In the confirmation dialog, select Attach.

The selected devices are now associated with the Data Gateway for secure, centralized data collection.

What to do next

  • Check the Attached device count in the Data gateways pane to verify your changes.

  • Monitor the Data Gateway's health to ensure proper operation with the newly attached devices.

Move devices to a different Data Gateway

Before you begin

Confirm that you are familiar with the prerequisites required to move devices between Data Gateways. For more information, see Device assignment prerequisites.

Procedure

1.

Go to Administration > Data Gateway Management > Data gateways.

Figure 3. Data gateways
Data Gateways Window
2.

From the To this data gateway drop down, select the Data Gateway to which you want to move the devices.

The Attach devices window lists all available devices.
3.

To move all the devices, click Move all devices. Otherwise, select the devices you want to move and click Move selected devices.
4.

In the Confirm - Move devices window, click Move.

Detach devices from Data Gateway

Before you begin

Confirm that you are familiar with the prerequisites required to detach devices from the Data Gateway. For more information, see Device assignment prerequisites.

Procedure

1.

Go to Administration > Data Gateway Management > Data gateways.

Figure 4. Data gateways
Data Gateways Window
2.

For the Data Gateway you want to detach devices from, click the Actions column, then click More icon and select Detach devices.

The Detach devices window displays all attached devices.
Figure 5. Detach devices
3.

To detach all devices, click Detach all devices. To detach specific devices, select the devices you want, and then click Detach.
4.

In the Confirm - Detach Devices window, click Detach.

Verify that your changes are successful by checking the Attached device count under the Data gateways pane. Click next to the attached device count to view the list of devices attached to the selected Data Gateway."

For information about initiating a failover, see Perform a manual failover.

Delete the Data Gateway instance from Crosswork Network Controller

Remove a Data Gateway instance that is no longer needed.

Use this task when you need to decommission or replace a Data Gateway instance in Crosswork Network Controller.

Before you begin

Review these guidelines to prevent interruptions during the Data Gateway deletion process:

  • To prevent collection job loss, move the attached devices to an alternative Data Gateway. If you detach the devices from the Crosswork Data Gateway instance, the corresponding jobs will be deleted.

  • If the Data Gateway instance is part of a pool, ensure that it is in the unassigned state.

Use these steps to delete the Data Gateway instance from Crosswork Network Controller.

Procedure

1.

Navigate to Administration > Data Gateway Management > Data gateway instances.
2.

Select the Data Gateway instance you want to delete, click Delete under Actions.

Figure 6. Data Gateway instances
Data Gateway Instances Window
3.

If prompted, switch the Data Gateway instance to maintenance mode by clicking Switch to maintenance & continue.

Figure 7. Switch to maintenance mode confirmation message
Switch to Maintenance Popup Window
4.

Acknowledge the deletion concern by selecting the check box, then click Remove CDG.

Figure 8. Delete Data Gateway confirmation message
Delete Data Gateway Confirmation Dialog Box

The selected Data Gateway instance is removed from Crosswork Network Controller.

What to do next

Verify that all device associations and jobs are redirected or handled by the remaining Data Gateways.

Redeploy a Data Gateway VM

Redeploy a Data Gateway VM in scenarios where the existing VM has gone down and can no longer be used, or when there is a need to change the deployment profile of the VM

Use this task when you need to redeploy a Data Gateway in Crosswork Network Controller.

Before you begin

Review these guidelines to prevent interruptions during the Data Gateway VM redeployment.

  • If the Data Gateway VM was already enrolled with Cisco Crosswork and you have installed the VM again with the same name, change the Administration state of the Data Gateway VM to Maintenance for auto-enrollment to go through.

  • If a Data Gateway VM was already enrolled with Cisco Crosswork and Cisco Crosswork was installed again, re-enroll the existing Data Gateway VM with Cisco Crosswork. See Re-enroll Crosswork Data Gateway.

  • If you are redeploying a Data Gateway VM with the same hostname, clear the existing alarms for that hostname to avoid confusion. Old alarms remain viewable in the history. To avoid misunderstanding, check the timestamps on the alarms. This lets you determine whether the alarms were raised on the older Data Gateway or the current one with the same hostname.

Procedure

1.

Remove the current Data Gateway VM before installing the new one.
2.

Install Data Gateway on the new VM.

For detailed installation instructions, see the Cisco Crosswork Network Controller 7.2.x Installation Guide.
3.

If the redeployment is to change the VM profile, for example, from Standard to Extended, manually roll back any global parameter changes made to the Data Gateway before starting redeployment to avoid configuration conflicts.

Related topics