HP BSM Connector for Zenoss Integration Guide.…Prerequisites BeforeinstallingtheBSMConnectorforZenoss,thefollowingcomponentsmustbeinstalledand configured.ForinformationaboutinstallingandconfiguringOMi,BSMConnector

HP BSM Connector for ZenossSoftware Version: 02.00

Integration Guide

Document Release Date: March 2015Software Release Date: March 2015

Legal Notices

WarrantyThe only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should beconstrued as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.

The information contained herein is subject to change without notice.

Restricted Rights LegendConfidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software,Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

Copyright Notice© Copyright 2015 Hewlett-Packard Development Company, L.P.

Trademark NoticesAdobe® is a trademark of Adobe Systems Incorporated.

Microsoft® andWindows® are U.S. registered trademarks of Microsoft Corporation.

UNIX® is a registered trademark of TheOpenGroup.

Documentation UpdatesThe title page of this document contains the following identifying information:

l Software Version number, which indicates the software version.l Document Release Date, which changes each time the document, is updated.l Software Release Date, which indicates the release date of this version of the software.

To check for recent updates or to verify that you are using themost recent edition of a document, go to: www.hp.com/go/livenetwork. This site requires that you register for anHP Passport and sign in. To register for an HP Passport ID, go to: http://h20229.www2.hp.com/passport-registration.html

Or click theNew users - please register link on the HP Passport login page.

SupportVisit the HP Software Support Online web site at: http://www.hp.com/go/hpsoftwaresupport

This web site provides contact information and details about the products, services, and support that HP Software offers.

HP Software online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed tomanage yourbusiness. As a valued support customer, you can benefit by using the support web site to:

l Search for knowledge documents of interestl Submit and track support cases and enhancement requestsl Download software patchesl Manage support contractsl Look up HP support contactsl Review information about available servicesl Enter into discussions with other software customersl Research and register for software training

Most of the support areas require that you register as an HP Passport user and sign in. Many also require a support contract. To register for an HP Passport ID, go to:

http://h20229.www2.hp.com/passport-registration.html

To findmore information about access levels, go to:

http://h20230.www2.hp.com/new_access_levels.jsp

HP Software Solutions Now accesses the HPSW Solution and Integration Portal Web site. This site enables you to explore HP Product Solutions tomeet your businessneeds, includes a full list of Integrations between HP Products, as well as a listing of ITIL Processes. The URL for this Web site ishttp://h20230.www2.hp.com/sc/solutions/index.jsp

Integration Guide

HP BSMConnector for Zenoss (02.00) Page 2 of 33

http://www.hp.com/go/livenetwork

http://h20229.www2.hp.com/passport-registration.html

Contents

Chapter 1: Introduction 5

Concepts 5

Event Collection 6

Metric Collection 7

Topology Collection 7

Event Back Synchronization 9

Chapter 2: Installation 10

Prerequisites 11

Installing the Connector for Zenoss 11Installing the Sync Package on theOMi server 12Importing the Content Package to OMi 12

Next Steps 13

Chapter 3: Configuration 14

Configuring the Integration 14Event Collection Options 15Metric Collection Options 17Topology Collection Options 20

Configuring Login Credentials 21

Managing the Integration Services 21Restarting the services 22

Synchronizing Changes Back to the Zenoss Server 22

Configure Device Filtering 23

Importing and Activating the Zenoss Policies 24

Chapter 4: Uninstallation 25

Chapter 5: Troubleshooting 27

General Troubleshooting Guidelines 27

Product Log Files 27Log Files Location 27


Logging Severity Levels 28OMBackSync.log Log File 29

Creating a Copy of Data 29

Known Issues andWorkarounds 31

Before Contacting HP Software Support 31

Send Documentation Feedback 33

Integration Guide


Chapter 1: IntroductionHP BSM Connector for Zenoss enables you to establish a link between the Zenoss network monitoringsolution and HP Operations Manager i.

The Connector for Zenoss is an add-on for the HP BSM Connector, providing the following Zenoss-specific functionality:

l Event synchronization between Zenoss andOMi

l Metric synchronization between Zenoss andOMi

l Topology synchronization between Zenoss andOMi

This functionality enables you to consolidatemanagement data from Zenoss environments into anHP Operations Manager i solution.

Note: HP BSMConnector for Zenoss is a GenInt-based integration. If you installed other GenIntbased connectors, see "Installation" on page 10 for additional details.

