Cisco Crosswork Network Controller 7.2.x Administration Guide

PDF

Cisco Crosswork Network Controller 7.2.x Administration Guide

Collection job status fields and interpretations

Updated: August 14, 2026

Want to summarize with AI?

Log in

Details the collection job status fields and job details available in Crosswork Network Controller, and explains how to interpret active job, task, collection, and distribution states to diagnose issues across Embedded Collector instances.

Collection job status provides detailed information regarding each active collection job across all Embedded Collector instances registered to Cisco Crosswork.

View active collection jobs

You can monitor the status of collection jobs that are currently active on all Embedded Collector instances enrolled with Crosswork Network Controller from the Collection Jobs page. The left pane lists all active collection jobs and displays their Status, App ID, Context ID, and Action. Use the Action drop-down to delete collection jobs or refresh the status of a collection job and its associated tasks.

The Job Details pane shows the details of all collection tasks that are associated with a particular job in the left pane. The overall status of the Collection job in the Collection Jobs pane is the aggregate status of all the collection tasks in the Jobs Details pane.

View job details

When you select a job in the Collection Jobs pane, the following details are displayed in the Job Details pane:

  • Application name and context associated with the collection job

  • Collection job status

  • Job configuration of the collection job that you pass in the REST API request. Click the icon next to Config Details to view the job configuration. Crosswork Network Controller lets you view configuration in two modes:

    • View Mode

    • Text Mode

  • Collection type

  • Last modified date and time

  • Collections (x): Number of input collections; Issues (y) shows how many are UNKNOWN or FAILED

  • Distributions (x): Number of output collections; Issues (y) shows how many are UNKNOWN or FAILED

The overall job status is based on the aggregate status of all related collection tasks.

Key parameters shown for collection jobs

The Collection Jobs and Job Details panes display these information for active collection jobs:

Table 1. Collection jobs fields and descriptions

Field

Description

Collection/Distribution Status

Current status of the collection/distribution; updated on change. Click icon for details.

Hostname

Device hostname for the collection job.

Device Id

Unique identifier of the device being monitored.

Sensor Data

The sensor paths involved; view metrics summary for cadence-based statistics.

Click to see collection/distribution summary. From the sensor data summary pop-up you can copy the sensor data by clicking Copy to Clipboard.

Click to see collection/distribution metrics summary. The metrics are reported on a cadence-basis, i.e., once every 10 minutes by default. It shows the following metrics for a collection:

  • last_collection_time_msec

  • total_collection_message_count

  • last_device_latency_msec

  • last_collection_cadence_msec

It shows the following metrics for a collection:

  • total_output_message_count

  • last_destination_latency_msec

  • last_output_cadence_msec

  • last_output_time_msec

  • total_output_bytes_count

Destination

Data destination for the job.

Last Status Change Reported Time

Time and date of the last status change was reported for the device sensor pair.

Guidelines for interpreting the collection job states

  • The status of a collection task associated with a device after it is attached to an Embedded Collector, is Unknown.

  • A job could have status as Unknown for one of the following reasons:

    • Embedded Collectors have not yet reported its status.

    • Loss of connection between Embedded Collectors and Cisco Crosswork.

    • Embedded Collectors have received the collection job, but the actual collection is still pending. For example, traps are not being sent to Embedded Collectors southbound interface, or the device is not sending telemetry updates.

    • The trap condition in an SNMP trap collection job which we are monitoring has not occurred. For example, if you are looking for Link Up or Link down transitions and the link state has not changed since the collector was established, then the state reports as Unknown. To validate that trap-based collections are working, it is therefore necessary to actually trigger the trap.

  • After the collection job is processed, the status changes to 'Successful' if the processing was successful or else it changes to 'Failed'.

  • If a collection job is in a degraded state, one of the reasons might be that the static routes to the device have been erased from Embedded Collectors.

  • Collections to a destination that is in an Error state do not stop. The destination state is identified in the background. If the destination is in an Error state, the error count is incremented. Drill down on the error message that is displayed in the Distribution status to identify and resolve the issue by looking at respective collector logs.

  • Cisco Crosswork Health Insights - KPI jobs must be enabled only on devices mapped to an extended Embedded Collector instance. Enabling KPI jobs on devices that are mapped to a standard Embedded Collector instance reports the collection job status as Degraded and the collection task status as Failed in the Jobs Details pane.

Create a collection job

You can publish collection jobs created through the Crosswork Network Controller UI page only once.

