HP BSM Connector for Zabbix Integration Guide.… · documentationavailablewiththeseproducts....
Transcript of HP BSM Connector for Zabbix Integration Guide.… · documentationavailablewiththeseproducts....
HP BSM Connector for ZabbixSoftware 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: http://h20230.www2.hp.com/selfsolve/manuals
This site requires that you register for an HP 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.
You will also receive updated or new editions if you subscribe to the appropriate product support service. Contact your HP sales representative for details.
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
Integration Guide
HP BSMConnector for Zabbix (02.00) Page 2 of 31
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 Zabbix (02.00) Page 3 of 31
Contents
Chapter 1: Introduction 6
Concepts 6
Event Collection 7
Metric Collection 8
Topology Collection 8
Chapter 2: Installation 10
Prerequisites 10
Installing the Connector for Zabbix 11Importing the Content Package to OMi 11
Next Steps 12
Chapter 3: Configuration 13
Configuring the Integration 13Event Collection Options 14Metric Collection Options 17Topology Collection Options 20
Configuring Login Credentials 22
Managing the Integration Services 23Restarting the services 23
Importing and Activating the Zabbix Policies 24
Chapter 4: Uninstallation 25
Chapter 5: Troubleshooting 26
General Troubleshooting Guidelines 26
Product Log Files 26Log Files Location 26Logging Severity Levels 27
Troubleshooting the Collection of Events andMetrics 28
Known Issues andWorkarounds 29
Before Contacting HP Software Support 29
HP BSMConnector for Zabbix (02.00) Page 4 of 31
Chapter 1: IntroductionHP BSMConnector for Zabbix enables you to establish a link between the Zabbix network monitoringsolution and HP Operations Manager i.
The Connector for Zabbix is an add-on for the HP BSMConnector, providing the following Zabbixspecific functionality:
l Event synchronization between Zabbix andOMi
l Metric synchronization between Zabbix andOMi
l Topology synchronization between Zabbix andOMi
This functionality enables you to consolidatemanagement data from Zabbix environments into an HPOperations Manager i solution.
Note: HP BSMConnector for Zabbix is a GenInt-based integration. If you installed other GenIntbased connectors, see "Installation " on page 10 for additional details.
ConceptsThe BSMConnector for Zabbix is installed on the BSMConnector system and uses aWeb Serviceinterface to collect the events, metrics, and topology from the Zabbix system. No additionalcomponents need to be installed on the Zabbix system.
HP BSMConnector for Zabbix (02.00) Page 6 of 31
Event CollectionZabbix events are collected and processed by the event collector script. The event collector receivesevents from the Zabbix server through its Web Service interface using the HTTP protocol.
Events are collected from the Zabbix system periodically, using a preset alarm 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 Zabbix events are collected and forwarded (by default,events from the last 10 days are forwarded).
Event data is mapped to the OMi conform form using a web service policy. The policy also sets thedrilldownURL for each event.
Integration GuideChapter 1: Introduction
HP BSMConnector for Zabbix (02.00) Page 7 of 31
Zabbix event severity OMi event severitiy
Disaster Critical
High Major
Average Minor
Warning Warning
Information Normal
Metric CollectionThemetric collector runs regularly (by default every 5minutes) and collects all current Zabbix metricsthrough theWeb Service interface using the HTTP protocol. Themetrics are stored on the BSMConnector system for further processing by OMi.
Metric data is mapped to the OMi conform form using a web 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 Zabbix server through its Web Service interface using theHTTP protocol and forwards it to the HP BSMConnector for further processing. Topology objects arethenmapped to the RTSM using the local topology synchronization component provided by the BSMConnector.
The topology collector always collects all objects, not just the new ormodified ones.
Topology objects aremapped to the RTSM using an XML file policy. Themapping rules map thefollowing CI types:
l host_node
l ip_address
Integration GuideChapter 1: Introduction
HP BSMConnector for Zabbix (02.00) Page 8 of 31
In addition, the topology self-discovery policy retrieves topology data about the Zabbix integrationenvironment itself. See the following figure for an example.
Integration GuideChapter 1: Introduction
HP BSMConnector for Zabbix (02.00) Page 9 of 31
Chapter 2: InstallationThe BSMConnector for Zabbix is installed on the BSMConnector host system. Installation and initialconfiguration of the Connector for Zabbix involves the following high-level steps, which are described indetail in the following chapters:
1. Install HP BSMConnector 10.00.
The Connector for Zabbix requires an HP BSMConnector 10.00 installation on a supportedWindows or Linux operating system. Install the BSM Connector before you install the Connectorfor Zabbix. 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 Zabbix product image from www.hp.com/go/livenetwork and store itin a temporary location on the BSMConnector host system.
3. Install the Connector for Zabbix. For details, see " Installing the Connector for Zabbix" on the nextpage.
Placeholder Represents Examples / Default Values
<version> Version number of theBSMConnector forZabbix
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 Zabbix
Default:C:\ProgramData\HP\HP BTO Software\
(Note: by default, the directory C:\ProgramDatais hidden.)
PrerequisitesBefore installing the BSMConnector for Zabbix, the following components must be installed andconfigured. For information about installing and configuring OMi, BSM Connector, and Zabbix, see the
HP BSMConnector for Zabbix (02.00) Page 10 of 31
documentation available with these products.
Component Version
HP Operations Manager i 10.00
HP BSM Connector 10.00
Zabbix 2.2 or later versions
Installing the Connector for ZabbixTo install the Connector for Zabbix, complete the following steps on your BSM Connector system:
1. Unpack the Connector for Zabbix product image appropriate for the operating system of your BSMConnector host system.
n 64-bit Windows: ProductImage-HPBsmIntZabbix-<version>-Win5.2_64-release.zip
n Linux: ProductImage-HPBsmIntZabbix-<version>-Linux2.6_64-release.tar
2. Start the Connector for Zabbix installer wizard appropriate for the operating system of your BSMConnector host system.
n Windows: HPBsmIntZabbix_<version>_setup.exe
n Linux: HPBsmIntZabbix_<version>_setup.bin
Tip: The application installer is used to repair and uninstall the Connector for Zabbix. Makea note of where you have stored it.
3. Follow the instructions displayed by the Connector for Zabbix 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 Zabbix 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 Zabbix isinstalled in this case.
Importing the Content Package to OMiIn the OMi user interface, navigate to:
Administration > Setup and Maintenance > Content Packs.
Integration GuideChapter 2: Installation
HP BSMConnector for Zabbix (02.00) Page 11 of 31
In the Content Pack Definitions pane, use the Import tool and open the folder where you store theHPBsmIntZabbix_ContentPack.zip package. Select the HPBsmIntZabbix_ContentPack.zip contentpack.
Alternatively, use the Content Manager tool:
Windows:
C:\HPBSM\bin\ContentManager.bat -import <path to content pack>\HPBsmIntZabbix_ContentPack.zip -username <OMi username> -password <OMi username password>
Linux:
/opt/HP/BSM/bin/ContentManager.sh -import <path to content pack>\HPBsmIntZabbix_ContentPack.zip -username <OMi username> -password <OMi username password>
A predefined graph will now be visible under the Graphs pane in Performance Perspective for definedCI types. See the following figure for a list of the available graphs.
Next StepsAfter installing the Connector for Zabbix product image on your BSM Connector system, complete thefollowing configurations:
1. Configure the Connector for Zabbix. For details, see "Configuring the Integration" on page 13.
2. Import and activate the event integration, metric integration, and topology integration policies forZabbix. For details, see "Importing and Activating the Zabbix Policies" on page 24.
Integration GuideChapter 2: Installation
HP BSMConnector for Zabbix (02.00) Page 12 of 31
Chapter 3: ConfigurationAfter installing the BSMConnector for Zabbix on the BSMConnector host system, execute thefollowing configuration steps:
1. Configure the BSMConnector for Zabbix. See "Configuring the Integration" below.
2. Configure the login credentials. See "Configuring Login Credentials" on page 22.
3. Start the integration services. See "Managing the Integration Services" on page 23.
4. Import and activate policies in BSM Connector. See "Importing and Activating the ZabbixPolicies" on page 24.
Configuring the IntegrationTo be able to connect to the Zabbix system and to establish a receiving server on the BSMConnectorsystem (needed for subscriptionmode), you need to set the basic options in the configuration files.
1. Open the appropriate configuration file:
Windows:
%OvDataDir%conf\HPBsmIntZabbix\zabbix_events.conf
%OvDataDir%conf\HPBsmIntZabbix\zabbix_metrics.conf
%OvDataDir%conf\HPBsmIntZabbix\zabbix_topology.conf
Linux:
/var/opt/OV/conf/HPBsmIntZabbix/zabbix_events.conf
/var/opt/OV/conf/HPBsmIntZabbix/zabbix_metrics.conf
/var/opt/OV/conf/HPBsmIntZabbix/zabbix_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 zabbix_server_hostname and set the Zabbix server hostname or IPaddress.
HP BSMConnector for Zabbix (02.00) Page 13 of 31
For example:
"zabbix_server_hostname" : "zbxhost1.company.com",
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 22.
Note: Youmust restart the BSM Connector for Zabbix services after any change to theconfiguration.
Event Collection OptionsWindows: %OvDataDir%conf\HPBsmIntZabbix\zabbix_events.conf
Linux: /var/opt/OV/conf/HPBsmIntZabbix/zabbix_events.conf
Option Description
Section: source
zabbix_server_hostname
The Zabbix server hostname or IP address. This parameter is required.
zabbix_server_port
The service name or port used to establish the connection with the Zabbixserver. The default ports are 80 for HTTP and 443 for HTTPS.
Default: 80
zabbix_server_protocol
The protocol used to communicate with Zabbix. You need to change it to httpsif Zabbix is configured to use HTTPS.
Default: http
interval The time (in seconds) to wait after collecting the data
Default: 60
zabbix_event_timestamp_filename
Timestamp persistency filename.
Default: /var/opt/OV/tmp/HPBsmIntZabbix/zabbix_event_timestamp.txt(Linux)${OvDataDir}/tmp/HPBsmIntZabbix/zabbix_event_timestamp.txt(Windows)
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 14 of 31
zabbix_event_init_age
Maximum age of alerts for the initial run. On the initial run (without having atimestamp file), the integration will fetch alerts with modification timestamp notolder than the given age (in minutes).
Default: 120
filename The name of the Lua script which processes events data.
Default: /var/opt/OV/installation/HPBsmIntZabbix/lib/zabbix_events.lua (Linux)${OvDataDir}/installation/HPBsmIntZabbix/lib/zabbix_events.lua(Windows)
package-path Additional search path for Luamodules.
Default: $/var/opt/OV/installation/HPBsmIntZabbix/lib/?.lua (Linux)${OvDataDir}/installation/HPBsmIntZabbix/lib/?.lua (Windows)
host_nodes_list_filename
The host node list used for data output filtering. When a node does not exist inthe list, the integration adds it to the list and forwards it. Otherwise, it forwardsthe node (or its child, metric, or event data) only if it is present with the indexdifferent from 0.
The following syntax is used in the file:
<index>, <id>, <friendly_name>
Where:
l index has the following values: 0 - ignore; 1 - push
l friendly_name is used to determine which nodes you would like to pushand which to ignore.
Do not change the id values.
Default: /var/opt/OV/tmp/HPBsmIntZabbix/host_nodes_list.txt (Linux)${OvDataDir}/tmp/HPBsmIntZabbix/host_nodes_list.txt (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/HPBsmIntZabbix
server-name Hostname or IP address of the remote BSM Connector host.
Default: localhost
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 15 of 31
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/HPBsmIntZabbix (Linux)${OvDataDir}\tmp\HPBsmIntZabbix (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: Zabbix-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: Zabbix_event_message
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 16 of 31
use-store The option that, when set to true, causes BSMConnector for Zabbix 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 Zabbix 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\HPBsmIntZabbix\zabbix_metrics.conf
Linux: /var/opt/OV/conf/HPBsmIntZabbix/zabbix_metrics.conf
Option Description
Section: source
zabbix_serrver_hostname
The Zabbix server hostname or IP address. This parameter is required.
zabbix_server_port
The service name or port used to establish the connection with the Zabbixserver. The default ports are 80 for HTTP and 443 for HTTPS.
Default: 80
zabbix_server_protocol
The protocol used to communicate with Zabbix. You need to change it to httpsif Zabbix is configured to use HTTPS.
Default: http
filename The name of the Lua script which processes events data.
Default: ${OvDataDir}\installation\HPBsmIntZabbix\lua\metriccollector.lua (Windows)/var/opt/OV/installation/HPBsmIntZabbix/lib/zabbix_metrics.lua(Linux)
package-path Additional search path for Luamodules.
Default: /var/opt/OV/installation/HPBsmIntZabbix/lib/?.lua (Linux)${OvDataDir}\installation\HPBsmIntZabbix\lua\?.lua (Windows)
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 17 of 31
zabbix-metric-keys
Specifies whichmetrics the integration should try to fetch. See the Zabbixdocumentation for a list of supported keys. You can find the list athttps://www.zabbix.com/documentation/<version>/manual/appendix/items/supported_by_platform.
Where <version> is the Zabbix version, for example 2.4.
Metric keys must be separated by a pipe (|) character.
The following is an example Zabbix metric key setting:
,"zabbix-metric-keys" : "system.cpu.load[percpu,avg1]|system.cpu.load[percpu,avg5]|system.cpu.load[percpu,avg15]|system.cpu.num[online]|system.uptime|system.users.num|vm.memory.size[total]"
Use the asterisk (*) to match any available keys.
Default: *
zabbix_metric_timestamp_filename
Timestamp persistency filename.
Default: /var/opt/OV/tmp/HPBsmIntZabbix/zabbix_metric_timestamp.txt(Linux)${OvDataDir}\tmp\HPBsmIntZabbix\zabbix_metric_timestamp.txt(Windows)
script-interval
Script running interval in seconds.
Default: 300
script-metric-age
Themaximum age of metrics to include (in minutes). Keep this value alignedwith the value of the option script-interval to prevent data loss orduplication. Default settings runmetrics collection every 300 seconds (5minutes) and also includemetrics with themaximum age of 5minutes.
Default: 5
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 18 of 31
host_nodes_list_filename
The host node list used for data output filtering. When a node does not exist inthe list, the integration adds it to the list and forwards it. Otherwise, it forwardsthe node (or its child, metric, or event data) only if it is present with the indexdifferent from 0.
The following syntax is used in the file:
<index>, <id>, <friendly_name>
Where:
l index has the following values: 0 - ignore; 1 - push
l friendly_name is used to determine which nodes you would like to pushand which to ignore.
Do not change the id values.
Default: /var/opt/OV/tmp/HPBsmIntZabbix/host_nodes_list.txt (Linux)${OvDataDir}/tmp/HPBsmIntZabbix/host_nodes_list.txt (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/metrics/HPBsmIntZabbix
server-name Hostname or IP address of the remote BSM Connector 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/HPBsmIntZabbix (Linux)${OvDataDir}\tmp\HPBsmIntZabbix (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
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 19 of 31
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:HPBsmIntZabbix-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 The password for 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: Zabbix_metric_message
use-store The option that, when set to true, causes BSMConnector for Zabbix 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 Zabbix 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\HPBsmIntZabbix\zabbix_topology.conf
Linux: /var/opt/OV/conf/HPBsmIntZabbix/zabbix_topology.conf
Option Description
Section: source
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 20 of 31
zabbix_server_hostname
The Zabbix hostname or IP address. This parameter is required.
zabbix_server_port
The service name or port used to establish the connection. The default ports are80 for HTTP and 443 for HTTPS.
Default: 80
zabbix_server_protocol
The protocol used to communicate with Zabbix. You need to change it to httpsif Zabbix is configured to use HTTPS.
Default: http
filename The name of the Lua script which processes topology data.
Default: /var/opt/OV/installation/HPBsmIntZabbix/lib/zabbix_topology.lua (Linux)${OvDataDir}/installation/HPBsmIntZabbix/lib/zabbix_topology.lua(Windows)
interval The time (in seconds) to wait after re-running the script.
Default: 3600 (1 hour)
package-path Additional search path for Luamodules
Default: /var/opt/OV/installation/HPBsmIntZabbix/lib/?.lua (Linux)${OvDataDir}\installation\HPBsmIntZabbix\lua\?.lua (Windows)
host_nodes_list_filename
The host node list used for data output filtering. When a node does not exist inthe list, the integration adds it to the list and forwards it. Otherwise, it forwardsthe node (or its child, metric, or event data) only if it is present with the indexdifferent from 0.
The following syntax is used in the file:
<index>, <id>, <friendly_name>
Where:
l index has the following values: 0 - ignore; 1 - push
l friendly_name is used to determine which nodes you would like to pushand which to ignore.
Do not change the id values.
Default: /var/opt/OV/tmp/HPBsmIntZabbix/host_nodes_list.txt (Linux)${OvDataDir}/tmp/HPBsmIntZabbix/host_nodes_list.txt (Windows)
Section: sink (toposink)
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 21 of 31
filename The XML output filename.
Default: /var/opt/OV/datafiles/HPBsmIntZabbix/zabbix_topology.xml(Linux)${OvDataDir}\datafiles\HPBsmIntZabbix\zabbix_topology.xml(Windows)
Section: processor(zabbixselfdiscoveryprocess)
filename The name of the Lua script file. The file must exist and be a valid Lua script
Default: /var/opt/OV/installation/HPBsmIntZabbix/lib/zabbix_self_discovery.lua (Linux)${OvDataDir}/installation/HPBsmIntZabbix/lib/zabbix_self_discovery.lua (Windows)
interval Script running interval in seconds.
Default: 3600
Section: sink(zabbixselfdiscoverysink)
filename Topology self-discovery output file name
Default: /var/opt/OV/datafiles/HPBsmIntZabbix/zabbix_topology_discovery.xml (Linux)${OvDataDir}/datafiles/HPBsmIntZabbix/zabbix_topology_discovery.xml (Windows)
Configuring Login CredentialsBefore you start the integration services, youmust provide credentials to connect to the Zabbix 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 zabbix-server-username
genintcrypt --set zabbix-server-password
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 22 of 31
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 ZBX
Alternatively, you can also start individual services:
./ovc -start zabbixe
./ovc -start zabbixt
./ovc -start zabbixm
Windows:
ovc -start ZBX
Alternatively, you can also start individual services:
ovc -start zabbixeovc -start zabbixtovc -start zabbixm
2. Check that GenInt (HPBsmIntZabbix) is running using the command:
Linux:./ovc
Windows:ovc
Restarting the services
If you change the configuration, you need to restart the services.
Linux:
./ovc -restart ZBX
Alternatively, you can also restart individual services:
./ovc -restart zabbixe
./ovc -restart zabbixt
./ovc -restart zabbixm
Windows:
ovc -restart ZBX
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 23 of 31
Alternatively, you can also restart individual services:
ovc -restart zabbixeovc -restart zabbixtovc -restart zabbixm
Importing and Activating the Zabbix PoliciesConfigure and activate policies as follows:
1. From the policies directory:
Windows: %OvDataDir%installation\HPBsmIntZabbix\policies
Linux: /var/opt/OV/installation/HPBsmIntZabbix/policies
import the following policies using the BSMConnectorWeb interface:
n HP BSM Connector for Zabbix (02.00) - Event IntegrationID: 5ed4a74a-5f4c-45c1-89fa-ecbc0d6808a0
n HP BSM Connector for Zabbix (02.00) - Metric IntegrationID: 83cf5a67-e793-4ac1-bef5-08bbebe2aa32
n HP BSM Connector for Zabbix (02.00) - Topology IntegrationID: 03abe2c6-89d9-487c-bbba-59889f487258
n HP BSM Connector for Zabbix (02.00) - Topology Self-DiscoveryID: 0d5ed38d-d861-4463-a731-f5ec1d8d94e2
2. Activate the policies in the BSMConnector interface.
Integration GuideChapter 3: Configuration
HP BSMConnector for Zabbix (02.00) Page 24 of 31
Chapter 4: UninstallationUninstalling the Connector for Zabbix requires you to complete the steps appropriate for your hostoperating systems.
To uninstall the Connector for Zabbix, complete the following steps:
1. Uninstall the Zabbix Connector as follows:
a. Deactivate and remove the Connector for Zabbix policies using the BSMConnector interface:
o HP BSM Connector for Zabbix (02.00) - Event IntegrationID: 5ed4a74a-5f4c-45c1-89fa-ecbc0d6808a0
o HP BSM Connector for Zabbix (02.00) - Metric IntegrationID: 83cf5a67-e793-4ac1-bef5-08bbebe2aa32
o HP BSM Connector for Zabbix (02.00) - Topology IntegrationID: 03abe2c6-89d9-487c-bbba-59889f487258
o HP BSM Connector for Zabbix (02.00) - Topology Self-DiscoveryID: 0d5ed38d-d861-4463-a731-f5ec1d8d94e2
b. Uninstall the Connector for Zabbix from a BSMConnector host system as follows:
Windows:
i. Go toStart > Control Panel > Uninstall a program.
ii. Right-click the Connector for Zabbix entry and select Uninstall.
Linux:
Run the following command to start the uninstall wizard:
/opt/OV/Uninstall/HPBsmIntZabbix/setup.bin
Alternatively, run the application installer which you used to install the Connector for Zabbix.For details see " Installing the Connector for Zabbix" on page 11.
HPBsmIntZabbix_<version_number>_setup.bin
Follow the instructions in the wizard to uninstall the Connector for Zabbix.
HP BSMConnector for Zabbix (02.00) Page 25 of 31
Chapter 5: TroubleshootingIf you encounter problems while using BSMConnector for Zabbix, you can often solve them yourself.This chapter is intended to help you with resolving some common problems.
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 Zabbix are correct: the file structure andsyntax are preserved, the values are valid.
Product Log FilesBSMConnector for Zabbix 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 Zabbix creates andmaintains the following log files:
Windows: %OvDataDir%log\HPBsmIntZabbix\zabbix_[events|metrics|topology].%d.log
Linux: /var/opt/OV/log/HPBsmIntZabbix/zabbix_[events|metrics|topology].%d.log
where %d is the date. Log files are added each day and kept for seven days by default.
1. Change current directory and open the appropriate integration configuration file in a plain texteditor:
Windows:
%OvDataDir%conf\HPBsmIntZabbix\zabbix_events.conf
HP BSMConnector for Zabbix (02.00) Page 26 of 31
%OvDataDir%conf\HPBsmIntZabbix\zabbix_metrics.conf
%OvDataDir%conf\HPBsmIntZabbix\zabbix_topology.conf
Linux:
/var/opt/OV/conf/HPBsmIntZabbix/zabbix_events.conf
/var/opt/OV/conf/HPBsmIntZabbix/zabbix_metrics.conf
/var/opt/OV/conf/HPBsmIntZabbix/zabbix_topology.conf
2. In the genintd section, uncomment and 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 23.
Logging Severity LevelsLog entries have different severity levels. In BSM Connector for Zabbix, 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 Zabbix entity type, perform these steps:
1. Change current directory and open the appropriate integration configuration file in a plain texteditor.
2. In the genintd section, perform the following:
Integration GuideChapter 5: Troubleshooting
HP BSMConnector for Zabbix (02.00) Page 27 of 31
a. Uncomment the line with the log-level option.
b. In the line that contains the log-level option, replace the value placeholder inside doublequotes ("...") 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"
3. Save your changes.
4. Restart the affected integration service as described in "Managing the Integration Services" onpage 23.
Troubleshooting the Collection of Events and MetricsThe event andmetric data is sent through the RESTWS 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:
%OvDataDir%conf\HPBsmIntZabbix\zabbix_events.conf
%OvDataDir%conf\HPBsmIntZabbix\zabbix_metrics.conf
Linux:
/var/opt/OV/conf/HPBsmIntZabbix/zabbix_events.conf
/var/opt/OV/conf/HPBsmIntZabbix/zabbix_metrics.conf
2. Enable the following options:
a. In the nodes section,change the line with the copy-count option, and set the number ofcopies..
For example, to enable copying, change the line
"copy-count" : "0"
Integration GuideChapter 5: Troubleshooting
HP BSMConnector for Zabbix (02.00) Page 28 of 31
to
"copy-count" : "1"
By default, data is copied to
${OvDataDir}\datafiles\HPBsmIntZabbix\zabbix_events.xml
${OvDataDir}\datafiles\HPBsmIntZabbix\zabbix_metrics.xml
You can change the files by editing the filename option for both sinks.
b. In the pipe section, uncomment the following lines:
//eventcopysplitter -1-> xmleventsink//metriccopysplitter -1-> xmlmetricsink
to
eventcopysplitter -1-> xmleventsinkmetriccopysplitter -1-> xmlmetricsink
3. Save your changes.
4. Restart the affected integration service as described in "Managing the Integration Services" onpage 23.
Known Issues and WorkaroundsAfter removing the Zabbix integration, some folders are left on the system
Description:
The following folders are not removed during Zabbix Integration unistallation:
Windows: %ovdatadir%tmp\HPBsmIntZabbix
Linux: /var/opt/OV/tmp/HPBsmIntZabbix
Workaround:
Manually remove the folders.
Before Contacting HP Software SupportIf you cannot solve your issue, report it. Before contacting HP Software Support, make sure that:
Integration GuideChapter 5: Troubleshooting
HP BSMConnector for Zabbix (02.00) Page 29 of 31
l You have performed the general checks. See "General Troubleshooting Guidelines" on page 26.
l You have verified your problem is not described in this chapter. See "Known Issues andWorkarounds" on the previous page.
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 Zabbix 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 Zabbix logging severity level, to repeat or performparticular operations in your BSM Connector for Zabbix environment, and to collect specific data fromyour system and send them to HP.
Note: The HP Software Support personnel are not qualified to solve the issues related tothird-party software or hardware.
To contact HP Software Support, see the web site at https://softwaresupport.hp.com.
Integration GuideChapter 5: Troubleshooting
HP BSMConnector for Zabbix (02.00) Page 30 of 31
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 Zabbix 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!
HP BSMConnector for Zabbix (02.00) Page 31 of 31