ConceptsThe BSMConnector for Zenoss is installed on the BSMConnector system and uses aWeb Serviceinterface to collect the events, metrics, and topology from the Zenoss system. No additionalcomponents need to be installed on the Zenoss system. However, you still can install BSM Connectorand Zenoss on the same system.


Event CollectionZenoss events are collected and processed by the event collector script. The event collector receivesevents from the Zenoss server through its Web Service interface using the HTTP or HTTPS protocol.

Events are collected from the Zenoss system periodically, using a preset event polling interval. Bydefault, the polling interval is set to 60 seconds. In case a poll is not executed as planned, the next pollcollects all events that were newly created or changed since the last successful poll.When thecollector is started for the first time, existing Zenoss events are collected and forwarded (by default,events from the last 10 days are forwarded).

The events collected from Zenoss are only summaries containing a limited set of attributes. Each eventis enriched to provide a value for all available attributes andmade universally accessible.

Event data is mapped to the OMi conform form using aweb service policy. The policy also sets thedrilldownURL for each event.

Integration GuideChapter 1: Introduction


Zenoss events aremapped to OMi events as follows:

Zenoss event severity OMi event severity

5 Critical

4 Major

3 Warning

2 Normal

1 Normal

0 Normal

Metric CollectionThemetric collector runs regularly (by default every 5minutes) and collects all current metrics throughtheWeb Service interface using the HTTP or HTTPS protocol. Themetrics are stored on the BSMConnector system for further processing by OMi.

Metric data is mapped to the OMi conform form using aweb service policy.

Topology CollectionTopology data is collected by the topology collector script that is run regularly (by default, every hour).The topology collector receives data from the Zenoss server through its Web Service interface usingthe HTTP or HTTPS protocol and forwards it to the HP BSMConnector for further processing.Topology objects are thenmapped to the RTSM using the topology synchronization componentprovided by the integration.

The topology collector always collects all objects, not just the new ormodified ones. It first acquires alist of all Zenoss Devices (nodes) andGroups (ci_collection) and then processes each device in orderto map it to the corresponding group.

Topology objects aremapped to the RTSM using anXML file policy. Themapping rules map thefollowing CI Types:

l nt

l unix

l ip address

l node

l ci_collection



See the following figure for an example.

For details about importing and activating the policies, see "Importing and Activating the ZenossPolicies" on page 24.

In addition, the topology self-discovery policy retrieves topology data about the Zenoss integrationenvironment itself. See the following figure for an example.



Event Back SynchronizationIf a Zenoss event is closed in OMi, the Zenoss server needs to be informed and should also close thecorresponding Zenoss event. This is known as BackSync and uses Perl scripts (OMBackSync.pl andOMBackSync_Zenoss.pl) and a Lua script to send an HTTP or HTTPS request to the Zenoss server toclose the event. If this succeeds, the event is closed in Zenoss.

For details about configuring back synchronization to the Zenoss server, see "Synchronizing ChangesBack to the Zenoss Server " on page 22.



Chapter 2: InstallationThe BSMConnector for Zenoss is installed on the BSMConnector host system. Installation and initialconfiguration of the Connector for Zenoss involves the following high-level steps, which are describedin detail in the following chapters:

1. Install HP BSMConnector 10.00.

The Connector for Zenoss requires an HP BSMConnector 10.00 installation on a supportedWindows or Linux operating system. Install the BSM Connector before you install the Connectorfor Zenoss. The BSMConnector must be able to connect to the computer running HP OperationsManager i 10.00 and be integrated into OMi.

2. Download the Connector for Zenoss product image from www.hp.com/go/livenetwork and store itin a temporary location on the BSMConnector host system.

3. Install the Connector for Zenoss. For details, see "Installing the Connector for Zenoss" on the nextpage.

Conventions Used When Describing Installation and Configuration

The following placeholders are used in the instructions:

Placeholder Represents Examples / Default Values

<version> Version number of theBSMConnector forZenoss

Example: 01.00.011

<date> File creation date Example: 2015.03.15

Represents a file created 15March, 2015.

<TEMP> Location for temporaryfiles

Windows:Value of the environment variable TEMP

Default:C:\Users\Administrator\AppData\Local\Temp

Linux: /tmp

%OvDataDir%

(used only inWindows paths)

Data directory of the HPOperations Agent, usedalso by BSMConnectorfor Zenoss

Default:C:\ProgramData\HP\HP BTO Software

