VSM KM (vCenter) Device Synchronization
with BPPM or TSIM
Author: Karlis Peterson, Software Consultant, BMC Software
Version: 2.0
Date: May 6, 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/TSIM INTEGRATION
CONTENTS
Overview........................................................................................................................................................................ 3
Integration Requirements ............................................................................................................................................. 4
BPPM or TSIM Configurations ....................................................................................................................................... 4
Enable Publishing .................................................................................................................................................. 4
Validate Publishing Server is Running ................................................................................................................... 4
Creating the VSM KM Publishing Environment..................................................................................................... 5
Changing icons for Operations Console ................................................................................................................ 5
Download Pentaho Data Integration – Communities Edition ............................................................................... 5
download and Extract Pentaho PDI ...................................................................................................................... 5
Copy jconn4.jar to the Pentaho Lib Directory....................................................................................................... 7
Extract VSM KM Integration Files ......................................................................................................................... 7
Modify Pentaho Job References for BPPM Event and Configuration Items ......................................................... 8
Manually Test Pentaho Job ................................................................................................................................. 11
Simple Service Models ........................................................................................................................................ 12
Validation..................................................................................................................................................................... 12
Feedback and Enhancements ...................................................................................................................................... 17
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
2
BPPM/TSIM INTEGRATION
OVERVIEW
The purpose of this integration is to populate TrueSight Infrastructure Manager or BMC ProactiveNet Performance
Manager directly with VSM KM device and optionally relationship/dependency data. Service Models and topology
can be represented regardless whether the Atrium CMDB is integrated with BPPM. This integration is intended for
customers who do not have ADDM or Atrium CMDB.
The following diagram shows the data flow from VSM KM to BPPM or TSIM:
The base integration can be modified and extended to support specific customer requirements.
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
3
BPPM/TSIM 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
VSM KM +v4.0
BPPM/TSIM Embedded Sybase (*Oracle not supported at this time)
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_pncell_<bppm_hostname>
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
4
BPPM/TSIM INTEGRATION
CREATING THE VSM KM 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 VSM -p "OriginId=DirectPublish" -p "HomeCell=<cellName>"
Validate VSM KM env by typing: penv –e VSM info
CHANGING ICONS FOR OPERATIONS CONSOLE
1.
2.
3.
Make a backup of the existing files (see step #2 for file directory): component_icon.properties
Copy component_icon.properties from the integration to BOTH directories:
 pw\pronto\conf\
 pw\pronto\data\Image\Icon\
Re-start jserver by typing: pw p r jserver.
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.
Save the file to a temp directory on the targeted server (BPPM server)
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
5
BPPM/TSIM INTEGRATION
4.
5.
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):
6.
Now right-click on the shortcut file (on Desktop) and select Properties and select the Change Icon button.
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
6
BPPM/TSIM INTEGRATION
Browse to the Spoon.ico file located at, for example, C:\bmc_pentaho\pdi-ce-5.0.1-stable\data-integration:
7.
Select Ok. Select OK again.
COPY JCONN4.JAR TO THE PENTAHO LIB DIRECTORY
4.
5.
Copy jconn4.jar to <pentaho_home>\data-integration\lib
Close and re-open Spoon if you had Spoon opened already.
EXTRACT VSM KM INTEGRATION FILES
Extract the files to a local directory on the BPPM or TSIM server, such as C:\Data\.
1.
2.
3.
Create an integration directory named VSM KM (e.g. C:\Data)
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: (there might be a few added ETLs not listed here ..)
 VSM_Device_Synch_with_TrueSight.kjb
 VSM_TrueSight_Integration_PPOSTER_BAROC.ktr
 VSM_TrueSight_Integration_PPOSTER_BAROC_vCluster_Relationships.ktr
 VSM_TrueSight_Integration_PPOSTER_BAROC_VM_Relationships.ktr
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
7
BPPM/TSIM INTEGRATION





