Adding a JDBC database access device import task
This topic provides instructions on importing device inventory directly from a database using a JDBC SQL driver. The factory-installed JDBC SQL-based import adapters include HP Data Warehouse and BMC Discovery. You can also develop your own JDBC import adapters. See Creating-a-user-defined-database-query-format.
On the Admin > Network Admin > Device Import Tasks page, click Add, and do the following:
On the Details tab, enter the following information:
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
In the JDBC Database Access box, define the following settings:
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
- In the Matching criteria field, specify how to match the imported device data to devices already in the system's device database. When a device match is found, the existing device record is updated with the imported values. When no match is found, a new device record is added using the imported values.
You can match on either the name or the primary address, which must then appear as a field in the import data. For example, if you import from CSV and match on address, then the CSV file must include an address column and a value in each row.- Match by Device Name: Network Automation looks for an existing device by the imported name (case-insensitive). Note that device names are unique, so only one device matches.
- Match by Primary Interface Address Exactly: Network Automation searches for an existing device by the imported address, within the device agent associated with the imported device (based on the imported device agent or the default device agent).
Matching by address allows device names to be changed during import (though the resulting name must be unique). If multiple matches result (as addresses need not be unique), then the device is skipped. - Match by Primary Interface Address Resolved: Network Automation searches for an existing device by variations on the imported address, within the device agent associated with the imported device. Network Automation uses DNS to resolve the supplied address into an IP address, a hostname, and a fully-qualified hostname, and then tries to match an existing device's address to any of these values. If multiple matches result, then the device is skipped.
- In the Repeat field, specify how often to repeat the import task. You can choose between a one-time occurrence (Import Once), or a recurring task (Import Daily, Import Weekly, or Import Monthly ).
In the Import Time box, set the import time. The time setting depends on your selection in the the Repeat field:
Repeat setting
Time setting
Import Once
Either set the import time to Now or specify a date and time (hour and minute) in the future.
Import Daily
Specify the time (hour and minute) to execute the import task each day.
Import Weekly
Specify the time (hour and minute) and day(s) of the week to execute the import task.
Import Monthly
Specify the day of the month and import time to execute the import task.
In the Dynamic Menu Fields box, select whether to accept or reject unknown menu values for dynamic fields during the import, as detailed in the following table:
Primary condition
Second condition
Third condition
Result action
Menu value already exists for the dynamic field
Not applicable
Not applicable
The Accept/Reject Unknown Values setting is ignored. The device record is imported.
Menu value does not exist
Accept Unknown Values is selected
Not applicable
The new menu value is added to the list of available menu items, and the device record is imported.
Reject Unknown Values is selected
Field is required and has no default value
The device record is not imported.
Field is required and has a default value
The device record is imported, and that field is set to the default value.
Field is not required
The device record is imported, and that field is set to the default value (if any).
- In the Scope box, configure the following settings:
- Process: Specify which devices to process in the import file.
- All Devices From the Import File: This option processes new and existing (that is, overwrite) devices during the import.
- Process Only New Devices From the Import File: This option only imports devices that are not found in the database.
- Process Only Existing Devices From the Import File: This option only imports devices that are found in the database.
- Overwrite Device Type: Specify for existing devices, if the Device Type (for example, Cisco CatOS Switch) should be overwritten with a new Device Type (for example, Cisco IOS Switch/Router). Configuration files for the old device type are kept in the archive. For example, this feature is helpful when converting Cisco CatOS devices to Cisco IOS devices. You must select this option to overwrite an existing device type.
- Process: Specify which devices to process in the import file.
On the Defaults tab, set device inventory default values (optional) for each imported device.
- Click Save to save and schedule the new import task.
After the import tasks completes, you can view the status of the import task in the Device Import Task Details window, as follows:- Click the task name.
- Scroll down the window.
The Status section shows the task status. This report is also available from the Import list under Execution Status.
Click the View details link to display a detailed import status report.
Where to go from here
After importing devices for the first time, the following procedures are recommended:
- For those fields not imported, use the device Mass Edit feature to assign fields common to a set of devices (for example username, password, privilege password, access type) or edit each device individually.
- If you did not select Initial Snapshot on the Import tasks, perform a manual snapshot operation to retrieve the current configuration files.