Important

   

Starting from version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about TrueSight Network Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Network Automation 8.9.

BMC Discovery

TrueSight Network Automation supports integration with BMC Discovery (formerly BMC Atrium Discovery and Dependency Mapping or BMC Atrium Discovery). This integration, which is done through an API leverages the NetworkDevice nodes discovered by BMC Discovery by importing specific attributes of these nodes into TrueSight Network Automation. BMC Discovery automatically discovers physical and virtual IT assets and applications, and the relationships between them. Once the devices are discovered, you can use TrueSight Network Automation to manage network devices and automate network configuration changes and compliance processes. This topic includes the following sections:

Supported versions

TrueSight Network Automation supports the following versions of BMC Discovery:

  • 11.3.00.005 (applicable to only product versions 8.9.04.001, 8.9.04.002, and 8.9.04.003)
  • 11.3.00.004 (applicable to only product version 8.9.04)
  • 11.3 (applicable to only product version 8.9.03)
  • 11.1 (applicable to only product versions 8.9.01 and 8.9.02)
  • 11.0 

Integrating with BMC Discovery

The integration between TrueSight Network Automation and BMC Discovery is HTTP URL based, and is performed by creating a device import task in TrueSight Network Automation. For more information, click the following topics:

 Adding a file access device import task

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

         Click here for details.

        For the Source field, copy and paste the following URL: 

        http://<entuityServer>:<entuityWebport>/EOS/cgi/GenerateReport?noCreate=1&of=xml&DeviceEx.filter=all&DeviceEx.attr=id%2Cname%2CdevPolledIpAddr%2CsysOid&DeviceEx.attr.1=%23entuity_server_info()%5B0%5D%23%2C%22serverId%22%2C%22displayType%3Dstring%22&login=<userName>:<password>

        Replace the following variables with the actual values for your enterprise:

        Variable

        Description

        entuityServer

        The server name or IP address where Entuity Network Analytics is running

        entuityWebport

        The webserver port where Entuity Network Analytics is running

        userName

        The user name of an administrator account

        password

        The password corresponding to the user name


        For more information about other methods for specifying the source file URL see Entuity Network Analytics.

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

         Click here for details.

        For the Source field, copy and paste the following URL:

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

        Replace the following variables with the actual values for your enterprise:

        Variable

        Description

        DiscoveryServer

        The server name or IP address where BMC Discovery is running.

        username

        The BMC Discovery server user name.

        password

        The password corresponding to the user name Any special characters in the password such as the ampersand (&), percent sign (%) or equal sign (=) must be encoded as hexadecimal numbers (for example, %26 and so forth).


        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:

  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 conditionSecond conditionThird conditionResult action
    Menu value already exists for the dynamic fieldNot applicableNot applicableThe Accept/Reject Unknown Values setting is ignored. The device record is imported.
    Menu value does not existAccept Unknown Values is selectedNot applicableThe new menu value is added to the list of available menu items, and the device record is imported.
    Reject Unknown Values is selectedField is required and has no default valueThe device record is not imported.
    Field is required and has a default valueThe device record is imported, and that field is set to the default value.
    Field is not requiredThe 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.

 Mapping for the BMC Discovery formats

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.

Important

Starting from version 8.9.04, The device import task no longer supports the following mapping formats for the BMC Discovery versions that are End of Life: 

  • BMC Foundation Discovery 1.5
  • BMC Atrium Discovery and Dependency Mapping 7.5
  • BMC Atrium Discovery and Dependency Mapping 8.2+

After upgrade to version 8.9.04, any device import tasks referring to above formats are automatically upgraded to use the BMC Discovery 11.0+ (XML API) format. If you do not want the automatic upgrade, edit your device import tasks to use any other format other than the above mentioned formats before you start upgrading. If you have not edited these tasks, validate whether these tasks are working as expected after upgrade.

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:

Variable

Value to subsitute

Discovery_Server

Host name or IP address of the BMC Discovery server

DiscoveryUserName

User name that is registered on the BMC Discovery server

password

Password associated with the user name

Note

The TrueSight Network Automation application server automatically performs URL encoding on any blank spaces or other special characters.

The API call returns the following response:

[
    {
        "count": 2,
        "headings": [
            "name",
            "#InferredElement:Inference:Associate:DiscoveryAccess.endpoint",
            "sysobjectid"
        ],
        "kind": "NetworkDevice",
        "offset": 0,
        "results": [
            [
                "bcan-cisco1200-01.bmc.com",
                "172.19.216.22",
                "1.3.6.1.4.1.9.1.525"
            ],
            [
                "bcan-cisco7010-01",
                "172.19.216.68",
                "1.3.6.1.4.1.9.12.3.1.3.612"
            ]
        ]
    }
]

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.

