Solarwinds NPM Device Synchronization
with BPPM or TSOM
Author: Karlis Peterson, Software Consultant, BMC Software
Version: 1.0
Date: March 30, 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
BPPM or TSIM Configurations .................................................................................................................. 4
Enable Publishing............................................................................................................................. 4
Validate Publishing Server is Running............................................................................................... 4
Creating the Solarwinds Publishing Environment ............................................................................. 5
Download Pentaho Data Integration – Communities Edition ............................................................ 5
download and Extract Pentaho PDI .................................................................................................. 5
Create an ODBC System DSN Connection to Solarwinds NPM Database ........................................... 7
Extract Solarwinds NPM Integration Files ......................................................................................... 8
Modify Pentaho Job References for BPPM Event and Configuration Items ....................................... 9
Manually Test Pentaho Job ............................................................................................................ 14
Validation.............................................................................................................................................. 16
Feedback and Enhancements ................................................................................................................ 18
SOLARWINDS NPM 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 Solarwinds NPM 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 Solarwinds NPM to BPPM or TSIM:
The base integration can be modified and extended to support specific customer requirements.
SOLARWINDS NPM 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
Solarwinds NPM +v10
SQL User (Read Only) to query Nodes and OrionSwitchPortMapping tables
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>
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
4
BPPM/TSOM INTEGRATION
CREATING THE SOLARWINDS PUBLISHING ENVIRONMENT
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 SOLARWINDS -p "OriginId=DirectPublish" -p "HomeCell=<cellName>"
Validate SOLARWINDS env by typing: penv –e SOLARWINDS info
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):
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
5
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:
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
6
BPPM/TSOM INTEGRATION
7.
Select Ok. Select OK again.
CREATE AN ODBC SYSTEM DSN CONNECTION TO SOLARW INDS NPM DATABAS E
You will need to have the Solarwinds Admin or MS SQL Admin create a SQL User who will have access to query the
Views and Tables of Solarwinds NPM Database.
1.
2.
3.
4.
5.
On BPPM or TSIM server, open the ODBC Data Source Administrator console
Click on the System DSN Tabl
Add a NEW data source with MS SQL Server driver
Name the Data Source “Solarwinds”
Select the server from the drop down
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
7
BPPM/TSOM INTEGRATION
6.
Type in the Username and Password
7.
and TEST the connection
EXTRACT SOLARWINDS NPM INTEG RATION FILES
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
8
BPPM/TSOM INTEGRATION
Extract the files to a local directory on the BPPM or TSIM server, such as C:\Solarwinds\.
8.
9.
Create an integration directory named Solarwinds (e.g. C:\Solarwinds)
Copy the following files to the directory created in step 1:
 %MCELL_HOME%\bin\pposter
 %MCELL_HOME%\bin\mquery
10. Extract the ETL files for the integration to the directory created in Step1. You should have the following
files:
 Solarwinds_NPM_Device_Synch_with_TSOM.kjb
 Solarwinds_TrueSight_Integration_PPOSTER_BAROC.ktr
 Solarwinds_TrueSight_Integration_PPOSTER_BAROC_Relationships.ktr
 Solarwinds_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:
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
9
BPPM/TSOM INTEGRATION
3.
Select File  Open
4.
Navigiate to the following directory:
<Drive>:\solarwinds
5.
Select File  Open, then open the following files located in the directory created in Step1
 Solarwinds_NPM_Device_Synch_with_TSOM.kjb
 Solarwinds_TrueSight_Integration_PPOSTER_BAROC.ktr
 Solarwinds_TrueSight_Integration_PPOSTER_BAROC_Relationships.ktr
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
10
BPPM/TSOM INTEGRATION
6.
Select the tab which has the job “Solarwinds_NPM_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:\Solarwinds\mquery)
output_dir – this is the directory that was created in Step 1 (e.g. C:\Solarwinds)
pposter – full path to the pposter executable (e.g. C:\Solarwinds\pposter)
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):
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
11
BPPM/TSOM INTEGRATION
10. Click on the tab with the ktr named “Solarwinds_TrueSight_Integration_PPOSTER_BAROC.ktr” and edit
the first step:
11. Edit the connection information with the ODBC System DSN information created in the previous section.
Test the connection.
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
12
BPPM/TSOM INTEGRATION
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
13
BPPM/TSOM INTEGRATION
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 “Solarwinds_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.
2.
Within Spoon, File  Open  Solarwinds_NPM_Device_Synch_with_TSOM.kjb (sample location
C:\Solarwinds\)
Click on the Play radio button
3.
Change logging to Detailed logging and then Launch the Job:
1.
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
14
BPPM/TSOM 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:
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
15
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:
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:
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
16
BPPM/TSOM INTEGRATION
Lastly, if you synchronized Solarwinds Topology data, then locate a switch and view the relationships in the BPPM
Ops Console:
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
17
BPPM/TSOM INTEGRATION
FEEDBACK AND ENHANCEMENTS
Please provide feedback or enhancements to [email protected]
SOLARWINDS NPM DEVICE SYNCHRONIZATION WITH BPPM / TSOM
18