ibm tivoli netcool/omnibus probe for hp network … probe for hp network node mana ger -i v ersion...

40
Netcool/OMNIbus Probe for HP Network Node Manager-i Version 2.0 Reference Guide March 10, 2016 SC27-6551-01 IBM

Upload: phungliem

Post on 28-Apr-2018

237 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Netcool/OMNIbus Probe for HP Network Node Manager-iVersion 2.0

Reference GuideMarch 10, 2016

SC27-6551-01

IBM

Page 2: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network
Page 3: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Netcool/OMNIbus Probe for HP Network Node Manager-iVersion 2.0

Reference GuideMarch 10, 2016

SC27-6551-01

IBM

Page 4: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

NoteBefore using this information and the product it supports, read the information in “Notices and Trademarks,” on page 25.

Edition notice

This edition (SC27-6551-01) applies to version 2.0 of the Probe for HP NNM-i and to all subsequent releases andmodifications until otherwise indicated in new editions.

This edition replaces SC27-6551-00.

© Copyright IBM Corporation 2014, 2016.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Page 5: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Contents

About this guide . . . . . . . . . . . vDocument control page . . . . . . . . . . . vConventions used in this guide . . . . . . . . vi

IBM Tivoli Netcool/OMNIbus Probe forHP Network Node Manager-i . . . . . . 1Summary . . . . . . . . . . . . . . . 1Getting started. . . . . . . . . . . . . . 2Installing probes . . . . . . . . . . . . . 3Configuring the probe . . . . . . . . . . . 4Running the probe . . . . . . . . . . . . 6Data acquisition . . . . . . . . . . . . . 6

ObjectServer information . . . . . . . . . 6Connecting to the HP NNM-i system . . . . . 7Authentication. . . . . . . . . . . . . 8Event retrieval . . . . . . . . . . . . . 9Subscription checking and renewal . . . . . . 9

Event synchronization . . . . . . . . . . 11Reconnection and backoff strategy . . . . . . 13Inactivity . . . . . . . . . . . . . . 13Support for Unicode and non-Unicode characters 13Peer-to-peer failover functionality . . . . . . 14First time deployment . . . . . . . . . . 15

Properties and command line options . . . . . 15Properties and command line options provided bythe Java Probe Integration Library (probe-sdk-java)version 8.0. . . . . . . . . . . . . . . 19Elements . . . . . . . . . . . . . . . 21Error messages . . . . . . . . . . . . . 23

Appendix. Notices and Trademarks . . 25Notices . . . . . . . . . . . . . . . . 25Trademarks . . . . . . . . . . . . . . 27

© Copyright IBM Corp. 2014, 2016 iii

Page 6: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

iv IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 7: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

About this guide

The following sections contain important information about using this guide.

Document control pageUse this information to track changes between versions of this guide.

The IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-idocumentation is provided in softcopy format only. To obtain the most recentversion, visit the IBM® Tivoli® Knowledge Center:

http://www-01.ibm.com/support/knowledgecenter/?lang=en#!/SSSHTQ/omnibus/probes/common/Probes.html

Table 1. Document modification history

Documentversion

Publicationdate

Comments

SC27-6551-00 November 7,2014

First IBM publication.

The probe supports HP NNMi 9.2.

SC27-6551-01 March 10,2016

“Summary” on page 1.

Support extended to include HP NNMi 10.0 and HPNNMi 10.10.

Descriptions for the following properties were added to“Properties and command line options provided by theJava Probe Integration Library (probe-sdk-java) version8.0” on page 19.

v EnableSSL

v EnableSSLDebug

v KeyStore

v KeyStorePassword

v KeyStoreType

v SecurityProtocol

v SubscriptionFilter

v TrustStore

v TrustStorePassword

v TrustStoreType

This probe addresses the following EnhancementRequests:

RFE 71896: Enhancement made to support the newestversion of the HP Network Node Manager-i version(10.0).

RFE 65044: Enhancement made to support HTTPSconnection to the probe.

© Copyright IBM Corp. 2014, 2016 v

Page 8: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Conventions used in this guideAll probe guides use standard conventions for operating system-dependentenvironment variables and directory paths.

Operating system-dependent variables and paths

All probe guides use standard conventions for specifying environment variablesand describing directory paths, depending on what operating systems the probe issupported on.

For probes supported on UNIX and Linux operating systems, probe guides use thestandard UNIX conventions such as $variable for environment variables andforward slashes (/) in directory paths. For example:

$OMNIHOME/probes

For probes supported only on Windows operating systems, probe guides use thestandard Windows conventions such as %variable% for environment variables andbackward slashes (\) in directory paths. For example:

%OMNIHOME%\probes

For probes supported on UNIX, Linux, and Windows operating systems, probeguides use the standard UNIX conventions for specifying environment variablesand describing directory paths. When using the Windows command line withthese probes, replace the UNIX conventions used in the guide with Windowsconventions. If you are using the bash shell on a Windows system, you can use theUNIX conventions.

Note: The names of environment variables are not always the same in Windowsand UNIX environments. For example, %TEMP% in Windows environments isequivalent to $TMPDIR in UNIX and Linux environments. Where such variables aredescribed in the guide, both the UNIX and Windows conventions will be used.

Operating system-specific directory names

Where Tivoli Netcool/OMNIbus files are identified as located within an archdirectory under NCHOME or OMNIHOME, arch is a variable that represents youroperating system directory. For example:

$OMNIHOME/probes/arch

The following table lists the directory names used for each operating system.

Note: This probe may not support all of the operating systems specified in thetable.

Table 2. Directory names for the arch variable

Operating system Directory name represented by arch

AIX® systems aix5

HP-UX Integrity-based systems hpux11hpia

vi IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 9: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 2. Directory names for the arch variable (continued)

Operating system Directory name represented by arch

Red Hat Linux and SUSE systems linux2x86

Linux for System z linux2s390

Solaris systems solaris2

Windows systems win32

OMNIHOME location