(Note: by default, the directory C:\ProgramDatais hidden.)


http://www.hp.com/go/livenetwork

PrerequisitesBefore installing the BSMConnector for Zenoss, the following components must be installed andconfigured. For information about installing and configuring OMi, BSM Connector, and Zenoss, see thedocumentation available with these products.

Component Version

HP Operations Manager i 10.00

HP BSM Connector 10.00

Zenoss Core 4.x

Installing the Connector for ZenossTo install the Connector for Zenoss, complete the following steps on your BSM Connector system:

1. Unpack the Connector for Zenoss product image appropriate for the operating system of yourBSM Connector host system.

n 64-bit Windows: ProductImage-HPBsmIntZenoss-<version>-Win5.2_64-release.zip

n Linux: ProductImage-HPBsmIntZenoss-<version>-Linux2.6_64-release.tar

2. Start the Connector for Zenoss installer wizard appropriate for the operating system of your BSMConnector host system.

n Windows: HPBsmIntZenoss_<version>_setup.exe

n Linux: HPBsmIntZenoss_<version>_setup.bin

Tip: The application installer is used to repair and uninstall the Connector for Zenoss.Make a note of where you have stored it.

3. Follow the instructions displayed by the Connector for Zenoss installer wizard. If all prerequisitechecks are passed without problems, click Install to start the installation.

4. After the installation completes, click Done to close the Connector for Zenoss installer wizard.

Note: If you already have other GenInt-based integrations installed on you BSMConnectorsystem, and theGenInt version is compatible, it is not replaced. Only the Connector for Zenoss isinstalled in this case.

Integration GuideChapter 2: Installation


Installing the Sync Package on the OMi server1. On the BSMConnector system, go to the directory:

Windows: %OvDataDir%installation\HPBsmIntZenoss/omi-content

Linux: /var/opt/OV/installation/HPBsmIntZenoss/omi-content

2. Copy the zip file HPBsmIntZenoss_OMi_Content.zip from the BSMConnector system to yourOMi system and unzip it.

3. On theOMi system, execute the installation script:

Windows: install-toposync.bat

Linux: install-toposync.sh

Importing the Content Package to OMiIn the OMi user interface, navigate to:

Administration > Setup and Maintenance > Content Packs.

In the Content Pack Definitions pane, use the Import tool and open the folder where you extracted theHPBsmIntZenoss_OMi_Content.zip package. Select the HPBsmIntZenoss_ContentPack.zip contentpack.

Alternatively, use the Content Manager tool:

Windows:

C:\HPBSM\bin\ContentManager.bat -import <path to content pack>\HPBsmIntZenoss_ContentPack.zip -username <OMi username> -password <OMi username password>

Linux:

/opt/HP/BSM/bin/ContentManager.sh -import <path to content pack>\HPBsmIntZenoss_ContentPack.zip -username <OMi username> -password <OMi username password>

A predefined graph will now be visible under Graphs pane in Performance Perspective for defined CItypes. See the following figure for a list of the avilable graphs.



Next StepsAfter installing the Connector for Zenoss product image on your BSM Connector system, complete thefollowing configurations:

1. Configure the Connector for Zenoss. For details, see "Configuration" on page 14.

2. Configure synchronization of data back to the Zenoss server. For details, see "SynchronizingChanges Back to the Zenoss Server " on page 22.

3. Import and activate the event integration, metric integration, and topology integration policies forZenoss. For details, see "Importing and Activating the Zenoss Policies" on page 24.



Chapter 3: ConfigurationAfter installing the BSMConnector for Zenoss on the BSMConnector host system, execute thefollowing configuration steps:

1. Configure the BSMConnector for Zenoss. See "Configuring the Integration" below.

2. Configure event back synchronization. See "Synchronizing Changes Back to the Zenoss Server "on page 22.

3. Configure the login credentials. See "Configuring Login Credentials" on page 21.

4. Start the integration services. See "Managing the Integration Services" on page 21.

5. Import and activate policies in BSM Connector. See "Importing and Activating the ZenossPolicies" on page 24.

Configuring the IntegrationTo be able to connect to the Zenoss system and to establish a receiving server on the BSMConnectorsystem, you need to set the basic options the configuration files.

1. Open the appropriate configuration file:

Windows:

%OvDataDir%\conf\HPBsmIntZenoss\genint\zenoss_events.conf

%OvDataDir%\conf\HPBsmIntZenoss\genint\zenoss_metrics.conf