Use the Crosswork Network Controller UI to create jobs that collect device or network data via CLI or SNMP. These jobs enable centralized data collection for analysis or export.

Before you begin

Ensure that a data destination is created and active for depositing collected data. Make sure you have the details of the sensor path and MIB from which you plan to collect data.

Procedure

1.

Go to Administration > Data Gateway Management > Collection Jobs > Bulk Jobs.

2.

Click Add icon.
3.

On the Job details page, enter values for these fields:

  • Application ID: A unique identifier for the application.

  • Context: A unique identifier to identify your application subscription across all collection jobs.

  • Collector Type: Select the type of collection as either CLI or SNMP.

Figure 1. Job details
Job Details Window

  1. Click Next.
4.

Select the devices from which you want to collect data.

You can select devices by device tag or choose them manually.

  1. Click Next.

    Figure 2. Select devices
    Select Devices Window
5.

Enter these sensor details for CLI collection:

  1. Select data destination from the Select Data Destination drop-down list.

  2. Select sensor type from Sensor Types pane on the left.

  3. If you select CLI PATH, click Add icon and enter these parameters in the Add CLI Path dialog box:

    • Collection Cadence: Push or poll cadence in seconds

    • Command: CLI command

    • Topic: Topic associated with the output destination

      Note
      Topic can be any string if using an external gRPC server.

  4. If you select Device Package, click Add icon and enter these parameters in the Add Device Package Sensor dialog box:

    • Collection cadence: Push or poll cadence in seconds

    • Device Package Name: Custom XDE device package ID used when creating the device package

    • Function name: Function name within custom XDE device package

    • Topic: Topic associated with the output destination

  5. Enter Key and String value for the parameters.

  6. Click Save.

Figure 3. Sensor details for CLI path
Sensor Details Window
Figure 4. Add CLI path
Add CLI Path Dialog Box
Figure 5. Add device package sensor
Add Device Package Sensor Dialog Box
6.

Enter these sensor details for SNMP collection:

  1. Select data destination from the Select Data Destination drop-down list.

  2. Select sensor type from Sensor Types pane on the left.

  3. If you select SNMP MIB, click Add icon and enter these parameters in the Add Device Package Sensor dialog box:

    • Collection Cadence: Push or poll cadence in seconds.

    • OID

    • Operation: Select the operation from the list.

    • Topic: Topic associated with the output destination.

  4. If you select Device Package, click Add icon and enter values for these parameters in the Add Device Package Sensor dialog box:

    • Collection Cadence: Push or poll cadence in seconds.

    • Device Package Name: Custom device package ID used when creating the device package.

    • Function name: Function name within custom device package.

    • Topic: Topic associated with the output destination.

  5. Enter the key and string value for the parameters.

  6. Click Save.

Figure 6. Sensor details for SNMP path
Sensor Details Window
Figure 7. Add SNMP MIB
Add SNMP MIB Dialog Box
7.

Click Create Collection Job.

The new collection job is published and starts gathering data according to configuration.

What to do next

Review job status and ensure data is being deposited to the specified destination as expected.

View active collection jobs

View all currently active collection jobs on Embedded Collector instances.

Use the Collection Jobs page in Cisco Crosswork to get an overview of every active collection job and interact with status and management controls.

Procedure

1.

Go to the Collection Jobs page in the Crosswork Network Controller UI.
2.

From the left navigation bar, choose Administration > Collection Jobs.
3.

Review the list of active collection jobs and note their Status, App ID, Context ID, and Action.
4.

Use the Action drop-down to delete a collection job or refresh the status of a job and its associated tasks.

You can view the real-time status of active collection jobs and manage them for all enrolled Embedded Collector instances.

Delete a collection job

Remove an unwanted external collection job from your system.

Deleting a collection job also deletes its associated collection tasks. Delete jobs created by Health Insights by disabling the KPI profile. This action removes the collection jobs that the profile deployed.

Before you begin

Do not delete system jobs created by Crosswork Applications as deletion could cause collection issues.

Jobs created by Health Insights should only be deleted by disabling the KPI profile which will remove the collection jobs it deployed.

Procedure

1.

Go to Administration > Collection Jobs.
2.

Select the Bulk Jobs or Parametrized Jobs tab.
3.

Select the collection job you want to delete.

4.

In the job's row, select Delete.
5.

Confirm by clicking Delete in the confirmation window.

The selected collection job and its collection tasks are deleted.