Probes and older versions of Tivoli Netcool/OMNIbus use the OMNIHOMEenvironment variable in many configuration files. Set the value of OMNIHOME asfollows:v On UNIX and Linux, set $OMNIHOME to $NCHOME/omnibus.v On Windows, set %OMNIHOME% to %NCHOME%\omnibus.

About this guide vii

Page 10: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

viii IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 11: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

IBM Tivoli Netcool/OMNIbus Probe for HP Network NodeManager-i

The HP Network Node Manager-i (NNM-i system) is a network managementsystem that discovers network devices and provides a map of the network'stopology. The system identifies the source of network problems and assistsnetwork managers in planning for network growth and designing networkchanges.

The subscribes to the HP NNM system for event information and reports these asincidents to Netcool/OMNIbus. The probe can also synchronize its eventinformation with the HP NNM system at regular intervals. Both the subscriptionand resynchronization streams can be filtered. The probe can also be subscribe tothe XML event descriptions that the HP NNM API makes available.

This guide contains the following sections:v “Summary”v “Getting started” on page 2v “Installing probes” on page 3v “Configuring the probe” on page 4v “Data acquisition” on page 6v “Running the probe” on page 6v “Properties and command line options” on page 15v “Properties and command line options provided by the Java Probe Integration

Library (probe-sdk-java) version 8.0” on page 19v “Elements” on page 21v “Error messages” on page 23

SummaryEach probe works in a different way to acquire event data from its source, andtherefore has specific features, default values, and changeable properties. Use thissummary information to learn about this probe.

The following table provides a summary of the Probe for HP NNM-i.

Table 3. Summary

Probe target HP Network Node Manager-i version 9.2

HP Network Node Manager-i version 10.0

HP Network Node Manager-i version 10.10

Probe executable name nco_p_hp_nnm

Patch number 2.0

Probe supported on For details of supported operating systems, see thefollowing Release Notice on the IBM Software Supportwebsite: https://www-304.ibm.com/support/docview.wss?uid=swg21687619

Properties file $OMNIHOME/probes/arch/hp_nnm.props

© Copyright IBM Corp. 2014, 2016 1

Page 12: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 3. Summary (continued)

Rules file $OMNIHOME/probes/arch/hp_nnm.rules

Requirements For details of any additional software that this proberequires, refer to the description.txt file that issupplied in its download package.

Connection method HTTP/SOAP

Multicultural support Available

For information about configuring multiculturalsupport, including language options, see the IBM TivoliNetcool/OMNIbus Installation and Deployment Guide.

Peer-to-peer failover functionality Available

IP environment IPv4 and IPv6

Federal Information ProcessingStandards (FIPS)

IBM Tivoli Netcool/OMNIbus V7.3.0, 7.3.1, 7.4.0, and8.1 use the FIPS 140-2 approved cryptographicprovider: IBM Crypto for C (ICC) certificate 384 forcryptography. This certificate is listed on the NISTwebsite at http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/1401val2004.htm. For details aboutconfiguring Netcool/OMNIbus for FIPS 140-2 mode,see the IBM Tivoli Netcool/OMNIbus Installation andDeployment Guide.

Getting startedThis section shows how to start the probe with the minimum requiredconfiguration. The procedure assumes that you have a version ofNetcool/OMNIbus installed and running.

Use the following procedure to start the probe with a minimal configuration:

Note: The commands shown in this example are for a Linux system. Adapt thesecommands as necessary for the operating system that your probe server runs.1. Download the probe's installation package following the instructions in

http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/reference/install_download_intro.html.

2. Install the probe following the instructions in http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/reference/install_install_intro.html.

3. Edit the probe's properties file and set values for the following: [insert nestedlist of properties and the values they need]

4. Ensure that $NCHOME/etc/omni.dat includes information on the ObjectServer.5. If you made changes to omni.dat, regenerate the definition file by running

$NCHOME/bin/nco_igen.6. Check that the server where you have installed the probe can contact the

ObjectServer using the ping utility. For example:ping -c 10 server-name

Replace server-name with the name of the server where the ObjectServer isrunning.Alternatively, if you have installed the Netcool/OMNIbus desktop feature,you can use the nco_ping utility to check connectivity to the ObjectServer. Forexample:

2 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 13: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

nco_ping object-server

Replace object-server with the name of the ObjectServer.7. Obtain a listing of the probe's command line options to check the probe is

installed correctly:Check that the output from this command begins as follows:

8. Start the probe as follows:9. Check the probe's log file to ensure the probe started correctly and is ready to

receive, process, and dispatch events.The probe's MessageLog property provides the name and location of theprobe's log file.