%OvDataDir%\conf\HPBsmIntZenoss\genint\zenoss_topology.conf

Linux:

/var/opt/OV/conf/HPBsmIntZenoss/genint/zenoss_events.conf

/var/opt/OV/conf/HPBsmIntZenoss/genint/zenoss_metrics.conf

/var/opt/OV/conf/HPBsmIntZenoss/genint/zenoss_topology.conf

The options are listed in the section nodes, in the appropriate subsection (source or sink), andformatted as:

"<option name>" : "<value>",

2. Search for the option zenoss-hostname and set the Zenoss server hostname or IP address.


For example:

"zenoss-hostname" : "zenhost1.company.com",

For events and topology, make sure to set both occurrences in each configuration file.

You can set additional options, such as the ports used, number of days for which the old events arecollected, the polling interval, andmore. For a detailed list of available options for each collector, see"Event Collection Options" below, "Metric Collection Options" on page 17, and "Topology CollectionOptions" on page 20.

After you set the hostname, continue with "Configuring Login Credentials" on page 21.

Note: Youmust restart the BSM Connector for Zenoss services after any change to theconfiguration.

Event Collection OptionsWindows: %OvDataDir%\conf\HPBsmIntZenoss\genint\zenoss_events.conf

Linux: /var/opt/OV/conf/HPBsmIntZenoss/genint/zenoss_events.conf

Option Description

Section: source

zenoss-hostname

The Zenoss Hostname or IP address. This parameter is required.

port The service name or port used to establish the connection.

Default: 8080

protocol The protocol used to communicate with Zenoss. You need to change it to httpsif Zenoss is configured to use https.

Default: http

zenoss-events-up-to-days

Specifies the number of days for which the old (existing) events are collected.To disable the collection of existing alarms, comment out the option or set it to0.

Default: 10

zenoss-timestamp-file

Name and location of the timestamp file.

Default: /var/opt/OV/log/eventcollector.timestamp (Linux)${OvDataDir}\log\eventcollector.timestamp (Windows)

Integration GuideChapter 3: Configuration


filename The name of the Lua script which processes events data.

Default:/var/opt/OV/installation/HPBsmIntZenoss/lua/eventcollector.lua(Linux)${OvDataDir}\installation\HPBsmIntZenoss\lua\eventcollector.lua(Windows)

single-run If true, the script will only be executed once and will be running until node isactive.

Default: true

interval The time (in seconds) to wait after collecting the data

Default: 60

package-path Additional search path for Luamodules.

Default: /var/opt/OV/installation/HPBsmIntZenoss/lib/?.lua (Linux)${OvDataDir}\installation\HPBsmIntZenoss\lua\?.lua (Windows)

Section: sink

use-ssl If set to true, the connections will be encrypted using SSL v3.

Default: true

uri The URI to send the web service request to. The stringmust not contain theprotocol, hostname or port fields but only the URI part of an URL.

Default: /bsmc/rest/events/HPBsmIntZenoss

server-name Hostname or IP address of the remote host.

Default: localhost

port The service name or port to use for establishing the connection.

Default: 30005

use-persistency

If set to true, all incomingmessages will first be persisted into a file-based storebefore sending them to the remote host. It also enables the retry mechanism.

Default: true

persistency-dir

Directory path, used for the persistence layer. Directory must exist.

Default: /var/opt/OV/tmp/HPBsmIntZenoss (Linux)${OvDataDir}\tmp\HPBsmIntZenoss (Windows)

persistency-max-size

File size limit (in KB), which needs to be exceeded before the persistence layerstarts writing into a new output file.

Default: 10240



persistency-max-files

Maximum number of persistence files to keep.

Default: 10

persistency-prefix

Prefix for the persistence files. This will be used for looking up existingpersistence files on program start.

Default: HPBsmIntZenoss-events

retry-wait Amount of seconds to wait before retrying to send an HTTP request, in case ofan error. The retry mechanism requires the parameter use-persistency to beset to true.

Default: 30

auth-username Username for authentication against the remote web service endpoint. If use-store is set to true, the string specified in this parameter will be used as keyfor fetching the user name from the credential store.

auth-password Password for the authentication. If use-store is set to true, the stringspecified in this parameter will be used as key for fetching the password fromthe credential store.

root-element Name of the XML root element

Default: zenoss_event_message

