Entuity Device Synchronization with BPPM
or TSOM
Author: Karlis Peterson, Software Consultant, BMC Software
Version: 1.0
Date: April 4, 2015
DISCLAIMER NOTICE
The free integration provided may be freely distributed, provided that no charge above the cost of
distribution is levied, and that the disclaimer below is always attached to it.
The integration is provided as is without any guarantees or warranty.
Although the author has attempted to find and correct any bugs in the integration, the author nor
BMC Software is not responsible for any damage or losses of any kind caused by the use or misuse
of the integration contents.
BPPM/TSOM INTEGRATION
CONTENTS
Overview........................................................................................................................................................................ 3
Integration Requirements ............................................................................................................................................. 4
Entuity Server Configuration ......................................................................................................................................... 4
sw_data_export_def_atrium.def File ................................................................................................................... 4
Setting uP AtriumExport DB and remote MySQL User ......................................................................................... 5
Validation of initial Configuration ......................................................................................................................... 5
Scheduling the Data Export................................................................................................................................... 6
BPPM or TSIM Configurations ....................................................................................................................................... 7
Enable Publishing .................................................................................................................................................. 7
Validate Publishing Server is Running ................................................................................................................... 7
Creating the Entuity Publishing Environment ....................................................................................................... 7
Download Pentaho Data Integration – Communities Edition ............................................................................... 8
download and Extract Pentaho PDI ...................................................................................................................... 8
Download and Install JDBC Driver for MySQL ..................................................................................................... 10
Extract Entuity Integration Files .......................................................................................................................... 10
Modify Pentaho Job References for BPPM Event and Configuration Items ....................................................... 11
Manually Test Pentaho Job ................................................................................................................................. 15
Validation..................................................................................................................................................................... 17
Feedback and Enhancements ...................................................................................................................................... 19
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
2
BPPM/TSOM INTEGRATION
OVERVIEW
The purpose of this integration is to populate TrueSight Operations Manager or BMC ProactiveNet Performance
Manager directly with Entuity device and optionally relationship/dependency data. Service Models and topology
can be represented regardless whether the Atrium CMDB is integrated with BPPM.
The following diagram shows the data flow from Entuity to BPPM or TSIM:
The base integration can be modified and extended to support specific customer requirements.
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
3
BPPM/TSOM INTEGRATION
INTEGRATION REQUIREMENTS
The following are required:





Pentaho PDI - Kettle (Open Source ETL)
Java SE (JRE) – no specific version required
BPPM +9.0, +9.5
Entuity +v10
MySQL User to query the Entuity data warehouse tables
ENTUITY SERVER CONFIGURATION
This section describes the configurations needed to be made on the ENMA server.
SW_DATA_EXPORT_DEF_ATRIUM.DEF FILE
This section will have you SFTP or SCP an updated DEF file. Even though the steps have you enable or configure the
Atrium Export, there is no dependency on the Atrium CMDB. Again, follow the video or steps below:
1.
2.
3.
4.
5.
Copy (SCP/FTP) the sw_data_export_def_atrium.def file extracted from the integration archive file at
\ENMA_files and copy file to <ENTUITY_HOME>/etc directory.
Run the configuration ensuring the Atrium integration module is enabled.
Cd <ENTUITY_HOME>/install and type ./configure
Hit <return> for all values until you see the following question:
Type yes for “Would you like to modify the Module Selection [no]> “
Use the default values for all options. Do not enter any values for the Atrium CMDB, since this is not
needed for the integration. See below:
Would you like to modify the Module Selection [no]> y
Please choose the modules to install
…
Integration for BMC Atrium CMDB [no]> y
..
Integration for BMC Atrium CMDB
Data Export Connection:
Eye Server [127.0.0.1]>
192.168.100.94
Database User: [root]>
Database Password: []>
Database Name: [AtriumExport]>
Atrium Connection:
Atrium Server: [127.0.0.1]>
Atrium Port: [0]>
Atrium User: [Demo]>
Atrium Password: []>
Atrium Dataset ID: [ENTUITY.IMPORT.TOPO]>
…
Do you want to continue? [no]> y
6.
Wait for update to complete (“Updating system configuration files”)
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
4
BPPM/TSOM INTEGRATION
SETTING UP ATRIUMEXPORT DB AND REMOTE MY SQL USER
1. cd <ENTUITY_HOME>/database/bin
2. ./mysql -u root -h 127.0.0.1 -P 3306
3. show databases; <hit return> (validate that the AtriumExport db is not present)
4. create database AtriumExport;
5. show databases;
6. create user ‘atrium’@'%';
7. CREATE USER 'tsom-export'@'%';
8.
9. set password for ‘atrium’@'%'=password('atrium');
10. SET PASSWORD FOR 'tsom-export'@'%' = PASSWORD('tsom-export');
11.
Note: replace password(‘atrium’) with your own password
GRANT ALL ON AtriumExport.* TO 'myuser'@'%';
12. exit
VALIDATION OF INITIAL CONFIGURATION
1.
2.
3.
Login to the ENMA Web console
Select Administration  Data Exports  Datasets
If the configuration completed successfully, you should see the following:
4.
If you are not seeing the datasets, then the Configuration File has not been incorporated.
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
5
BPPM/TSOM INTEGRATION
SCHEDULING THE DATA EXPORT
1. Login to the ENMA Web console
2. Select Administration  Data Exports  Jobs
3. You should see the following Jobs, which should be scheduled to run ‘Hourly’ by default :
4.
5.
Run the ~Atrium CDP Export Job.
Select History to see if the Job completed successfully.
6.
If job ran successfully then configuration is complete. Run the all the ~Atrium* jobs.
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
6
BPPM/TSOM INTEGRATION
BPPM OR TSIM CONFIGURATIONS
This section describes the steps for configurations required on the server which will run BPPM or TSIM Server.
ENABLE PUBLISHING
By default, Direct Publish publishing is enabled. Direct Publish is controlled in the pserver.conf file, located
ininstallationDirectory/pw/server/etc, by the parameter DirectPublishOrigin = T. (Default = T)
For Direct Publish environments, the Publishing Server looks up the cell information from a cell directory file. You
can set this file in pserver.conf with the parameter IMFileDirectoryName. It defaults to mcell.dir, so cells and BMC
ProactiveNet Publishing Server share the file.
VALIDATE PUBLISHING SERVER IS RUNNING
1.
2.
Type the following command: psstat
If the Publishing Server is not running, then type: pserver –b ps_<bppm_hostname>
CREATING THE ENTUITY PUBLISHING ENVIRONME NT
When all the BMC ProactiveNet data for the environment goes to one single cell, you can define the cell with the
parameter HomeCell. Create a Direct Publish environment and define HomeCell by running the following
command:
1.
2.
type: penv open -e ENTUITY -p "OriginId=DirectPublish" -p "HomeCell=<cellName>"
Validate ENTUITY env by typing: penv –e ENTUITY info
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
7
BPPM/TSOM INTEGRATION
DOWNLOAD PENTAHO DATA INTEGRATION – COMMUNITIES EDITION
This section describes the steps for configurations required on the server running Pentaho PDI. PDI will need to be
run local to the BPPM or TSIM server. If you have BPPM running on Linux, follow the following steps for Windows
and make the adjustments (file paths). One requirement for PDI (Kettle) to run is a Java SE Runtime (version 7 or
8). If you do not have JRE installed on the BPPM or TSIM, please download and install.
DOWNLOAD AND EXTRACT PENTAHO PDI
1.
Click on the following link and select the latest version of PDI (Pentaho Data Integration):
http://sourceforge.net/projects/pentaho/files/Data%20Integration/
**At the time of this documentation, PDI version 5.3 is the latest release:
2.
Click into the latest stable build and select the zip file (for Windows) as seen below:
3.
4.
5.
Save the file to a temp directory on the targeted server (BPPM server)
Now extract the zip to a file, for example, C:\ pdi-ce-5.3.xx\:
Once extracted, then navigate to the following file: C:\pdi-ce-5.3xx\data-integration and right click on the
file “Spoon.bat” and select Send to Desktop (create shortcut):
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
8
BPPM/TSOM INTEGRATION
6.
Now right-click on the shortcut file (on Desktop) and select Properties and select the Change Icon button.
Browse to the Spoon.ico file located at, for example, C:\bmc_pentaho\pdi-ce-5.0.1-stable\data-integration:
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
9
BPPM/TSOM INTEGRATION
7.
Select Ok. Select OK again.
DOWNLOAD AND INSTALL JDBC DRIVER FOR MYSQ L
The integration requires the MySQL JDBC driver to be installed. This will work with MariaDB (if you
1.
Please login and download the following
http://dev.mysql.com/downloads/connector/
2.
Execute the installer (latest version is fine)
3.
The msi installation places the file at C:\Program Files (x86)\MySQL\MySQL Connector J \ mysqlconnector-java-5.1.31-bin.jar
Copy the jar mysql-connector-java-5.1.31-bin.jar to <pentaho_home>\data-integration\lib
Close and re-open Spoon if you had Spoon opened already.
4.
5.
EXTRACT ENTUITY INTEGRATION FILES
Extract the files to a local directory on the BPPM or TSIM server, such as C:\Entuity\.
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
10
BPPM/TSOM INTEGRATION
6.
7.
8.
Create an integration directory named Entuity (e.g. C:\Entuity)
Copy the following files to the directory created in step 1:
 %MCELL_HOME%\bin\pposter
 %MCELL_HOME%\bin\mquery
Extract the ETL files for the integration to the directory created in Step1. You should have the following
files:
 Entuity_Device_Synch_with_TSOM.kjb
 Entuity_TrueSight_Integration_PPOSTER_BAROC.ktr
 Entuity_TrueSight_Integration_PPOSTER_BAROC_Relationships.ktr
 Entuity_TrueSight_Integration_ddelete_BAROC_Relationships.ktr
MODIFY PENTAHO JOB REFERENCES FOR BPPM EVENT AND C ONFIGURATION ITEMS
This section covers opening Spoon client and modifying some parameters or variables that are referenced
throughout the ETL:
1.
2.
Now launch Spoon from the Desktop shortcut.
Once Spoon launches, click on the Cancel button:
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
11
BPPM/TSOM INTEGRATION
3.
Select File  Open
4.
Navigiate to the following directory:
<Drive>:\Entuity
5.
Select File  Open, then open the following files located in the directory created in Step1
 Entuity_Device_Synch_with_TSOM.kjb
 Entuity_TrueSight_Integration_PPOSTER_BAROC.ktr
 Entuity_TrueSight_Integration_PPOSTER_BAROC_Relationships.ktr
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
12
BPPM/TSOM INTEGRATION
6.
Select the tab which has the job “Entuity_Device_Synch_with_TSOM.kjb” and double click on the white
space in the background which will bring up the Properties of the Job.
7.
Select the Parameters Tab, and fill in the “Default value” for the following information:
bppm_cell_name – typically pncell_<hostname>
mquery – full path to the mquery executable (e.g. C:\Entuity\mquery)
output_dir – this is the directory that was created in Step 1 (e.g. C:\Entuity)
pposter – full path to the pposter executable (e.g. C:\Entuity\pposter)
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
13
BPPM/TSOM INTEGRATION
8.
9.
Save the Job
The default behavior is to synch both devices and relationships. If you want that, then proceed to Step
#10. If you want to limit the integration to only publishing devices with NO RELATIONSHIPS, then from the
open job select the Hop to enable and the following to disable (See below for details):
10. Click on the tab with the ktr named “Entuity_TrueSight_Integration_PPOSTER_BAROC.ktr” and edit the
first step:
11. Edit the connection information with the MySQL JDBC information created in the previous section. Test
the connection.
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
14
BPPM/TSOM INTEGRATION
Now put in the connection information and test:
12. Once the Test is successful then click ok. Now select Preview to see if you can run the query.
13. Repeat steps #6-11 for “Entuity_TrueSight_Integration_PPOSTER_BAROC_Relationships.ktr”
MANUALLY TEST PENTAHO JOB
In this section, you can use Spoon to manually test the Pentaho Transformations and Jobs.
1.
2.
Within Spoon, File  Open  Entuity_Device_Synch_with_TSOM.kjb (sample location C:\Entuity\)
Click on the Play radio button
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
15
BPPM/TSOM INTEGRATION
3.
Change logging to Detailed logging and then Launch the Job:
4.
5.
Check the logging tab for errors.
If the Pentaho completes successfully, then you should see the following Green check marks on the job:
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
16
BPPM/TSOM INTEGRATION
Hint: If you need to troubleshoot, I would suggest that you open each transformation and execute one at
a time and narrow down the issues.
VALIDATION
After running the ETL successfully, you can validate by first opening the BPPM Administration Console (java
console) and checking the Component Data Tables as seen below:
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
17
BPPM/TSOM INTEGRATION
Also if you send an event to a device (the ComponentAliases for the devices is set to
BMC_ComputerSystem:<hostname>) you should see something similar as below:
Lastly, if you synchronized Entuity Topology data, then locate a switch and view the relationships in the BPPM Ops
Console:
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
18
BPPM/TSOM INTEGRATION
FEEDBACK AND ENHANCEMENTS
Please provide feedback or enhancements to [email protected]
ENTUITY DEVICE SYNCHRONIZATION WITH BPPM / TSOM
19