BMC Discovery

The topics in this section describe import procedures for file-based import tasks (for example, CiscoWorks RME, Ipswitch WhatsUp, CSV file, Entuity Network Analytics). If you decide to schedule an import task, you must ensure that the import file has been exported from its source before the scheduled import time.

To add a file access device import task

1. Navigate to Admin > Network Admin > Device Import.
   The Device Import Tasks page is displayed.
2. Click Add to define a new device import task.
   The Add Device Import Task dialog box is displayed.
   
   

3. On the Details tab, define device import task details through the displayed fields:
   
   

   Field	Description
   Name	Enter a unique name, up to 40 characters, for the import task.
   Annotation	(Optional) Enter a comment or remark about the import task.
   Enabled	(Optional) Select this option to enable the import task. By default the task is enabled.
   Auto Purge	(Optional) Select this option to purge the import task after its scheduled execution.
   Initial Snapshot	(Optional) Select this option if the import task should automatically back up each device's configuration file(s) during the import. When an import file contains a large number of new devices (for example, greater than 200 new devices), BMC Software recommends not performing the initial snapshot as part of the import operation. This enables the import to complete in a short duration. You can accomplish the initial snapshot for new devices by adding a job containing a snapshot action (Network > Actions > Jobs) or by using a scheduled policy. Note: If you have selected the Overwrite Device Type option and the device import task results in change in device type, snapshot is performed even if you have not selected the Initial Snapshot option.
   Format	Specify the device import file format.

4. In the Source field within the File Access section, specify the path of the import source file or URL.
   For example:
   
   • D:\BCA-Networks-Data\devices\devices.dat, http://myserver/devices.xml, or https://myserver/devices.xml
     
   • For other import formats:

     • Using a URL for Entuity Network Analytics data

       The [expand] macro is a standalone macro and it cannot be used inline. Click on this message for details.
       This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
       

     • Using a URL for BMC Atrium Discovery and Dependency Mapping data

       The [expand] macro is a standalone macro and it cannot be used inline. Click on this message for details.
       This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
       The import file must be present and accessible to the server when the import task starts. For instructions on how to create the import source file for supported management systems, see the relevant section:

       • Exporting-CiscoWorks-RME-data
       • Exporting-InterMapper-database-data
       • Exporting-Ipswitch-WhatsUp-Gold-database-data
       • Exporting-Ipswitch-WhatsUp-Professional-database-data
5. 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: TrueSight 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: TrueSight 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). 
   • Match by Primary Interface Address Resolved: TrueSight Network Automation searches for an existing device by variations on the imported address, within the device agent associated with the imported device. TrueSight Network Automation uses DNS to resolve the supplied address into an IP address, a host name, and a fully-qualified host name, and then tries to match an existing device's address to any of these values.
     
     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.
6. 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).

7. In the Import Time box, set the import time. The time setting depends on your selection in 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.

8. In the Dynamic Menu Fields box, select whether to accept or reject unknown menu values for dynamic fields during the import, as described 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).

     

9. New in 8.9.04.001 (Displayed only for the TrueSight Network Automation XML and Comma Separated Value Text formats) In the Static Group Membership Changes box, specify whether you want to add only missing group associations or overwrite the existing group associations with the new ones:

   • Only Add Missing Group Associations: Retains the existing group associations for a device and associates only those groups with a device that were not associated earlier.
   • Replace All Existing Group Associations: Removes the existing group associations for a device and associates the device with only the new groups.

   If the group you added in the CSV file does not exist in the system, that group is added to the system and device is associated with that group. 

   Note

   This option is applicable for only static groups, not auto groups.

10. New in 8.9.04.001 (Displayed only for the Comma Separated Value Text format) In CSV File Group Name Separator, enter the character that you have used to separate groups in the CSV file. Default value is comma (,). If you do not specify a separator in the CSV file or leave this field blank, comma is used. 
11. In the Scope box, configure the following settings:
    • Process: Specify which devices to process in the import file.
      • All Devices from the Import Source: This option processes new and existing (that is, overwrite) devices during the import.
      • Only New Devices from the Import Source: This option only imports devices that are not found in the database.
      • Only Existing Devices from the Import Source: 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.

      Note

      If you have selected this option and the device import task results in change in device type, snapshot is performed even if you have not selected the Initial Snapshot option.

12. On the Defaults tab, set device inventory default values (optional) for each imported device.
    
    

    Note

    During the import operation, values for device fields are assigned based on the following precedence order:

    1. Field is assigned based on the import file
    2. Field is assigned based on the existing value in the device database record
    3. Field is assigned the default supplied on the device import task Default Tab
    4. Field is assigned a default value assigned by the system
    5. Field is left blank (only if the field is not mandatory)
       
       Based on this precedence, the Defaults in the import task are only used when the field is not assigned in either the import file or the current device database record. Assigning Defaults is only applicable for new devices or unassigned field values on existing devices.
13. Click Save to save and schedule the new import task.
     After the import tasks completes, you can view the status of the import by selecting the Status tab.
    
    Click the view details link on the Status tab to display a detailed import status report. This report is also available from the Import list under Execution Status.
    
    

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.

The topics in this section describe the mapping for the BMC Discovery (formerly known as BMC Atrium Discovery and Dependency Mapping or BMC Atrium Discovery) formats.

• • BMC Discovery 11.0 and later (REST API) format
  • BMC Discovery version 8.2, 10.2, 11.0 and later (XML API) format
  • BMC Atrium Discovery version 7.5 format
  • Mapping for the BMC Foundation Discovery 1.5 format

BMC Discovery 11.0 and later (REST API) format

BMC Discovery versions 11.0 and later (specified as 11.0+ in the GUI) use the REST API to perform the import task, unlike earlier device imports. 

Enter these details in the REST API Access fields.

• URL: Format the URL in the following format: https://Discovery_Server:port/api/v1.0/data/search
• User Name: Discovery UserName
• Password: password
• Query Parameter Name: query
• Query Parameter Value: search NetworkDevice show name,#InferredElement:Inference:Associate:DiscoveryAccess.endpoint, sysobjectid
  

Substitute the following values in the query URL:

The API call returns the following response:

The results element contains the device details, such as device name, device address, and snmpoid.

BMC Discovery version 8.2, 10.2, 11.0 and later (XML API) format

BMC Discovery versions 8.2, 10.2, 11.0 and later (specified as 10.2 (XML API) and 11.0+ (XML API) in the GUI) use the XML API to perform the import task, unlike earlier device imports.

Format the URL as shown in the following example (all on a single line). Enter this URL on the import page into the Source field in the File Access section.

https://DISCOVERY_SERVER/ui/api/XmlApi?query=search NetworkDevice show name,#InferredElement:Inference:Associate:DiscoveryAccess.endpoint, sysobjectid&username=DISCOVERY_USERNAME&password=DISCOVERY_PASSWORD

Substitute the following values in the query URL:

The query returns the following values:

BMC Atrium Discovery version 7.5 format

The import task maps the BMC Atrium Discovery version 7.5 database fields to the device record as follows:

Mapping for the BMC Foundation Discovery 1.5 format

The import task maps the BMC Foundation Discovery 1.5 database fields to the device record as follows.