use-store The option that, when set to true, causes BSMConnector for Zenoss to obtainthe authentication credentials from theGenInt keystore rather than from theintegration configuration file. In this case, the values of the auth-username andauth-password options are used as the credential string IDs inside thekeystore. Enable secure communication by using the SSL protocol to preventthe authentication credentials from being sent unencrypted to the BSMConnector for Zenoss host.

The option is by default not visible in the configuration file and you need to add itto change the value.

Default value: false

Metric Collection OptionsWindows: %OvDataDir%\conf\HPBsmIntZenoss\genint\zenoss_metrics.conf

Linux: /var/opt/OV/conf/HPBsmIntZenoss/genint/zenoss_metrics.conf

Option Description

Section: source



zenoss-hostname

The Zenoss Hostname or IP address. This parameter is required.

port The service name or port to use for establishing the connection

Default: 8080


Default: http

filename The name of the Lua script which processes events data.

Default:/var/opt/OV/installation/HPBsmIntZenoss/lua/metriccollector.lua(Linux)${OvDataDir}\installation\HPBsmIntZenoss\lua\metriccollector.lua(Windows)

single-run If true the script will only be executed once and will be running until node isactive.

Default: true

interval The time (in seconds) to wait after collecting the data.

Default: 300

package-path Additional search path for Luamodules.

Default: /var/opt/OV/installation/HPBsmIntZenoss/lib/?.lua (Linux)${OvDataDir}\installation\HPBsmIntZenoss\lua\?.lua (Windows)

Section: sink

use-ssl If set to true, the connections will be encrypted using SSL v3

Default: true

uri The URI to send the web service request to. The stringmust not contain theprotocol, hostname, or port fields but only the URI part of an URL.

Default: /bsmc/rest/metric/HPBsmIntZenoss

server-name Hostname or IP address of the remote host.

Default: localhost

port The service name or port to use for establishing the connection.

Default: 30005



use-persistency

If set to true, all incomingmessages will first be persisted into a file-based storebefore sending them to the remote host. It also enables the retry mechanism.

Default: true

persistency-dir

Directory path, used for the persistence layer. Directory must exist.

Default: /var/opt/OV/tmp/HPBsmIntZenoss (Linux)${OvDataDir}\tmp\HPBsmIntZenoss (Windows)

persistency-max-size

File size limit (in KB), which needs to be exceeded before the persistence layerstarts writing into a new output file.

Default: 10240

persistency-max-files

Maximum number of persistence files to keep.

Default: 10

persistency-prefix :

Prefix for the persistence files. This will be used for looking up existingpersistence files on program start.

Default:HPBsmIntZenoss-metrics

retry-wait Amount of seconds to wait before retrying to send an HTTP request, in case ofan error. The retry mechanism requires the parameter use-persistency to beset to true.

Default: 30

auth-username Username for authentication against the remote web service endpoint. If use-store is set to true, the string specified in this parameter will be used as key forfetching the username from the credential store.

auth-password Password for authentication. If use-store is set to true, the string specified inthis parameter will be used as key for fetching the password from the credentialstore.

root-element Name of the XML root element.

Default: zenoss_metric_message

use-store The option that, when set to true, causes BSMConnector for Zenoss to obtainthe authentication credentials from theGenInt keystore rather than from theintegration configuration file. In this case, the values of the auth-username andauth-password options are used as the credential string IDs inside thekeystore. Enable secure communication by using the SSL protocol to preventthe authentication credentials from being sent unencrypted to the BSMConnector for Zenoss host.

The option is by default not visible in the configuration file and you need to add itto change the value.

Default value: false



Topology Collection OptionsWindows: %OvDataDir%\conf\HPBsmIntZenoss\genint\zenoss_topology.conf

Linux: /var/opt/OV/conf/HPBsmIntZenoss/genint/zenoss_topology.conf

Option Description

Section: source

zenoss-hostname

The Zenoss hostname or IP address. This parameter is required.

port The service name or port used to establish the connection to the Zenoss server.

Default: 8080


Default: http

filename The name of the Lua script which processes topology data.

Default:/var/opt/OV/installation/HPBsmIntZeniss/lua/topologycollector.lua(Linux)${OvDataDir}\installation\HPBsmIntZenoss\lua\topologycollector.lua (Windows)

interval The time (in seconds) to wait after re-running the script.

Default: 3600 (1 hour)

filter-filename

The name of the filter file which lists topology devices. All devices listed in thisfile will be ignored as well as its events andmetric data.

