Cisco Crosswork Network Controller 7.2.x Administration Guide

PDF

Cisco Crosswork Network Controller 7.2.x Administration Guide

CSV device imports

Updated: August 14, 2026

Want to summarize with AI?

Log in

Provides instructions for bulk device onboarding using CSV files in Crosswork Network Controller. It outlines formatting guidelines, best practices for data management, and step-by-step procedures for importing and exporting device records.

A CSV device import is a bulk onboarding method that:

  • enables users to add multiple devices to the Crosswork Network Controller in a single action,

  • allows avoidance of repetitive manual entry, and

  • updates existing records when matching inventory key types are found (excluding system-generated UUIDs).

CSV import is most useful in large environments where device addition efficiency and accuracy are critical.

CSV file behavior

  • Import only adds devices not already present in the database.

  • Existing device records (excluding system-generated UUIDs) are overwritten if the inventory key type matches a record in the CSV.

  • Fields requiring unique values, such as VRF, router loopback, or loopback ID, must be explicitly set.

  • Non-required fields can be left blank, set to a default value, or are auto-populated after device communication is established (e.g., model, type, software version).

Handling non-required fields in the CSV file

For fields that are not required in the CSV, the following can occur:

  • The field may be left blank.

  • The field may be set to a default value.

  • The field may be populated with values retrieved from the device once communication is established, such as model, type, or software version.

Recommendations for CSV import

To prevent errors when importing CSV files, follow these recommendations:

  • Export a backup copy of your existing device list before any CSV import, to prevent accidental data loss.

  • Export the current device configuration to generate a CSV template tailored to your environment. Use this exported file as a baseline for further additions.

  • Always make necessary edits to exported CSV files. Files exported directly from the UI cannot be re-imported without changes.

  • Add a few devices using the Crosswork Network Controller UI and verify they are functioning before importing in bulk.

  • Before importing, ensure the Crosswork Data Gateway and UUID columns in the CSV file are empty.

  • If importing multiple CSV files, verify that there are no duplicate devices between them.

  • If there are any errors in the import file, they are not reported all at once. Instead, the system identifies and displays errors one at a time, starting with the first error it encounters. Address these errors sequentially as reported during import.

  • The device import CSV format differs for cluster deployments versus single VM deployments. Use the correct template for your environment.

Formatting guidelines

  • CSV files from Windows machines must use ‘newline’ characters, not ‘carriage return,’ in order to process correctly.

  • To enter multiple values in a field, use semicolons (e.g., SSH;SNMP;NETCONF). Use double semicolons ‘;;’ with no space for blank fields.

  • Use a semicolon to separate multiple entries in the same field. Use two semicolons with no space between them to indicate that you are leaving the field blank. When you separate multiple entries with semicolons, remember that the order in which you enter values in each field is important.

    For example, if you enter SSH;SNMP;NETCONF in the Connectivity Type field and you enter 22;161;830 in the Connectivity Port field, the order of entry determines the mapping between the two fields:

    • SSH: port 22

    • SNMP: port 161

    • NETCONF: port 830

Template usage

After downloading and editing the CSV template, delete all sample data rows before saving. Retain only the column header row for import.

Special fields

Populate the TE router ID for each device to ensure unique identification within the topology.

Device reachability

Devices may initially show as unreachable or not operational when they are first imported. However, if they are still displayed as unreachable or not operational after 30 minutes, there may be an issue that needs to be investigated. To investigate, select Device Management > Job History and click on any error icon you see in the Status column. Common issues include failure to ensure the associated credential profile contains the correct credentials. You can test this by opening a terminal window on the server and then trying to access the device using the protocol and credentials specified in the associated credential profile.

Add devices from a CSV file

Add multiple network devices to Crosswork Network Controller by importing their details from a CSV file.

Use this task when you want to onboard several devices at once, rather than adding them individually.

Before you begin

Review /32 and /31 entries to determine whether host-specific routes are required. Check for overlapping networks and estimate the number of routes the import will create. Ideally, the system should have fewer than 200 static routes. Test a representative batch before importing the complete inventory.

Procedure

1.

Choose Device Management > Network Devices. The Network Devices tab is displayed.
2.

Open the Import CSV File dialog box.
3.

If you have not already created a device CSV file to import:

  1. Click the Download sample 'Device Management template (*.csv)' file link and save the CSV file template to a local storage resource.

  2. Open the template using your preferred tool. Begin adding rows to the file, one row for each device.

  3. Delete the sample data rows before saving the file, or they will be imported along with your data. You can keep the column header row, as it is ignored during the import process.

  4. Save the new CSV file.
4.

Click Browse to navigate to the CSV file you created in the previous steps and then click Open to select it.
5.

With the CSV file selected, click Import and wait for the import to complete.
6.

Resolve any errors and confirm device reachability.
7.

Once you have successfully onboarded the devices, map them to a data gateway instance.

Export device information to a CSV file

Keep a record of all devices in the system at one time by exporting the device information.

You can also edit the CSV file as needed, and re-import it to overwrite existing device data.

Procedure

1.

From the main menu, choose Device Management > Network Devices. The Network Devices tab is displayed by default.

2.

(Optional) Filter the device list as needed.
3.

Check the check boxes for the devices you want to export.
4.

Click Export icon.

Note

The exported CSV file includes all available device-data columns, regardless of the columns currently displayed in the UI. Columns that display dynamically derived or operational data, such as operational state, NSO state, and rechability state, are not included in the export.