Note

For BMC Discovery version 11.0+, ensure that your Discovery user is added to the api-access group in BMC Discovery. For more information, see XML API in the BMC Discovery documentation. 

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:

Variable

Value to subsitute

DISCOVERY_SERVER

Host name or IP address of the BMC Discovery server

DISCOVERY_USERNAME

User name that is registered on the BMC Discovery server

DISCOVERY_PASSWORD

Password associated with the user name

Note

The TrueSight Network Automation application server automatically performs URL encoding on any blank spaces or other special characters.

The query returns the following values:

Device field

BMC Discovery field

Comments

Name

name

Unique name of the device.

Hostname/IP Address

#InferredElement:Inference:Associate: DiscoveryAccess.endpoint

Endpoint host name or IP address of the device.

Device Type

Sysobjectid

Maps the SNMP OID to the device type.

Category

Sysobjectid

Maps the SNMP OID to the device category.

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:

Device field

BMC Atrium Discovery 7.5 field

Comments

Name

bmc_computersystem_r.aname

Must be a unique name. Up to 100 characters in length.

Hostname/IP Address

dim_ipaccesspoint.aname

Required for new devices. If snmpaddr is blank, uses ip_hostname field.

Device Type

dim_snmpdatasource_r.asysobjectid

Maps the OID to the device type by using the DeviceType.snmpOids file.

Category

dim_snmpdatasource_r.asysobjectid

Used to determine the category of the device.

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.

Device field

BMC Foundation Discovery Table.Field

Comments

Name

bmc_computersystem_r.aname

Must be a unique name. Up to 100 characters in length.

Hostname/IP Address

dim_ipaccesspoint.aname

Required for new devices. If snmpaddr is blank, uses ip_hostname field.

Device Type

dim_snmpdatasource_r.asysobjectid

Maps the OID to the device type by using the DeviceType.snmpOids file.

Category

dim_snmpdatasource_r.asysobjectid

Used to determine the category of the device.

Configuring BMC Atrium Discovery version 7.5 name-hostname and FQDN

The following procedure describes how to configure BMC Atrium Discovery version 7.5 for name-hostname and fully qualified domain name (FQDN). This procedure involves changing the naming convention used by BMC Atrium Discovery version 7.5. You should be aware of the following before changing the naming convention:

  • DNS name or IP address naming convention uses the DNS name or IP address for the name value of BMC_ComputerSystem. This convention facilitates Service Automation because the computer system name contains information that can be used to identify the network device.

    By setting the naming convention to DNS, BMC Atrium Discovery continues to retrieve the TokenId value to reconcile CIs in BMC Atrium CMDB. However, it uses the DNS or IP address to name network devices.
  • TokenId naming convention prevents the possibility of over-consolidation of network devices in complex environments.

Warning

In complex environments, BMC recommends that you use the TokenId naming convention.

Note

If you change the naming convention from TokenId to DNS, that change does not affect previously discovered systems because DNS is a lower priority convention. However, DNS is used for newly discovered systems.

Switching from DNS back to TokenId changes the name of previously discovered systems the next time those systems are discovered.

To configure BMC Atrium Discovery version 7.5 name-hostname and FQDN

  1. Install BMC Atrium Discovery version 7.5. For details, see the "BMC Atrium Discovery and Dependency Mapping: Planning and Installation, Version 7.5.00" document.
  2. Open the Services panel on the computer and stop the BMC Atrium Discovery service.
  3. Open Task Manager and ensure that no processes named td_* are running.
  4. Open Explorer on the BMC Atrium Discovery machine and navigate to ADDM_Home/etc/action_util/snmp/1.0/config.prop.
  5. Update the config.prop file as follows for correct discovery of network devices.
    # NAMEFORMAT_CONVENTION can be TOKEN or DNS
    # TOKEN means we use TokenId value as Name for BMC_ComputerSystem
    # DNS means we follow naming resolution rules to set Name with a DNS
    # Name or an IP address when DNS cannot be resolved
    NAMEFORMAT_CONVENTION=DNS
  6. Start the BMC Atrium Discovery service.
  7. Log on to the BMC Atrium Discovery client console and discover the network devices. See the detailed steps in the "BMC Atrium Discovery and Dependency Mapping: Discovering and Managing Configuration Data, Version 7.5.00" document.
Was this page helpful? Yes No Submitting... Thank you

Comments