Default: /var/opt/OV/conf/HPBsmIntZenoss\filter_device.txt (Linux)${OvDataDir}\conf\HPBsmIntZenoss\filter_device.txt (Windows)

package-path Additional search path for Luamodules

Default: $/var/opt/OV/installation/HPBsmIntZenoss/lib/?.lua (Linux)${OvDataDir}\installation\HPBsmIntZenoss\lua\?.lua (Windows)

Section: sink

filename The XML output filename.

Default: /var/opt/OV/datafiles/HPBsmIntZenoss/topology.xml (Linux)${OvDataDir}\datafiles\HPBsmIntZenoss\topology.xml (Windows)



Configuring Login CredentialsBefore you start the integration services, youmust provide credentials to connect to the Zenoss server.Use the genintcrypt tool to provide the credentials:

1. Change the directory to:

Windows: %OvInstallDir%\bin\win64

Linux: /opt/OV/bin64

2. Execute the following commands:

genintcrypt --set zenoss-username

genintcrypt --set zenoss-password

Managing the Integration ServicesStart the integration daemons as OV control services on the BSMConnector server by opening acommand prompt and issuing the command(s) in the steps below.

1. Start the services with following commands:

Linux:

./ovc -start ZEN

Alternatively, you can also start individual services:

./ovc -start zenosse

./ovc -start zenosst

./ovc -start zenossm

Windows:

ovc -start ZEN

Alternatively, you can also start individual services:

ovc -start zenosseovc -start zenosstovc -start zenossm

2. Check that the services are running, by using the command:



Linux: ./ovc

Windows: ovc

Note that until you activate the policies, youmay see some error messages in your log files.

Restarting the services

If you change the configuration, you need to restart the services.

Linux:

./ovc -restart ZEN

Alternatively, you can also restart individual services:

./ovc -restart zenosse

./ovc -restart zenosst

./ovc -restart zenossm

Windows:

ovc -restart ZEN

Alternatively, you can also restart individual services:

ovc -restart zenosseovc -restart zenosstovc -restart zenossm

Synchronizing Changes Back to the Zenoss ServerThe data available on the OMi server can be synchronized back to the Zenoss Server using theOMBackSync.pl and OMBackSync_Zenoss.pl Perl scripts.

Configure back synchronization by completing the following steps:

1. Copy the OMBackSync_Zenoss.pl script from the installation folder:

Windows: %OvDataDir%\installation\HPBsmIntZenoss\perl

Linux: /var/opt/OV/installation/HPBsmIntZenoss/perl

to:

Windows: %OvDataDir%\conf\backsync

Linux: /var/opt/OV/conf/backsync



2. Make a copy of the the OMBackSync.pl file located in the above directory (suggested name:OMBackSync.pl_orig).

3. Copy OMBackSync.pl from:

Windows: %OvDataDir%\installation\genint

Linux: /var/opt/OV/installation/genint

to:



4. Restart the ombacksync process:

ovc -restart ombacksync

Configure Device FilteringOptionally, you can filter out selected device UIDs:

1. Open the device filter list:

Windows: %OvDataDir%\conf\HPBsmIntZenoss\filter_device.txt

Linux: /var/opt/OV/conf/HPBsmIntZenoss/filter_device.txt

and enter the device UID you want to filter out.

For example: /zport/dmd/Devices/Server/SSH/Linux/devices/hostname.example.com

To get a list of the device UIDs, you can open the following:

https://<zenoss_host>/zport/dmd/Devices/getSubDevices (if you configured the integrationto use HTTPS)

http://<zenoss_host>:<port>/zport/dmd/Devices/getSubDevices (if you configured theintegration to use HTTP)

2. Save changes and restart the collectors:

Windows: ovc -restart ZEN

Linux: ./ovc -restart ZEN



Importing and Activating the Zenoss PoliciesThe policies are automatically imported by the installation script.

Go to the BSMConnector user interface and activate the following polices:

l HP BSM Connector for Zenoss (02.00) - Event IntegrationID: 764d8788-e237-4f35-8b56-12c96a6a4b9d

l HP BSM Connector for Zenoss (02.00) - Metric IntegrationID: 92c3391e-b7f7-40d4-8b48-65d3d58886ef

l HP BSM Connector for Zenoss (02.00) - Topology IntegrationID: 9eeba032-167a-4eec-bae2-79fe9d231101