10. Where possible, use a test tool to send events to the probe and so check theyare processed correctly.For example, [put your probe's preferred test tool in here]

The probe is now successfully installed and operational. You can now configure theprobe to suit your operating environment.

Installing probesAll probes are installed in a similar way. The process involves downloading theappropriate installation package for your operating system, installing theappropriate files for the version of Netcool/OMNIbus that you are running, andconfiguring the probe to suit your environment.

The installation process consists of the following steps:1. Downloading the installation package for the probe from the Passport

Advantage Online website.Each probe has a single installation package for each operating systemsupported. For details about how to locate and download the installationpackage for your operating system, visit the following page on the IBM TivoliKnowledge Center:http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/reference/install_download_intro.html

2. Installing the probe using the installation package.The installation package contains the appropriate files for all supportedversions of Netcool/OMNIbus. For details about how to install the probe torun with your version of Netcool/OMNIbus, visit the following page on theIBM Tivoli Knowledge Center:http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/reference/install_install_intro.html

3. Configuring the probe.This guide contains details of the essential configuration required to run thisprobe. It combines topics that are common to all probes and topics that arepeculiar to this probe. For details about additional configuration that iscommon to all probes, see the IBM Tivoli Netcool/OMNIbus Probe and GatewayGuide.

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 3

Page 14: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Configuring the probeAfter installing the probe you need to make various configuration settings to suityour environment. You also need to install HP NNM-i utilities.

The following table outlines how to use the probe's properties to configure theproduct's features. Configuration of some features is mandatory for allinstallations. For those features set the properties to the correct values or verifythat their default values are suitable for your environment. Further configuration isoptional depending on which features of the probe you want to use.

Table 4. Configuring the probe

Feature Properties See

Mandatory features:

HP NNM systemconnection information

The method that the probeobtains the reference to theobject needed to connect tothe CORBA interface.

NnmAddressNnmPortProbeReceiverPortSubscriptionFilter

“Connecting to the HPNNM-i system” on page 7

Authentication

Credentials forauthenticating with the TMFendpoint.

NnmPasswordNnmUserId

“Authentication” on page 8

ObjectServer host name Server “ObjectServer information”on page 6

Optional features:

Event synchronizationpolicy

Specifies whether the probesynchronizes with the HPNNM system at startup andon regular occasions.

InitialResyncResyncIntervalResyncBatchSizeResyncFilterNameResyncFilterOperationResyncFilterValue

“Event synchronization” onpage 11

Reconnection policy

Specifies whether the probeattempts to reconnect to theHP NNM system followinga communications failure.

RetryCountRetryInterval

“Reconnection and backoffstrategy” on page 13

Inactivity policy

Specifies whether the probedisconnects from the HPNNM system following aperiod of inactivity.

Inactivity “Inactivity” on page 13

Support for Unicode andnon-Unicode characters

Enables the probe to processalarms that containcharacters encoded inUTF-8, such as Asianlanguages.

None “Support for Unicode andnon-Unicode characters” onpage 13

4 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 15: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 4. Configuring the probe (continued)

Feature Properties See

Peer-to-peer failover pair

Allows you to set up twoprobes to act as a failoverpair to improve availability.If the master probe shouldstop working, the slaveprobes takes over until themaster is available oncemore.

MessageFileModePeerHostPeerPortPidFilePropsFileRulesFile

“Peer-to-peer failoverfunctionality” on page 14

Installing the HP NNM-i utilities

The configuring of the Probe for HP NNM-i requires that you install the HPNNM-i utilities. To install these utilities, follow these steps:1. Manually create the following directory:

$OMNIHOME/probes/java/nco_p_hp_nnm

2. Copy the nms-sdk.jar file from the /$NNM_HOME/OV/NNM/lib directory to the$OMNIHOME/probes/java/nco_p_hp_nnm directory.

Note: The $NNM_HOME variable specifies the location where HP NNM-i isinstalled.

3. Ensure that the default location setting for the utility JAR file exists on therespective operating system platforms:v On Windows:

File:%OMNIHOME\probes\win32\nco_p_hp_nnm.bat

Where the default configuration is:set PROBE_CLASSPATH=%CLASS_DIR%\nco_p_hp_nnm.jar;%OMNIHOME%\probes\java\nco_p_hp_nnm\nms-sdk.jar

v On Unix:

File:$OMNIHOME/probes/java/nco_p_hp_nnm.env

Where the default configuration is:CLASSPATH_SETTING=${OMNIHOME}/probes/java/nco_p_hp_nnm/nms-sdk.jar

Deploying the probe

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 5

Page 16: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Running the probeProbes can be run in a variety of ways. The way you chose depends on a numberof factors, including your operating system, your environment, and the any highavailability considerations that you may have.

For details about how to run the probe, visit the following page on the IBM TivoliKnowledge Center:

http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/all_probes/wip/concept/running_probe.html

Data acquisitionEach probe uses a different method to acquire data. Which method the probe usesdepends on the target system from which it receives data.

The Probe for HP NNM-i acquires data from HP NNM-i.

Data acquisition is described in the following topics:v “ObjectServer information”v “Connecting to the HP NNM-i system” on page 7v “Authentication” on page 8v “Event retrieval” on page 9v “Subscription checking and renewal” on page 9v “Event synchronization” on page 11v “Reconnection and backoff strategy” on page 13v “Inactivity” on page 13v “Support for Unicode and non-Unicode characters” on page 13v “Peer-to-peer failover functionality” on page 14

ObjectServer informationThe probe sends processed events to an ObjectServer resource. This can be a singleserver or a failover pair of ObjectServers.

The probe sends processed events to an ObjectServer resource. This can be a singleserver or a failover pair of ObjectServers.

Single ObjectServer

Configure the probe to communicate with an ObjectServer by setting the Serverproperty to the name of the ObjectServer.

Failover pair

Optionally, you can define a failover pair of ObjectServers. One of them acts as theprimary ObjectServer that the probe communicates with initially. Should thatObjectServer become unreachable, the probe communicates with the other, backupObjectServer. To define a failover pair set the following probe properties:

6 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 17: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 5. Properties that define a failover pair of ObjectServers

Property Value

Server Set this property to the name of the primary ObjectServer.

ServerBackup Set this property to the name of the backup ObjectServer.

NetworkTimeout Set this property to the timeout period, in seconds, for the primaryObjectServer. If the probe does not receive a response from the primaryObjectServer within that time, it connects to the backup ObjectServer.

PollServer Set this property to the time period, in seconds, when the probe tries toreconnect to the primary ObjectServer.

Note: Ensure that the value of NetworkTimeout is less than the value of PollServer.

Connecting to the HP NNM-i systemThe probe connects to the system and subscribes to the notification event service toreceive new events as they are generated.

When it starts, the probe connects to the HP NNM-i system over HTTP using thefollowing properties:v NNMAddress: This property contains the address of the HP NNM-i system in IPv4

or IPv6 format, as appropriate for your network.v NNMPort: The probe uses this property to connect to the port on the HP NNM-i

system where it receives subscription requests.

The administrator of the HP NNM-i system can provide the values to use for theseproperties.

Once the connection is active, the probe sends a SOAP message that creates asubscription for receiving events from the HP NNM-i system. This messageincludes the identity of the port on the host that runs the probe where it receivesevents. The ProbeReceiverPort identifies this port. Set this to a suitable value foryour environment.

In this configuration, the probe acts as the client to the HP NNM-i system's server.

The subscription filterThe SOAP message that creates the event subscription can include a subscriptionfilter. The filter defines the events that the probe wishes to receive from the HPNNM-i system. For example, the probe can specify that it wants to receive eventswith a severity of critical only.

Use the SubscriptionFilter property to define subscription filter. The property'svalue is an XPath expression that identifies the events that the probe wants toreceive. The following are some examples of the subscription filter:

Table 6. Examples of the subscription filter

Value of the SubscriptionFilter property Description

"arg0[severity=’CRITICAL’]" The probe receives events that have aseverity of critical only.

"arg0[origin=’MANAGEMENTSOFTWARE’]" The probe receives events that originatefrom the MANAGEMENTSOFTWARE componentonly.

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 7

Page 18: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

By default, the subscription filter is empty, and so the probe receives all events thatthe HP NNM-i system generates.

Firewall considerationsThe ProbeReceiverPort property defines the port where the probe receivesmessages from the HP NNM-i system. Ensure that port is open to receive messageson the system that runs the probe.

The NnmPort property defines the port on the HP NNM-i system that the probecommunicates with. Ensure that port is open on the HP NNM-i system.

Creating a secure channelThe probe uses secure transport layer (SSL) to enable a secured HTTPStransmission. You can choose to use HTTP (non-secured) or HTTPS by configuringthe EnableSSL property and setting the keystore/truststore.

Configuring SSL connections

If the server is using an SSL connection to encrypt data exchanged over JMS andHTTP, you must configure the truststore for the HTTPS connection on the TivoliNetcool/OMNIbus probe server.

AuthenticationWhen subscribing to events from the HP NNM-i system, the probe providesauthentication information in the form of a username and password.

Use the NNMUserID and NNMPassword properties to contain the credentials for theaccount on the HP NNM-i system that the probe uses for event notification. Thevalues of both properties can be plain text or AES encrypted text. However, forimproved security encrypt both the user name and password.

To encrypt the username or password, use the nco_keygen utility to create a keyfile and then use the nco_aes_crypt utility to encrypt the text using the key file.

Detailed instructions on how to encrypt a property value, such as NNMUserID andNNMPassword are in the IBM Tivoli Netcool/OMNIbus Installation and DeploymentGuide. The following example summarizes the procedure for encrypting thepassword:1. Use nco_keygen to create a key file; for example:

$NCHOME/omnibus/bin/nco_keygen -o $NCHOME/omnibus/probes/key_file

2. Set the value of the probe's ConfigKeyFile property to the file path of the keyfile; for example:ConfigKeyFile: "$NCHOME/omnibus/probes/key_file"

3. Set the value of the probe's ConfigCryptoAlg property to AES:ConfigCryptoAlg: "AES"

4. Use nco_aes_crypt to encrypt the password; for example:$NCHOME/omnibus/bin/nco_aes_crypt -c AES -k key_file password

5. Set the value of the probe's NNMPassword property to the encrypted stringgenerated by nco_aes_crypt; for example:Password: "@44:U/ccVZ0K+ftc7gZTV33Yx2fODe5v46RZzEbvqpE=@"

8 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 19: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Event retrievalWhen the probe is running, it receives events from the HP NNM-i system as theyare generated. The probe receives details of new incident events and updates toexisting events that match the criteria in the SubscriptionFilter property.

Each message from the HP NNM-i system contains a $Resent, $Identifier and$UpdateTime element. These elements indicate whether the message is new, anupdate to a previous message, or if the message has previously been processed bythe probe.

For existing events, the probe receives notification only if either the$LifecycleState or $RcaState element of the incident is updated.

The probe maintains an internal cache of events it has received. The probe usesthis cache to avoid sending false duplicate events to the Netcool/OMNIbus eventlist.

The HP NNM-i system can detect if a message has not been sent, and makes threeattempts to resend the message before it is discarded.

Subscription checking and renewalThe probe periodically checks the status of and renews its subscription with theHP NNM-i system.

Checking the subscriptionThe probe regularly checks whether the subscription with the HP NNM-i server isactive. The value of the HeartbeatInterval property determines the frequency (inseconds) of this check.

The default value of HeartbeatInterval is 60. Change this, if necessary, to suityour local environment. The value of the property can be in the range 1 to 299.Note that the value of this property also affects how often the probe renews thesubscription (see “Renewing the subscription”). Take that into account whendetermining the value of the property that is suitable for your site.

Renewing the subscriptionIn addition to checking the subscription, the probe also renews it. The value of theHeartbeatInterval property has a role in determining the expiry time of thesubscription:

Table 7. Determining the subscription expiry time

Value ofHeartbeatInterval Subscription expiry time

<=240 The probe sets the subscription expiry time to 5 minutes (300seconds).

>240 The probe sets the subscription expiry time to the value ofHeartbeatInterval plus one minute (60 seconds).

For example, if the value of HeartbeatInterval is 270, the probesets the subscription expiry time to:

270 + 60 = 330 seconds = 5 minutes 30 seconds

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 9

Page 20: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

The initial subscription expiry timeThe probe creates the initial subscription when it connects to the HP NNM-isystem. The expiry time of this subscription is always 5 minutes, which is thedefault expiry time of the HP NNM-i system.

Error handlingThere are two error conditions that can occur when checking and renewing thesubscription:v The subscription check failsv The value of HeatbeatInterval is out of range

Failure of the subscription check:The subscription check can fail for a number of reasons, including:v The HP NNM-i system is not runningv The HP NNM-i system has become unreachablev The network connection to the HP NNM-i system has failed or is unavailable

If the subscription check fails, the probe does one of the following:v Shuts downv Attempts to reconnect to the HP NNM-i system

The value of the RetryCount property determines which action the probe takes.When the property value is 0, the probe shuts down. When the property has apositive value, the probe attempts to reconnect to the HP NNM-i system as shownin “Reconnection and backoff strategy” on page 13.

The value of HeartbeatInterval is out of range:If the value of HeartbeatInterval is outside the range 1 to 299, the probe logs anerror and sends a ProbeWatch message to the ObjectServer. The probe then doesone of the following:v Shuts downv Attempts to reconnect to the HP NNM-i system

The value of the RetryCount property determines which action the probe takes inthe same way as when the subscription check fails. See “Failure of the subscriptioncheck.”

Should the probe's log file contain a message indicating that the value ofHeartbeatInterval is incorrect:1. Shut down the probe.2. Correct the value of HeartbeatInterval.3. Restart the probe.

10 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 21: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Event synchronizationSynchronization enables the probe to collect any events that the HP NNM-i systemgenerated while the probe was disconnected. In addition, the probe canresynchronize with the HP NNM-i system at regular intervals. You can use anycombination of these synchronization features.

Initial synchronizationEach time the probe starts it can synchronize with the HP NNM-i system toacquire all the events that the HP NNM-i system holds. Use the InitialResyncproperty to control whether the probe carries out an initial synchronization.

When the value of the property is true, the probe carries out an initialsynchronization. When the value of the property is false, the probe does not carryout an initial synchronization.

By default, the probe does not synchronize with the HP NNM-i system at startup.

Synchronization at intervalsIn addition to synchronizing with the HP NNM-i system at startup, the probe canalso resynchronize with the HP NNM-i system at regular intervals. Use theResyncInterval property to define whether the probe synchronizes with the HPNNM-i system at intervals and how frequently.

When the value of the property is 0 or less, the probe does not resynchronize withthe HP NNM-i system at regular intervals. When the value of the property is apositive number, the probe resynchronizes with the HP NNM-i system regularly.The value of the property specifies the number of seconds between eachresynchronization operation.

By default, the probe does not regularly resynchronize with the HP NNM-i system.

Synchronization in batchesYou can use the ResyncBatchSize property to specify the maximum number ofalarms contained in each batch that the probe receives during theresynchronization operation. There may be multiple batches within oneresynchronization operation.

The default value of this property is 100.

Defining a resynchronization filterBy default, a synchronization operation retrieves all the events that the HP NNM-iserver currently holds. You can use a resynchronization filter to limit the numberof events that the event retrieves. Three properties contain the resynchronizationfilter:

ResyncFilterName

ResyncFilterOperation

ResyncFilterValue

ResyncFilterName

ResyncFilterName identifies a field in the event that you want to filter on. You canspecify the following:v assignedTov category

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 11

Page 22: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

v ciasv createdv duplicateCountv familyv firstOccurrenceTimev formattedMessagev idv lastOccurrenceTimev lifecycleStatev modifiedv naturev namev notesv originv originOccurrenceTimev priorityv rcaActivev severityv sourceNamev sourceNodeNamev sourceNodeUuidv sourceTypev sourceUuidv uuid

ResyncFilterOperation

ResyncFilterOperation defines a condition to use in the filter. You can use thefollowing operators:v =v !=v <v <=v >v >=v LIKEv NOT IN

ResyncFilterValue

ResyncFilterValue defines the value of the field identified in ResyncFilterName tobe compared against the corresponding field in each event using the operation inResyncFilterOperation.

Example

To retrieve only those events that have a severity of Error or greater, use thefollowing property values:

12 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 23: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

ResyncFilterName: "severity"ResyncFilterOperation: ">="ResyncFiltervalue: "ERROR"

Optimized SynchronizationDuring a resynchronization operation, the probe tries to optimize the process byonly retrieving events that it has not retrieved previously. The probe does thisusing the time stamp associated with each event.

Reconnection and backoff strategyUse the RetryCount and RetryInterval properties to specify how the probe reactsif the connection to the HP NNM-i system is lost or cannot be established.

Use the RetryCount property to specify whether the probe attempts to reconnect tothe HP NNM-i system. Setting the property to 0, the default value, means that theprobe does not try to reconnect and simply shuts down. Any other, positive valuespecifies the number of times the probe tries to reconnect before shutting down.

Use the RetryInterval property to specify the number of seconds between eachattempt to reconnect to the HP NNM-i system.

Setting the RetryInterval property to 0 means that the probe uses anexponentially increasing interval between connection attempts. First the probewaits 1 second, then 2 seconds, then 4 seconds, and so on up to a maximum of4095 seconds. If this limit, or the number of connection attempts is reached, theprobe shuts down.

InactivityThe probe can disconnect from the target system and shut down if there is noevent activity for a predefined amount of time.

The Inactivity property specifies the maximum time (in seconds) that the probeswaits, without receiving any messages from the HP NNM-i system. If that amountof time passes by, the probe shuts down.

To ensure that the probe never shuts down because of inactivity, set the propertyto 0.

Support for Unicode and non-Unicode charactersThe probe can process multibyte characters such as Unicode UTF-8, GB, Big5, orShift-JIS.

Use the following procedure to set up the probe to process multibyte characters:1. Ensure that the HP NNM-i system is configured to send data in the required

format (for example, UTF-8).2. Set the required locale on the system that runs the probe:

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 13

Page 24: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 8. Setting the locale for multibyte characters

Operatingsystem Procedure to set the locale

Linux and Unix Set the locale by changing the values of the LANG and LC_ALLenvironment variables. For example, to set the locale to simplifiedChinese in UTF-8, use the following commands:

export LANG=zh_CN.UTF-8export LC_ALL=zh_CN.UTF-8

Windows 1. Open the Control Panel and double click on Regional andLanguage.

2. On the Formats tab, select the language from the list in Format.

3. On the Administrative tab, click Change system locale.

4. Select the language from the list in Current System Locale.

5. Click OK.

6. Click OK.

3. Configure the ObjectServer to enable the insertion of data that uses the requiredcharacter set. The IBM Tivoli Netcool/OMNIbus Administration Guide shows howto create, configure, and run an ObjectServer in UTF-8 mode or using anothercharacter set.

4. Run the probe or, if it is already running, restart the probe.When running the probe on a Windows system using a UTF-8 character set,always specify the -utf8enabled command line option. For all other charactersets, do not use the -utf8enabled command line option.

Peer-to-peer failover functionalityThe probe supports failover configurations where two probes run simultaneously.One probe acts as the master probe, sending events to the ObjectServer; the otheracts as the slave probe on standby. If the master probe fails, the slave probeactivates.

While the slave probe receives heartbeats from the master probe, it does notforward events to the ObjectServer. If the master probe shuts down, the slaveprobe stops receiving heartbeats from the master and any events it receivesthereafter are forwarded to the ObjectServer on behalf of the master probe. Whenthe master probe is running again, the slave probe continues to receive events, butno longer sends them to the ObjectServer.

Example property file settings for peer-to-peer failover

You set the peer-to-peer failover mode in the properties files of the master andslave probes. The settings differ for a master probe and slave probe.

Note: In the examples, make sure to use the full path for the property value. Inother words replace $OMNIHOME with the full path. For example:/opt/IBM/tivoli/netcool.

The following example shows the peer-to-peer settings from the properties file of amaster probe:Server : "NCOMS"RulesFile : "master_rules_file"MessageLog : "master_log_file"

14 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 25: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

PeerHost : "slave_hostname"PeerPort : 5555 # [communication port between master and slave probe]Mode : "master"PidFile : "master_pid_file"

The following example shows the peer-to-peer settings from the properties file ofthe corresponding slave probe:Server : "NCOMS"RulesFile : "slave_rules_file"MessageLog : "slave_log_file"PeerHost : "master_hostname"PeerPort : 5555 # [communication port between master and slave probe]Mode : "slave"PidFile : "slave_pid_file"

First time deploymentThis section provides instructions on how to prepare the truststore and keystorefiles specified in the TrustStore and KeyStore properties for deployment. Thisdeployment should only be performed when the EnableSSL property is set to true.If the EnableSSL property is set to false, this section is not applicable.

The HP NNM-i probe needs to have its own pair of keys and certificates bygenerating a new key entry in a new keystore as specified by the KeyStoreproperty.

For example: $OMNIHOME/var/hp_nnm.keystore

Use the following steps to prepare the probe for deployment:1. Import into the probe truststore the following $OMNIHOME/var/

hp_nnm.truststore (as specified by the TrustStore property) certificate of theNNM-i server which can be exported from the keystore of the NNM-i serverlocated at $NnmDataDir/shared/nnm/certificates/nnm.keystore.

2. Import into the NNM-i server truststore located at $NnmDataDir/shared/nnm/certificates/nnm.truststore the probe certificate which can be exported fromthe probe keystore as specified by the KeyStore property.

Properties and command line optionsYou use properties to specify how the probe interacts with the device. You canoverride the default values by using the properties file or the command lineoptions.

The following table describes the properties and command line options specific tothis probe. For information about properties and command line options common toall probes, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Note: The ProcessSNMPAsV1 property that was used in Probe for HP NNM-iVersion 1.0 has been removed. SNMP messages from different versions areuniformly represented using a common data object for the uniformed extractionprocess.

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 15

Page 26: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 9. Properties and command line options

Property name Command line option Description

EnableSSL string -ssl (This is equivalent toEnableSSL with a value oftrue.)

-nossl (This is equivalentto EnableSSL with a valueof false.)

Use this property to specifywhether the probe enables an SSLconnection between the probe andNNM-i server using the HTTPSprotocol.

The default is false

EnableSSLDebug string -ssldebug (This isequivalent toEnableSSLDebug with avalue of true.)

-nossldebug (This is aequivalent toEnableSSLDebug with avalue of false.)

Use this property to specify thatthe probe enables verbose loggingon SSL.

The default is false.

Note: Only set this property totrue for debugging purposes.

KeyStore string -keystore string Use this property to specify thefile name (with full path) of akeystore that contains theOMNIbus probe certificate andprivate key for SSL if clientauthentication is required byNNMi server.

This keystore is expected tocontain only one key entry.

The default is "".

KeyStorePassword string -keystorepassword string Use this property to specify thepassword required to access thekeystore specified by the KeyStoreproperty.

The default is "".

KeyStoreType string -keystoretype string Use this property to specify thetype of keystore specified by theKeyStore property.

Available options are JKS,PKCS12, and any other keystoretype supported by JRE.

The default is JKS.

NNMAddress string -nnmip string The IP address of NNM serverinstance to be monitored.

If the EnableSSL property is set totrue, the value of this propertyshould match with the value of CNfield or subject alternative namesfield in NNMi certificate for theproper host name/IP addressverification during SSLhandshaking.

The default is 127.0.0.1.

16 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 27: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 9. Properties and command line options (continued)

Property name Command line option Description

NNMPassword string -nnmpassword string Use this property to specify theencrypted password to login tothe HP NNM-i server webservices.

The default is "".

NNMPort integer -nnmport integer Use this property to specify theport on the HP NNM-i systemwhere the system's web servicesare exposed.

The default is 80.

NNMUserID string -nnmusername string Use this property to specify theencrypted user ID to login into HPNNM-i server web services.

The default is "".

ProbeReceiverPort integer -probereceiverportinteger

Use this property to specify theport that receives events from theHP NNM-i system.

The default is 8080.

ResyncBatchSize integer -resyncbatchsize integer Use this property to specify thenumber of events contained ineach batch request.

The default is 100.

ResyncFilterName string -resyncfiltername string Use this property to specify thename of the attribute to be actedon by the resynchronization filter.

The default is severity.

ResyncFilterOperationstring

-resyncfilteroperationstring

Use this property to specify thecondition to filter events onduring a resynchronizationoperation.

The operation to be applied inresynchronization can take thefollowing values:

=, !=, >, >=, <, <=.

The default is "=".

ResyncFilterValue string -resyncfiltervalue string Use this property to specify thevalue to be checked for by theresynchronization filter.

The default is "CRITICAL".

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 17

Page 28: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 9. Properties and command line options (continued)

Property name Command line option Description

SecurityProtocol string -securityprotocolstring Use this property to specify whichsecure socket protocol the probeuses when SSL encryption isenabled. The value of thisproperty cannot be emptied.

The actual available possiblevalues for this property dependson the implementation of the JREthat the probe is run with, as wellas the security protocolssupported by the current versionof the connected HP NNM-isystem.

The default is TLSv1.

SubscriptionFilter string -subscriptionfilterstring

Use this property to specify theXPath string to describe the filterfor subscription events.

The default is "".

TrustStore string -truststore string Use this property to specify thefile name (with full path) of atruststore file that contains trustedcertificates including certificates ofthe HP NNMi server and theCertificate Authority (CA).

This property must be set if theEnableSSL property is set to true.

The default is "".

TrustStorePassword string -truststorepasswordstring

Use this property to specify thepassword required to access thetruststore file specified by theTrustStore property.

The default is "".

TrustStoreType string -truststoretype string Use this property to specify thetype of truststore specified byTrustStore property.

Available options are JKS,PKCS12, and any other keystoretype supported by JRE.

The default value is JKS.

18 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 29: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Properties and command line options provided by the Java ProbeIntegration Library (probe-sdk-java) version 8.0

All probes can be configured by a combination of generic properties and propertiesspecific to the probe.

The following table describes the properties and command line options that areprovided by the Java Probe Integration Library (probe-sdk-java) version 8.0.

Note: Some of the properties listed may not be applicable to your probe.

Table 10. Properties and command line options

Property name Command line option Description

CommandPort integer -commandport integer Use this property to specify theport to which users can Telnet tocommunicate with the probe usingthe Command Line Interface (CLI)supplied.

The default is 6970.

CommandPortLimit integer -commandportlimit integer Use this property to specify themaximum number of Telnetconnections that can be made tothe probe.

The default is 10.

DataBackupFile string -databackupfile string Use this property to specify thepath to the file that stores databetween probe sessions.

The default is "".

Note: Specify the path relative to$OMNIHOME/var.

HeartbeatInterval integer -heartbeatintervalinteger

Use this property to specify thefrequency (in seconds) with whichthe probe checks the status of thehost server.

The default is 1.

Inactivity integer -inactivity integer Use this property to specify thelength of time (in seconds) thatthe probe allows the port toreceive no incoming data beforedisconnecting.

The default is 0 (which instructsthe probe to not disconnect duringperiods of inactivity).

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 19

Page 30: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 10. Properties and command line options (continued)

Property name Command line option Description

InitialResync string -initialresync string Use this property to specifywhether the probe requests allactive alarms from the host serveron startup. This property takes thefollowing values:

false: The probe does not requestresynchronization on startup.

true: The probe requestsresynchronization on startup.

For most probes, the default valuefor this property is false.

If you are running the JDBCProbe, the default value for theInitialResync property is true.This is because the JDBC Probeonly acquires data using theresynchronization process.

MaxEventQueueSize integer -maxeventqueuesizeinteger

Use this property to specify themaximum number of events thatcan be queued between the nonnative process and theObjectServer.

The default is 0.

Note: You can increase thisnumber to increase the eventthroughput when a large numberof events is generated.

ResyncInterval integer -resyncinterval integer Use this property to specify theinterval (in seconds) at which theprobe makes successiveresynchronization requests.

For most probes, the default valuefor this property is 0 (whichinstructs the probe to not makesuccessive resynchronizationrequests).

If you are running the JDBCProbe, the default value for theResyncInterval property is 60.This is because the JDBC Probeonly acquires data using theresynchronization process.

RetryCount integer -retrycount integer Use this property to specify howmany times the probe attempts toretry a connection before shuttingdown.

The default is 0 (which instructsthe probe to not retry theconnection).

20 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 31: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 10. Properties and command line options (continued)

Property name Command line option Description

RetryInterval integer -retryinterval integer Use this property to specify thelength of time (in seconds) thatthe probe waits betweensuccessive connection attempts tothe target system.

The default is 0 (which instructsthe probe to use an exponentiallyincreasing period betweensuccessive connection attempts, forexample, the probe will wait for 1second, then 2 seconds, then 4seconds, and so forth).

ElementsThe probe breaks event data down into tokens and parses them into elements.Elements are used to assign values to ObjectServer fields; the field values containthe event details in a form that the ObjectServer understands.

The following table describes the elements that the Probe for HP NNM-i generates.Not all the elements described are generated for each event; the elements that theprobe generates depends upon the event type. For more detailed information abouteach token, see the HP documentation.

Table 11. Elements

Element name Element description

$Id This element contains the ID of the HP NNM-iuser.

$AssignedTo This element identifies the user to whom thealarm was assigned

$Category This element shows the category priority of thealarm.

$cia_address This element contains the custom incidentattributes (CIA) address of the source from whichthe alarm was sent.

$cia_agentAddress This element contains the CIA SNMP agentaddress.

$cia_originaladdress This element identifies the original trap's address.

$cia_snmpoid This element identifies the CIA SNMP objectidentifier (OID).

$DuplicateCount This element contains the number of times thealarm has been duplicated.

$Family This element identifies the event source.

$FormattedMessage This element contains the name of the alarm.

$LifecycleState This element displays the lifecycle status of thetoken generated.

$Name This element contains the name of the event.

$Notes This element identifies user suppliedremarks/notes.

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 21

Page 32: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 11. Elements (continued)

Element name Element description

$Priority This element indicates the priority of the alarm.

$SourceName This element contains the name of the alarmsource.

$SourceNodeName This element displays the node name of thesource from which the alarm was sent.

$SourceNodeUuid This element displays the node UUID of thesource from which the alarm was sent.

$Severity This element indicates the severity of the alarm.Possible values include:

v CRITICAL

v MAJOR

v MINOR

v WARNING

v NORMAL

$Uuid This element shows the unique identifier for anHP NNM-i event.

$Created This element identifies the time the event wascreated.

$FirstOccurrenceTime This element identifies the first occurrence of theevent.

$LastOccurrenceTime This element identifies the last time the eventoccurred.

$Modified This element identifies the last time the alarm'sdetails were modified.

$Nature This element indicates the nature of the alarm.Possible values include:

v ROOTCAUSE

v SECONDARYROOTCAUSE

v SYMPTOM

v SERVICEIMPACT

v STREAMCORRELATION

v NONE

$Origin This element indicates the origin of the alarm.Possible values include:

v MANAGEMENTSOFTWARE

v MANUALLYCREATED

v REMOTELYGENERATED

v SNMPTRAP

v SYSLOG

v OTHER

$OriginOccurrenceTime This element identifies the time of the occurrencethat generated the event.

$SourceType This element identifies the data type of the sourceobject.

22 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 33: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Error messagesError messages provide information about problems that occur while running theprobe. You can use the information that they contain to resolve such problems.

The following table describes the error messages specific to this probe. Forinformation about generic error messages, see the IBM Tivoli Netcool/OMNIbusProbe and Gateway Guide.

Table 12. Error messages

Error Description Action

Encountered aJAXException attemptingto send subscriptionrequest

Encountered aSOAPException attemptingto send subscriptionrequest

Encountered aWebServiceExceptionattempting to sendsubscription request

Error creating aDocumentBuilder instance:message

Error creating aJAXBContext instance:message

Error formatting Expiresto String: message

Error parsing Expires toDate: message

ReferenceParameter doesnot exist inSubscribeResponse

These errors indicateproblems with probe startup.

Ensure that theNNMPortproperty points to the portwhere the HP NNM-i systemhas been configured to hostthe WS-API.

Check any firewalls betweenthe probe and the HP NNM-imachine.

Confirm that the NNMWebServices API isfunctioning correctly bychecking that your HP NNM-iinstallation has an IntegrationEnablement License and thatthe services are available. Thiscan be confirmed by lookingat the jmx-console view of theNNM Jboss server.

Check that the environmenthas been configured to useJava.

HeartbeatInterval out ofrange! Please reconfigureproperty.

The probe performed a checkon the value specified in theHeartbeatInterval propertyand determined it was out ofrange.

Check the value of theHeartbeatInterval propertyan ensure the value isbetween 1 and 299.

NNM credentials notrecognized

End Point Started at :Location of Probe'sReceiver Endpoint

End Point Stopped at :Location of Probe'sReceiver Endpoint

These errors indicateproblems with the probeconfiguration.

Ensure that the NNMAddress,NNMPassword, and NNMPortproperties are set correctly.

Check that the Probe ReceiverPort is clear.

IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i 23

Page 34: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Table 12. Error messages (continued)

Error Description Action

Unable to contact the NNMIncident service forresynchronizationbecause: message

The probe was unable tocontact the HP NNM-iIncident service forresynchronization. Themessage provides additionalinformation about the error.

Check the values of theNNMAddress and NNMPortproperties to ensure a validTCP/IP address and portnumber for the HP NNM-isystem.

Also check that there is nofirewall blocking access to theHP NNM-i system.

Unable to processincident array receivedin resynchronizationbecause: message

The probe was unable toprocess the HP NNM-iincident array received in theresynchronization operation.The message providesadditional information aboutthe error.

Check the values of theNNMUserID and NNMPasswordproperties to ensure these arevalid encrypted identifiers ofan account on the HP NNM-isystem.

Also check that the valuespecified for theResyncFilterValue property isvalid for the event valuesspecified in theResyncFilterName property.

Unable to processrequested custom filter

The probe was unable toprocess the custom filter. As aresult, the probe continuesprocessing with the defaultresynchronization filters.

A resynchronization filter wasdefined using theResyncFilterName,ResyncFilterOperation, andResyncFilterValue properties.Check each of theseproperties as follows:

v That the name youspecified for theResyncFilterName is one ofthe valid names. Note thatthese names are casesensitive.

v That the operation youspecified for theResyncFilterOperationproperty is one of the validoperators and conditions.The character operators arecase sensitive.

See “Defining aresynchronization filter” onpage 11 for the valid valuesassociated with theseproperties.

24 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 35: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Appendix. Notices and Trademarks

This appendix contains the following sections:v Noticesv Trademarks

NoticesThis information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia CorporationLicensing 2-31 Roppongi 3-chome, Minato-kuTokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

© Copyright IBM Corp. 2014, 2016 25

Page 36: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who want to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM CorporationSoftware Interoperability Coordinator, Department 49XA3605 Highway 52 NRochester, MN 55901U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this information and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement, or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subjectto change without notice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject tochange before the products described become available.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

26 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 37: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs.

Each copy or any portion of these sample programs or any derivative work, mustinclude a copyright notice as follows:

© (your company name) (year). Portions of this code are derived from IBM Corp.Sample Programs. © Copyright IBM Corp. _enter the year or years_. All rightsreserved.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

TrademarksIBM, the IBM logo, ibm.com, AIX, Tivoli, zSeries, and Netcool are trademarks ofInternational Business Machines Corporation in the United States, other countries,or both.

Adobe, Acrobat, Portable Document Format (PDF), PostScript, and all Adobe-basedtrademarks are either registered trademarks or trademarks of Adobe SystemsIncorporated in the United States, other countries, or both.

Intel, Intel Inside (logos), MMX, and Pentium are trademarks of Intel Corporationin the United States, other countries, or both.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks ofMicrosoft Corporation in the United States, other countries, or both.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in theUnited States, other countries, or both.

Linux is a trademark of Linus Torvalds in the United States, other countries, orboth.

UNIX is a registered trademark of The Open Group in the United States and othercountries.

Appendix. Notices and Trademarks 27

Page 38: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

28 IBM Tivoli Netcool/OMNIbus Probe for HP Network Node Manager-i: Reference Guide

Page 39: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network
Page 40: IBM Tivoli Netcool/OMNIbus Probe for HP Network … Probe for HP Network Node Mana ger -i V ersion 2.0 Reference Guide March 10, 2016 ... IBM T ivoli Netcool/OMNIbus Probe for HP Network

IBM®

Printed in USA

SC27-6551-01