VSM_TrueSight_Integration_PPOSTER_BAROC_Resources_Relationships.ktr
VSM_TrueSight_Integration_Application_PPOSTER_BAROC.ktr
VSM_TrueSight_Integration_BusinessService_PPOSTER_BAROC.ktr
VSM_TrueSight_Integration_ddelete_SSM_BAROC_Relationships.ktr
VSM_TrueSight_Integration_PPOSTER_BAROC_SSM_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:
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
8
BPPM/TSIM INTEGRATION
3.
Select File  Open
4.
Navigiate to the following directory:
<Drive>:\Data
5.
6.
Select File  Open, then open the following files located in the directory created in Step1
 VSM_Device_Synch_with_TrueSight.kjb
Select the tab which has the job “VSM_Device_Synch_with_TrueSight.kjb” and double click on the white
space in the background which will bring up the Properties of the Job.
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
9
BPPM/TSIM INTEGRATION
7.
Select the Parameters Tab, and fill in the “Default value” for the following information:
bppm_cell_name – typically pncell_<hostname>
bppm_tsim_db_name - BPPM or TSIM Sybase Database name (storm_<hostname>)
bppm_tsim_hostname – No
custom_jdbc_connection – JDBC settings, just change the BPPM hostname and DB name
mquery – full path to the mquery executable (e.g. C:\Data\mquery)
output_dir – this is the directory that was created in Step 1 (e.g. C:\Data)
pposter – full path to the pposter executable (e.g. C:\Data\pposter)
simple_service_models - Create Simple Service Models from XLSX?
Note: if you are not using the default dba User Account and Password with the BPPM/TSIM Embedded Sybase
database, then you will need to edit each Transformation Table Input or Lookup Step.
8.
9.
Save the Job
The default behavior is to not create Simple Service Models. Suggestion is to run the ETL at least once
which will generate a file ${output_dir}\Use_Me_for_Simple_Service_Models.csv. This file will be used to
populate the multi-tabbed spreadsheet named “Simple_Models_TSOM.xlsx”.
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
10
BPPM/TSIM INTEGRATION
10. For creating Service or Application Models, please refer back to the Communities Posting FAQs section.
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  SM_Device_Synch_with_TrueSight.kjb (sample location C:\Data\)
Click on the Play radio button
3.
Change logging to Detailed logging and then Launch the Job:
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
11
BPPM/TSIM INTEGRATION
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:
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. You will need to temporarily copy the needed Parameters to each
Transformation you are running by itself. Parameters are made available to the JVM during execution.
SIMPLE SERVICE MODELS
Please review the Communities Post for details (FAQs section) on how to configure the spreadsheet. The posting is
listed here: https://communities.bmc.com/docs/DOC-36263
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:
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
12
BPPM/TSIM INTEGRATION
Also since the ComponentAliases are the same before Publishing, the existing events should show on the new
consolidated CIs:
Lastly, to validate VSM KM Topology data, locate an ESXi host and view the relationships in the BPPM Ops Console:
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
13
BPPM/TSIM INTEGRATION
With Simple Service Models (or Application Models): Note for configuration of the Simple Service Model
spreadsheet, please refer back to the Communities Posting FAQs section:
https://communities.bmc.com/docs/DOC-36263
Lastly if you have Entuity for network monitoring, and have configured the following “device” synch integration:
https://communities.bmc.com/docs/DOC-35933 and configured the ETL which is included with this integration,
you can get the EdgeSwitch to physical Host connectivity: (as seen below)
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
14
BPPM/TSIM INTEGRATION
Validation from vSphere client:
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
15
BPPM/TSIM INTEGRATION
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
16
BPPM/TSIM INTEGRATION
FEEDBACK AND ENHANCEMENTS
Please provide feedback or enhancements to [email protected]
VSM KM DEVICE SYNCHRONIZATION WITH BPPM / TSIM
17