l HP BSM connector for Zenoss (02.00) - Self-Discovery TopologyID: 57cbec5b-52e8-4d01-8e92-b0bb20b4b260



Chapter 4: UninstallationUninstalling the Connector for Zenoss requires you to complete the steps appropriate for your hostoperating systems.

To uninstall the Connector for Zenoss, complete the following steps:

1. Uninstall the Zenoss Connector as follows:

a. Deactivate and remove the Connector for Zenoss policies using the BSMConnectorinterface:

o HP BSM Connector for Zenoss (02.00) - Event IntegrationID: 764d8788-e237-4f35-8b56-12c96a6a4b9d

o HP BSM Connector for Zenoss (02.00) - Metric IntegrationID: 92c3391e-b7f7-40d4-8b48-65d3d58886ef

o HP BSM Connector for Zenoss (02.00) - Topology IntegrationID: 9eeba032-167a-4eec-bae2-79fe9d231101

o HP BSM connector for Zenoss (02.00) - Self-Discovery TopologyID: 57cbec5b-52e8-4d01-8e92-b0bb20b4b260

b. Uninstall the Connector for Zenoss from a BSMConnector host system as follows:

Windows:

i. Go toStart > Control Panel > Uninstall a program.

ii. Right-click the HP BSM Connector for Zenoss entry and select Uninstall.

Linux:

i. Run the following command to start the uninstall wizard:

/opt/OV/Uninstall/HPBsmIntZenoss/setup.bin

Alternatively, run the application installer which you used to install the Connector for Zenoss.For details see "Installing the Connector for Zenoss" on page 11.

Follow the instructions in the wizard to uninstall the Connector for Zenoss.

3. Uninstall the BackSync scripts:

a. Remove the current OMBackSync.pl and OMBackSync_Zenoss.pl files from the followingdirectory:




Note: If BSM Connector is configured to handlemultiple BSM Connector integrations,do not remove OMBackSync.pl.

b. Rename the OMBackSync.pl_orig file to OMBackSync.pl in the following folder.



Note: If BSM Connector is configured to handlemultiple BSM Connector integrations,skip this step.

c. Restart he ombacksync process:

ovc -restart ombacksync

Integration GuideChapter 4: Uninstallation


Chapter 5: TroubleshootingIf you encounter problems while using BSMConnector for Zenoss, you can often solve them yourself.This chapter is intended to help you.

General Troubleshooting GuidelinesWhen investigating an issue, first verify that:

l Your issue is not related to the third-party software or hardware. Otherwise, contact thecorresponding vendor for assistance.

l You have the latest operating system and software application patches installed on the affectedsystems.

l Settings in the configuration files of BSM Connector for Zenoss are correct: the file structure andsyntax are preserved, the values are valid.

Product Log FilesBSMConnector for Zenoss records actions performed by its services into log files. Occurrences ofunexpected behavior are also added as entries into the log files. You can use the logged information toinvestigate issues.

Log Files LocationBSMConnector for Zenoss creates andmaintains the following log files:

Windows: %OvDataDir%\log\HPBsmIntZenoss_[events|metrics|topology].%d.log

Linux: /var/opt/OV/log/HPBsmIntZenoss_[events|metrics|topology].%d.log

where %d is the date. Log files are added each day and kept for seven days by default.

To change location of the log files:

1. Change current directory and open the appropriate integration configuration file in a plain texteditor:

Windows:




%OvDataDir%\conf\HPBsmIntZenoss\genint\zenoss_topology.conf

Linux:



/var/opt/OV/conf/HPBsmIntZenoss/genint/zenoss_topology.conf

2. In the genintd section,change the value of the log-file option.

3. Save your changes.

4. Restart the affected integration service as described in "Managing the Integration Services" onpage 21.

Logging Severity LevelsLog entries have different severity levels. In BSM Connector for Zenoss, the following levels areavailable:

Severity Level Keyword Meaning

0 No Log logging is disabled

1 Error, Config errors, current values of integration configuration options

2 Info, Warning informationmessages, warnings

3 Trace tracing (debugging) messages

By default, the logging severity level is set to 1, whichmeans only errors and configuration-relatedmessages are logged. For troubleshooting purposes, you can change the level.

Note:When a particular logging level is set, it causes messages with lower severity level to berecorded as well. For example, if the severity level is set to 2, informationmessages, warnings,errors, and configuration-relatedmessages are logged, but tracingmessages are not.

To change the logging severity level for a particular integrated Zenoss entity type, perform these steps:

1. Change current directory and open the appropriate integration configuration file in a plain texteditor.

Integration GuideChapter 5: Troubleshooting


2. In the genintd section, perform the following:

a. Uncomment the line with the log-level option.

b. In the line that contains the log-level option, replace the value placeholder inside quotes('...') with the chosen logging severity level.

For example, to change the logging severity level from the default level to 2, change the line

//, 'log-level' : '3'

to

, 'log-level' : '2'



OMBackSync.log Log FileThe OMBackSync.pl and OMBackSync_Zenoss.pl scripts write information to the following log file:

l Windows: %OvDataDir%\log\OMBackSync.log

l Linux: /var/opt/OV/log/OMBackSync.log

The available log severity options are: DEFAULT, OFF, ERROR, INFO, TRACE.

To change log severity for the OMBackSync.pl script, change following variable :

my $verbosity = Genint::Log::DEFAULT;

Normally, the log severity is set to DEFAULT and prints [SEP] and [ERROR] entries. If no errors areencountered, no output information is printed.

Creating a Copy of DataThe event andmetric data is sent through the REST web service. In order to troubleshoot the data set,you need to enable BSM Connector to create a copy of data in a file.

To enable copying of data to files:

1. Open the appropriate integration configuration file in a plain text editor:

Windows:





Linux:



2. Enable the following options:

a. In the nodes section, uncomment the line with the copy-count option, and set the number ofcopies..

For example, to enable copying, change the line

//"copy-count" : "1"

to

"copy-count" : "1"

By default, data is copied to

${OvDataDir}\datafiles\HPBsmIntZenoss\zenoss_events.xml

${OvDataDir}\datafiles\HPBsmIntZenoss\zenoss_metrics.xml

You can change the files by editing the filename option in the sink sections.

b. In the pipe section, uncomment the following lines:

For events, change:

eventcollector -> eventsplittereventsplitter -0-> wslistener//eventsplitter -1-> xmleventsinkbacksyncsource -> backsyncsink

to

eventcollector -> eventsplittereventsplitter -0-> wslistenereventsplitter -1-> xmleventsinkbacksyncsource -> backsyncsink

Formetrics, change:



metriccollector -> metricsplittermetricsplitter -0-> wslistener//metricsplitter -1-> xmlmetricsink

to

metriccollector -> metricsplittermetricsplitter -0-> wslistenermetricsplitter -1-> xmlmetricsink



Known Issues and WorkaroundsAfter removing the Zenoss integration, some folders are left on the system

Description:

The following folders are not removed during Zenoss Integration unistallation:

Windows: %ovdatadir%tmp\HPBsmIntZenoss

Linux: /var/opt/OV/tmp/HPBsmIntZenoss

Workaround:

Manually remove the folders.

Before Contacting HP Software SupportIf you cannot solve your issue, report it. Before contacting HP Software Support, ensure that:

l You have performed the general checks. See "General Troubleshooting Guidelines" on page 27.

l You have verified your problem is not described in this chapter. See "Known Issues andWorkarounds" above.

l You have collected relevant data that might be required to send to HP Software Support: adescription of your problem, characteristics of your environment, related entries logged in theoperating system event log or in the BSMConnector for Zenoss log files.

The HP Software Support personnel will then provide you with further instructions. Among other things,youmay be asked to change the BSMConnector for Zenoss logging severity level, to repeat or performparticular operations in your BSM Connector for Zenoss environment, and to collect specific data fromyour system and send them to HP.



To contact HP Software Support, see the web site at https://softwaresupport.hp.com.



https://softwaresupport.hp.com/

Send Documentation FeedbackIf you have comments about this document, you can contact the documentation team by email. If anemail client is configured on this system, click the link above and an email window opens with thefollowing information in the subject line:

Feedback on Integration Guide (BSM Connector for Zenoss 02.00)

Just add your feedback to the email and click send.

If no email client is available, copy the information above to a new message in a webmail client, andsend your feedback to [email protected].

We appreciate your feedback!

Integration GuideSend Documentation Feedback


mailto:[email protected]?subject=Feedback on Integration Guide (BSM Connector for Zenoss 02.00)

Documents

HP BSM Connector for Zenoss Integration Guide.…Prerequisites BeforeinstallingtheBSMConnectorforZenoss,thefollowingcomponentsmustbeinstalledand configured.ForinformationaboutinstallingandconfiguringOMi,BSMConnector