This integration will help those using both Device42 and BMC Atrium to synchronize their datasets with up to date configuration data collected by Device42's continuous automated discovery tools. This integration is written in Python3 and should be ran on a machine with access to both the API endpoints of Device42 and BMC Atrium.
Configuration is handled in the mapping.xml file.
The Settings element should be filled with the URL and user credentials for both your BMC Atrium and Device42 deployments.
Individual task items are listed within the Tasks element.
Each task represents a query to Device42 and a CI class to create instances of for the records returned from Device42.
The task element contains two children: api and mapping.
The api element contains a target and resource.
-
The resource element describes how to query Device42 for records
-
The target element configures where to POST or PATCH bulk requests to BMC.
The mapping element first sets some boilerplate attributes.
-
The callback attribute should always be set to "from_d42" as this integration only supports importing data from Device42 to BMC Atrium.
-
The source attribute of the mapping element tells the integration script what key to access in the return data from Device42. For example, on the
/api/1.0/devices/all/endpoint, all the devices will be listed under a key named "Devices". -
The mapping element's class, dataset, and namespace attributes designate the kind of BMC instance that will be created by the integration. As seen in the second task in the
mapping.xmlfile included within this repository, we are using devices returned from Device42 to create instances of the classBMC\_ComputerSystemunder theBMC.COREnamespace in theBMC.ASSETdataset on Atrium's CMDB.
Finally, the mapping element contains a list of field child elements. These fields are used to associate fields in the dataset returned from the D42 API or DOQL response to attributes of the given BMC class being created.
In the included example, the second task element uses each device's device_id, along with a basic prefix and suffix rule, to create the instance_id for the BMC\_ComputerSystem instance being created or updated. As you likely inferred, prefixes and suffixes can be added using the prefix (appearing before the data from d42) and suffix (appearing after the data from d42) attributes.
If you want to set an attribute on a BMC CI instance to a hardcoded value instead of something stored on Device42, you can use the value attribute of the field element to do this, which is demonstrated in the third task element included in the mapping.xml file.
To sum everything up, the mapping file is used to configure how this integration script will communicate with both Device42 and BMC Atrium. Additionally, it maps fields from Device42 objects onto BMC Class attributes. Each task represents a mapping between a query with a set of records from Device42 which become individual instances on BMC Atrium.
If you have any questions, you can contact us at support@device42.com for general inquiries or on this repositories' issues page.