Data export definition
The Entuity integration for BMC Atrium CMDB includes a sample data export definition. This includes the following:
- device dataset, defining the device informatioin exported from ENA.
- port dataset, defining the port information exported from ENA.
- data export job.
These definitions are supplied through the StormWorks configuration file sw_data_export_def_atrium.cfg, which is included to Entuity during configuration.
The Entuity configuration provides all mapping that is necessary to export the Entuity data into Atrium. Data is exported into an import dataset in the Atrium CMDB, and reconciliation rules are used to recognise the same information from other discovery tools placed in the CMDB.
During export:
- Entuity creates a CI for each exported data export record in the export database, as specified in the configuration file.
- all exported StormWorks attributes for a given export record are copied onto the created CI's fields.
- the file name in CI does not necessarily match the attribute name in StormWorks.
Therefore, the configuration file has the ability to define the mapping between the fields in CI and attribtues in StormWorks. The following tables shows the mapping information that is defined between StormWorks types and the Atrium CI definition:
Exported device details:
Entuity attribute | CI field name | Visibility | CI | Relationship |
---|---|---|---|---|
name | Name | YES | BMC_ComputerSystem | none |
sysDescriptor | Description | YES | " | " |
devManufacturer | ManufacturerName | YES | " | " |
devModel | Model | YES | " | " |
devVersion | VersionNumber | YES | " | " |
devSerialNumber | SerialNumber | YES | " | " |
devPolledIpAddress | Name | YES | " | " |
StormWorksID | EntuityIdentity | NO | " | " |
eyeServerName | EntuityFederatedLinkPrefix | NO | " | " |
sysLocation | Name | YES | BMC_PhysicalLocation | BMC_Element Location |
devPolledIpAddress | PolledIPAddress | NO | BMC_IPEndPoint | BMC_HostedAccessPoint |
Exported port details:
Entuity attribute | CI field name | Visibility | CI | Relationship |
---|---|---|---|---|
portIndex | Name | YES | BMC_NetworkPort | BMC_HostedSystemComponents |
IfType | PortType | YES | " | " |
portRefSpeed | Speed | YES | " | " |
portDescr | Description | YES | " | " |
portAlias | PortAlias | YES | " | " |
portShortDescr | ShortDescription | YES | " | " |
StormWorksID | EntuityIdentity | NO | " | " |
eyeServerName | EntuityFederatedLinkPrefix | NO | " | " |
Data export samples
The sample configuration sw_data_export_def_atrium.cfg exports two datasets: device information and port information.
In these datasets, the section "TargetTable" references the names of the CI that need to be created in CMDB. The fields in CI are mapped in the section "SubItems" as follows:
FIELD_NAME#STORMWORKS_VALUE#DATA_TYPE
where:
- FIELD_NAME, the field name defined in CI.
- STORMWORKS_VALUE, value returned from a statement language expression or the
StormWorks attribute name. - DATA_TYPE, a supported data type, e.g. string, int, boolean.
Device dataset example:
[Dataset ~Atrium Devices]
Description=Atrium Device Attributes
DatasetType=ObjectAttributes
TargetTable=swo_DeviceEx
Component=DeviceEx
SubItems=sysLocation devManufacturer devModel name devPolledIpAddr
devSerialNumber sysDescr devVersion
ReportableOverride=0
Port dataset example:
[Dataset ~Atrium Ports]
Description=Atrium Port Attributes
DatasetType=ObjectAttributes
TargetTable=swo_portEx
Component=portEx
SubItems=portAlias entIndex#portIndex.entIndex#string(16) ifDescr
ifIndex#portIndex.ifIndex#uint32 portOutSpeed portShortDescr ifType
DeviceEx(ref.device).id
ReportableOverride=0
Data export job example:
A data export job specifies:
- datasets to export.
- View against which the dataset definitions are applied.
- data export job schedule.
- target database, including connection parameters and the executable that connects to the Atrium API.
[DataExportJob ~Atrium Export Job]
Description=Atrium Export Job
DbName=AtriumExport
DbUser=
DbPassword=
DbServer=
ViewName=All Views
Backfill=172800
Ageout=1209600
Schedule=Atrium_Daily
Datasets=~Atrium Devices,~Atrium Ports
IsEnabled=1
where:
- ~Atrium Export Job, identifies the data export job. The tilde indicates the definition cannot be amended in the web interface.
- Description, a meaningful Data Export Job description which is displayed in the web interface.
- ViewName, Entuity View against which the export is run. By entering All Views, you can select all available views.
- Schedule, data export schedule. You can run data export jobs on demand or scheduled. Data Export Job schedules are the same as those used for Flex Reports. When an existing schedule does not meet your requirements,use the Flex Report Create Schedule mechanism to create an appropriate one.
Entuity only runs one Data Export Job at a time. This avoids resource overload and database conflict. The Data Export queue is separate from the other queues, e.g. Flex Reports and a Data Export job can run at the same time. - Datasets, is a comma delimited list of datasets, by default ~Basic Device Data, ~Basic Port Data. The tilde indicates the definition cannot be amended in the web interface.
- IsEnabled, when set to 1 indicates the job is available to run, when set to 0 it is not.
Atrium.cfg:
Atrium.cfg specifies two connections:
- from Entuity to the Data Export database.
- between the Data Export database and the BMC Atrium CMDB.
Run configure to set up the integration and configure Atrium.cfg, but you should not directly edit the file. An Entuity installation can have three versions of Atrium.cfg:
- entuity_home\install\template\etc is used the first time configure runs with the module enabled.
- entuity_home\etc is generated by configure. This version is used by the Entuity server.
- entuity_home\etc\bkp is a backup of the current version of entuity_home\etc\entuity.cfg created during configure.
Messages and log files are written to the atriumExporter.log.
Atrium.cfg has three sections:
- EYE_Connection eyeConnection, specifies the connection to the Entuity server.
- Atrium_DataExport_Connection atriumDataExportConnection, specifies the
connection to the AtriumExport database. - Atrium_Connection atriumConnection, specifies the connection to the BMC Atrium CMDB import database.
1. EYE_Connection eyeConnection
[EYE_Connection eyeConnection]
eye.server=compressor
where:
- server should be a fully qualified DNS name or an IP address. The utility will try to resolve the IP address if localhost or loopback address is specified.
2. Atrium_DataExport_Connection atriumDataExportConnection
[Atrium_DataExport_Connection atriumDataExportConnection]
dataexport.dbServer=127.0.0.1
dataexport.dbUser=root
dataexport.dbPassword=
dataexport.dbName=AtriumExport
where:
- dbServer, is the name of the server which holds the Data Export database. You can also enter the database port using the format, server:port e.g. compressor:3306.
- dbUser, name of the user account used to manage the Data Export target database.
- dbPassword, password of the user account used to manage the Data Export target database.
- dbName, the name of the Data Export database, e.g. AtriumExport, to which Entuity data is written before it is transferred to BMC Atrium CMDB.
3. Atrium_Connection atriumConnection
[Atrium_Connection atriumConnection]
atrium.server=10.44.1.48
atrium.port=0
atrium.user=Demo
atrium.password=
atrium.trustedDataset=true
atrium.datasetId=ENTUITY.IMPORT.TOPO
where:
- server, name of the Atrium server.
- port, when set to 0 the default port is used.
- user, name of the Atrium user account.
- password, password of the Atrium user account.
- trustedDataset, when set to:
- true, BMC Atrium CMDB considers the dataset as trusted
- false, BMC Atrium CMDB does not consider the dataset as trusted
- datasetId, the name of the import dataset to which the Entuity data is written before
reconciliation rules are applied.
Comments
0 comments
Please sign in to leave a comment.