IBM Tivoli Netcool/OMNIbus Probe for BMC Patrol: … · · 2018-04-11IBM ®Tivoli Netcool/OMNIbus Probe for BMC Patrol Version 8.0 Reference Guide August 3,2012 SC23-6005-03

IBM® Tivoli® Netcool/OMNIbus Probe for BMC PatrolVersion 8.0

Reference GuideAugust 3, 2012

SC23-6005-03

��

IBM® Tivoli® Netcool/OMNIbus Probe for BMC PatrolVersion 8.0

Reference GuideAugust 3, 2012

SC23-6005-03

��

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

Edition notice

This edition (SC23-6005-03) applies to version 8.0 of IBM Tivoli Netcool/OMNIbus Probe for BMC Patrol and to allsubsequent releases and modifications until otherwise indicated in new editions.

This edition replaces SC23-6005-02.

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

Contents

Document control page . . . . . . . . v

IBM Tivoli Netcool/OMNIbus Probe forBMC Patrol . . . . . . . . . . . . . 1Summary . . . . . . . . . . . . . . . 1Prerequisites for Windows operating systems . . . 2Installing probes . . . . . . . . . . . . . 3Data acquisition . . . . . . . . . . . . . 4

Definition files . . . . . . . . . . . . . 4Running the probe . . . . . . . . . . . 5Error recovery . . . . . . . . . . . . . 5Probe performance . . . . . . . . . . . 5

Peer-to-peer failover functionality . . . . . . 6Properties and command line options . . . . . . 6Utilities supplied with the Probe for BMC Patrol . . 13Elements . . . . . . . . . . . . . . . 15Error messages . . . . . . . . . . . . . 16ProbeWatch messages . . . . . . . . . . . 19BMC Patrol API messages . . . . . . . . . 21

Appendix. Notices and Trademarks . . 23Notices . . . . . . . . . . . . . . . . 23Trademarks . . . . . . . . . . . . . . 25

© Copyright IBM Corp. 2008, 2012 iii

iv IBM Tivoli Netcool/OMNIbus Probe for BMC Patrol: Reference Guide

Document control page

Use this information to track changes between versions of this guide.

The IBM Tivoli Netcool/OMNIbus Probe for BMC Patrol documentation isprovided in softcopy format only. To obtain the most recent version, visit the IBM®

Tivoli® Information Center:

http://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.tivoli.namomnibus.doc/welcome_ptsm.htm

Table 1. Document modification history

Documentversion

Publicationdate

Comments

SC23-6005-01 August 28,2009

First IBM publication.

SC23-6005-02 February 25,2011

“Summary” on page 1 updated.

Support for AIX added.

Installation section replaced by “Installing probes” onpage 3.

“Prerequisites for Windows operating systems” on page 2added.

“Definition files” on page 4 updated.

Note added to “Utilities supplied with the Probe for BMCPatrol” on page 13.

SC23-6005-03 August 3,2012

Support extended to BMC Patrol Agent version 3.9.

“Summary” on page 1 updated.

© Copyright IBM Corp. 2008, 2012 v



vi IBM Tivoli Netcool/OMNIbus Probe for BMC Patrol: Reference Guide

IBM Tivoli Netcool/OMNIbus Probe for BMC Patrol

BMC Patrol is a management system based on agent technology. It comprises aconsole and multiple agents.

Each host to be monitored has a BMC Patrol agent on it, together with the requiredknowledge modules. A knowledge module is a plug-in device to the agent and isused to monitor events. The agents send events to the BMC Patrol API and theconsole collects events from the API. Operators can specify on the console what tomonitor and which thresholds to set. BMC Patrol allows for up to three thresholdranges: normal operation, threshold 1 exceeded, and threshold 2 exceeded.

The Probe for BMC Patrol connects directly to the BMC Patrol agents and uses thePatrol API to acquire event data using the same method as the BMC Patrolconsole.

This guide contains the following sections:v “Summary”v “Prerequisites for Windows operating systems” on page 2v “Installing probes” on page 3v “Data acquisition” on page 4v “Properties and command line options” on page 6v “Elements” on page 15v “Error messages” on page 16v “ProbeWatch messages” on page 19v “BMC Patrol API messages” on page 21

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 BMC Patrol.

Table 2. Summary

Probe target BMC Patrol version 4.3 with BMC Patrol Agent version3.6, 3.7, 3.8, and 3.9

Probe executable name nco_p_patrol (on UNIX and Linux operating systems)

nco_p_patrol.exe (on Windows operating systems)

Package version 8.0

Probe installation package omnibus-arch-probe-nco-p-patrol-version

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

© Copyright IBM Corp. 2008, 2012 1

http://www-01.ibm.com/support/docview.wss?uid=swg21462457

http://www-01.ibm.com/support/docview.wss?uid=swg21462457

Table 2. Summary (continued)

Properties file $OMNIHOME/probes/arch/patrol.props (on UNIX andLinux operating systems)

%OMNIHOME%\probes\win32\patrol.props (on Windowsoperating systems)

Rules file $OMNIHOME/probes/arch/patrol.rules (on UNIX andLinux operating systems)

%OMNIHOME%\probes\win32\patrol.rules (on Windowsoperating systems)

Requirements To run the probe on Windows operating systems, youmust have a BMC Patrol Agent installed on the host onwhich you want to run the probe. See “Prerequisites forWindows operating systems.”For details of anyadditional software that this probe requires, refer to thedescription.txt file that is supplied in its downloadpackage.

Connection method Patrol API

Remote connectivity Available

Licensing Electronic licensing was deprecated with the release ofIBM Tivoli Netcool V7.2.0. All IBM Tivoli NetcoolV7.2.0 (and later) products use the IBM softwarelicensing process.

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 IPv6Note: The probe is supported on IPv6 when runningon IBM Tivoli Netcool/OMNIbus V7.3.0, 7.3.1 and 7.4.0on all UNIX and Linux operating systems. The probe issupported on IPv6 when running on IBM TivoliNetcool/OMNIbus V7.3.0, 7.3.1 and 7.4.0 on Windowsoperating systems.

Federal Information ProcessingStandards (FIPS)

IBM Tivoli Netcool/OMNIbus V7.3.0, 7.3.1 and 7.4.0use the FIPS 140-2 approved cryptographic provider:IBM Crypto for C (ICC) certificate 384 for cryptography.This certificate is listed on the NIST website athttp://csrc.nist.gov/groups/STM/cmvp/documents/140-1/1401val2004.htm For details about configuringNetcool/OMNIbus for FIPS 140-2 mode, see IBM TivoliNetcool/OMNIbus Installation and Deployment Guide.

Prerequisites for Windows operating systemsBefore installing the Probe for BMC Patrol, you must install a BMC Patrol Agenton the host on which you will be running the probe. This is required even if youhave agents installed on other hosts.

Installing an agent on the same host as the probe provides the runtime librariesthat the probe requires to run successfully.

2 IBM Tivoli Netcool/OMNIbus Probe for BMC Patrol: Reference Guide

http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/1401val2004.htm

http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/1401val2004.htm

You can obtain the BMC Patrol Agent installation files from BMC Software, Inc:

http://www.bmc.com/

To install the BMC Patrol Agent, use the following steps:1. Extract the installation files to a temporary directory.2. Run the following command:

temp_path\bmc_products\setup.exe

Where temp_path is the path to the temporary directory.3. On the Select System Roles panel, select Managed System.4. On the Select Products and Components to Install panel, select PATROL

Agent for Microsoft Windows.5. On the Provide the PATROL Default Account Properties panel, specify your

Windows login user name and password.6. Click Next on all other panels to accept the default settings.7. On the last panel, click Finish.

Verifying the %PATH% environment variable

When you install the BMC Patrol Agent, the path to the BMC Patrol Agentinstallation is set in the %PATH% environment variable.

The default location for the agent installation is C:\Program Files\BMCSoftware\Patrol3\bin.

To verify that the %PATH% environment variable has been set correctly, enter thefollowing command at the command prompt:

echo %path%

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 TivoliInformation Center:http://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/probes/install/wip/out-html/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 Information Center:

IBM Tivoli Netcool/OMNIbus Probe for BMC Patrol 3

http://www.bmc.com/

http://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/probes/install/wip/out-html/reference/install_download_intro.html



http://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/probes/install/wip/out-html/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.

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

BMC Patrol comprises a console and multiple agents. The Probe for BMC Patrolconnects directly to the BMC Patrol agents and uses the Patrol API to acquire eventdata using the same method as the BMC Patrol console. The Probe for BMC Patrolcan connect to one or more agents.

The console does not have to be running for events to be received by the probefrom the agents.

Note: Where a firewall is used, the firewall must allow communication betweenthe probe and the agents.

Data acquisition is described in the following topics:v “Definition files”v “Running the probe” on page 5v “Error recovery” on page 5v “Probe performance” on page 5v “Peer-to-peer failover functionality” on page 6

Definition filesThe Probe for BMC Patrol reads the connection information for each agent from adefinition (.def) file, which must be created before you run the probe. Definitionfiles contain rows of agent connection information in the following format:hostname username password port

Where:v hostname is the name of the host on which the agent runsv username is a username to log in to the hostv password is the encrypted password for the username

v port is the port to which you are connecting

You must use the nco_patrol_write utility to add agents to the definitions file. Theutility prompts you for the agent details. See “Utilities supplied with the Probe forBMC Patrol” on page 13.

Note: If an agent specified in the .def file is not available, the probe drops it fromthe list until the next session.





Running the probeWhen the probe is run, it opens a connection to each of the agents specified in thedefinition file and then reads all of the events generated by each agent. If no validconnection details are specified in the definition file, the probe stops. If aconnection is lost, the probe attempts to reconnect to the agent (if the AgentRetriesproperty or -interval command line option is used). For information aboutproperties and command line options, see “Properties and command line options”on page 6.

Every connection event (agent connection opened/lost/retried/closed, etc.) causesthe probe to send both a ProbeWatch event and a normal event with the followingtokens:v $ProbeHost

v $port

v $CauseCode

v $description

v $node

v $severity

.

Error recoveryThe probe recognizes when a BMC Patrol agent loses its connection to the probeand it attempts to reconnect to that agent. The Probe for BMC Patrol caches inmemory the EventID of the last event read from each agent. If the connectionbetween the agent and the probe is lost, the probe is able to request all new eventsfrom the last known EventID.

Additionally, the probe writes the last EventID from each agent to a recovery file.The probe can read this recovery file on startup and request any events that mayhave occurred since the probe last ran. For information about the recoveryproperties, see “Properties and command line options” on page 6.

Probe performanceThe performance of the Probe for BMC Patrol depends on many factors (forexample, the network latency and the number, location, and configuration ofagents). The optimum number of agents configured for each Probe for BMC Patroldepends on these factors.

When the probe starts, it connects to every agent defined in the .def file.Consequently, the time taken for the probe to start depends on the number ofagents in the file. If the time taken to start seems excessive, create two .def filesand share the agents between the two. Then run two probes, each using different.def files.

Note: IBM Software Support recommends having no more than 100 agents in a.def file until implications on probe performance are fully understood for theparticular installation.


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 shuts down, the slave probe stopsreceiving heartbeats from the master and any events it receives thereafter areforwarded to the ObjectServer on behalf of the master probe. When the master isrunning again, the slave continues to receive events, but no longer sends them tothe 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.

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"PeerHost : "slave_hostname"PeerPort : 5555 # [communication port between master and slave probe]Mode : "master"

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"

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 default properties and command line options, seethe IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide, (SC14-7608).

Table 3. Properties and command line options

Property name Command line arguments Description

AgentHeartbeat integer -heartbeat integer Use this property to specify thetime (in milliseconds) that theprobe waits to send a connectionheartbeat.

The default is 5000.


Table 3. Properties and command line options (continued)


AgentProtocol string -protocol string Use this property to specify theprotocol used by the probe tocommunicate with the agent. Thisproperty takes the followingvalues:

UDP: The UDP protocol is used tocommunicate with the agent.

TCP: The TCP protocol is used tocommunicate with the agent.

The default is UDP.

AgentReport integer -agentreport (This isequivalent to AgentReportwith a value of 1.)

Use this property to specifywhether or not the reporting ofagent connections is enabled. Thisproperty takes the followingvalues:

0: The reporting of agentconnections is disabled.

1: The reporting of agentconnections is enabled.

The default is 0.

When reporting is enabled, theprobe counts the number of agentconnections that are dead,pending, open, or closed andsends a report as a ProbeWatchmessage. The probe also pingseach agent that it is connected to.

The BMC Patrol agents send oneof the following responses:

v OK

v WARN

v ALARM

v OFFLINE

v VOID

v timeout

If timeout is returned, the agentdid not respond within the periodspecified in theAgentStatusTimeout property andthe probe assumes that theconnection is dead and needs tobe reestablished.




AgentReportCheck integer -agentreportcheck integer When AgentReport is enabled, thisproperty specifies the number ofmilliseconds between checking thenumber of agent connections thatare dead, pending, open, orclosed.


AgentRetries integer -retries integer Use this property to specify thenumber of times the probeattempts to retry connecting. Thisproperty takes the followingvalues:

0 (There is no limit on the numberof attempts that the probe makes.)

2 through 10.

The default is 4.

Note: You cannot set this propertyto 1.

AgentStatusTimeoutinteger

-pingtimeout integer Use this property to specify themaximum time (in milliseconds)that the probe waits for an agentto respond with a connectionstatus message. This should bequite small as the probe must waitthis amount of time to determinewhether a connection is dead.


AgentTimeout integer -agenttimeout integer Use this property to specify thecommunication connectiontimeout in milliseconds.


ConnectedOnLogin integer -connectedonlogin (This isequivalent toConnectedOnLogin with avalue of 1.)

Use this property to specifywhether or not the probe sendsthe Agent Connected messagewhen the probe receives the UserLogged In message from thatagent.

The default is 0.

ConnectionCheck integer -connectioncheck integer Use this property to specify theinterval (in milliseconds) betweensuccessive checks of the probe'sagent connections. When theconnection has been retried thenumber of times specified by theRetryInterval property, the probeissues a new connection request.





DefFileInterval integer -deffileinterval integer Use this property to specify thetime (in milliseconds) that theprobe waits between checking theBMC Patrol definitions file forchanges. If the probe detects thatthe file has been altered, it reloadsthis file and then opens or closesagent connections, as necessary.


DisablePatrolPing integer -disablepatrolpinginteger

Use this property to specifywhether or not the probe pingsthe hosts. This property takes thefollowing values:

0: The probe pings the hosts.

1: The probe does not ping thehosts.

The default is 0.

ExtraDebug integer -extradebug (This isequivalent to ExtraDebugwith a value of 1.)

When this property is set to 1, theprobe logs extra information to themessage log file. This extradebugging information shows thestatus of each agent connectionand the number of cycles beforethe probe attempts to reconnect.

The default is 0.

IgnorePasswordFailuresinteger

-ignorefailures (This isequivalent toIgnorePasswordFailureswith a value of 1.)

When this property is set to 1, theprobe ignores the error messagesreturned when the connection toan agent has failed due tousername/password problems.This causes the probe to retry theconnection to the agent (instead ofignoring that agent). The probepicks up any username/passwordchanges each time it checks thepatrol.def file (as defined by theDefFileInterval).

The default is 0.

InactivityTimeout integer -inactivitytimeoutinteger

Use this property to specify thetime (in seconds) that the probeallows an agent to be inactivebefore disconnecting from theagent and reopening theconnection. This prompts theagent to send new alarms to theprobe.


Note: The minimum value for thisproperty is 300 seconds.




LocalPort integer -localport integer Use this property to specify thelocal port number to communicatewith a BMC Patrol agent across afirewall.

The default is 0.

MaxPingTimeouts integer -maxpingtimeouts integer Use this property to specify thenumber of consecutive timed-outping responses that the probeallows before it attempts toreconnect to the agent.

The default is 0.

PatrolDef string -def string Use this property to specify thename of the file that contains thedefinitions of all agents to whichthe probe connects.

The default is$OMNIHOME/probes/arch/patrol.def.

RecoveryFileName string -recoveryfile string Use this property to specify thefile to which recovery data iswritten. The recovery data isstored in an ASCII format as asequence of ipnumber-EventID:pairs.

The default is$OMNIHOME/probes/arch/patrol.reco.

RecoveryInterval integer -recoveryinterval integer Use this property to specify theinterval (in milliseconds) betweensuccessive recovery file writes.Depending on the number ofagents that the probe is connectedto, raise or lower this value so thatwriting the recovery data does notaffect the performance of theprobe.


RecoveryMaxEvents integer -recoverymax integer Use this property to specify themaximum number of events sentby an agent in response to arecovery query. When the probe isrecovering from a previoussession, it requests that no morethan the maximum number ofevents are sent to it per agent.





RecoveryMode integer -recoverymode integer Use this property to specify howthe probe recovers if theconnection between the agent andthe probe is lost. This propertytakes the following values:

0: NORMAL recovery mode. Theprobe does not read the recoveryfile on startup, but immediatelybegins listening for new eventsfrom the agents.

1: RECOVERY mode. Forces theprobe to read the recovery file andsend requests to agents for eventsthat may have occurred since thelast event was received.

You can use theRecoveryStatusMaskFilter andRecoveryTypeMaskFilterproperties in conjunction with thismode.

2: RESYNCH mode. The probeignores the recovery file on startup, but requests events from allagents that match the settingsindicated in theRecoveryStatusMaskFilter andRecoveryTypeMaskFilterproperties, regardless of whenthey were received.

The default filter properties selectALL events. Using these inRESYNCH mode requests ALL eventsfrom the agent, which may not beadvisable.

The default is 0.

RecoveryStatusMaskFilter string

-recoverystatusmaskstring

This property works in exactly thesame way as StatusMaskFilter;however, it only applies to thequery sent to agents whenrecovering from a previous sessionor when resynchronizing inRESYNCH mode. See theStatusMaskFilter property in thistable for valid values and thedefault setting.

When in RESYNCH mode, set therecovery filters to request onlyactive alarms from the agents. Seethe RecoveryMode property in thistable for more information.

The default is O,A,E,C,D.




RecoveryTypeMask string -recoverytypemask string This property works in exactly thesame way as TypeMaskFilter;however, it only applies to thequery sent to agents whenrecovering from a previous sessionor when resynchronizing inRESYNCH mode. See theTypeMaskFilter property in thistable for valid values and thedefault setting.

When in RESYNCH mode, set therecovery filters to request onlyactive alarms from the agents. Seethe RecoveryMode property in thistable for more information.

The default is I,S,E,W,A,R.

ResynchCheck integer -resynchcheck integer Use this property to specify theinterval (in milliseconds) withwhich the probe checks whether aresynch request needs to be sentto one of the agents. It is onlypossible to send one request at atime, so this interval allows theprobe to send resynch requests tothe agents sequentially.


RetryInterval integer -interval integer Use this property to specify thenumber of ConnectionCheckintervals for which the probewaits before retrying a connectionto an agent.

The default is 3.

StatusMaskFilter string -statusmask string Use this property to specify thestatus mask filter that the probeuses to select events. For thisproperty you must specify a stringcontaining one or more status tagsseparated by commas. Thisproperty takes the followingvalues:

O: open

A: acknowledged

C: closed

E: escalated

D: deleted

The default is O,A,C,E,D (thisselects events of any status).




TypeMaskFilter string -typemask string Use this property to specify thetype mask filter that the probeuses to select events. For thisproperty you must specify a stringcontaining one or more event typetags separated by commas. Thisproperty takes the followingvalues:

I: information

S: state change

E: error

W: warning

A: alarm

R: response

The default is I,S,E,W,A,R (thisselects events of any type).

Utilities supplied with the Probe for BMC PatrolUtilities are provided for adding agents to a definition file or removing existingagents from a definition file. These are simpler to use than editing the definitionfile and also prevent syntax errors.

The Probe for BMC Patrol is supplied with the following command line utilities:v nco_patrol_encrypt

v nco_patrol_connections

v nco_patrol_ping

v nco_patrol_remove

v nco_patrol_write

The following table describes the utilities specific to this probe. For informationabout generic utilities, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide,(SC14-7608).


Table 4. Utilities

Utility name Command line arguments Description

nco_patrol_encrypt N/A This utility encrypts a passwordinto the BMC Patrol format. Theutility prompts you for apassword, then asks forconfirmation.

Note: The encrypted password isfor use in the BMC Patroldefinition file. However, theencryption only works for a singleentry of a single target host inBMC Patrol definition file. Formultiple entries of a single targethost (that is, a single target hostbut with multiple BMC Patrolagents), use nco_patrol_write.

To create an encrypted password,run the following command:

$OMNIHOME/probes/arch/nco_patrol_encrypt

The utility prompts you to enterand verify a password and thendisplays the password inencrypted format. This is thepassword that you use in thedefinition file.

nco_patrol_ connections filename timeout (optional) This utility sends a BMC Patrolping to each agent listed in theBMC Patrol definition file. Theoptional timeout is the time (inmilliseconds) that the probe waitsfor a response before moving tothe next agent.

nco_patrol_ping ping (optional) This utility sends a BMC Patrolping to an agent on the specifiedhost and port number. Theoptional timeout is the time (inmilliseconds) that the probe waitsfor a response.Note: As the default protocol ofthis utility is UDP, the firewallconfigurations can affect thefunction of this utility.

nco_patrol_remove filenamehostnameportnumber

This utility removes the agent onthe host and port from thespecified BMC Patrol definitionfile.


Table 4. Utilities (continued)

Utility name Command line arguments Description

nco_patrol_write filename This utility adds an agent to thespecified BMC Patrol definitionfile. When the command isexecuted, you are prompted forthe agent details.

Note: If the nco_patrol_writeutility fails to add an agent to thedefinition file, you can itmanually, encrypting thepassword using thenco_patrol_encrypt utility. Whenuisng nco_patrol_encrypt,encryption only works for a singleentry of a single target host inBMC Patrol definition file.

Note: All connection messages for the utilities are written to stdout; the messagelevel cannot be set.

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 BMC Patrolgenerates. Not all the elements described are generated for each event; theelements that the probe generates depends upon the event type.

Table 5. Elements

Element name Element description

$args This element displays a list of arguments fromthe event received from the BMC Patrol agent.

$catalog This element displays the event catalog name.

$class This element displays the class name of the event.

$description This element displays the description of theevent.

$diary This element contains the BMC Patrol event diaryentry. This contains information added by usersto annotate, clarify, or further describe the event.

$eventId This element displays the event identifier. EventIDs are assigned sequentially by the BMC PatrolEvent Manager as events are generated.

$expectancy This element displays the life expectancy of theevent. Typical values are: STORED, DEL_IF_CLOSED,DEL_IF_INFO, and DO_NOT_STORE.

$extdesc This element contains an extended description ofthe event.

$fqhostname This element displays the fully qualified domainname (FQDN) of the agent host.


Table 5. Elements (continued)

Element name Element description

$handler This element displays the User ID of the lastperson to modify the event's diary, or of the lastperson to perform an ACKNOWLEDGE, CLOSE, orDELETE action on the event.

$ipaddr This element contains the IP address of theconnected agent.

$node This element displays the host name of the nodethat generated the event.

$origin This element displays the BMC Patrol applicationname of the source of the event.

$owner This element displays the User ID of the ownerof the event. The user ID is usually a useraccount.

$port This element displays the port number of thehost where the agent is connected.

$severity This element displays the event severity. This canbe an integer in the range 1 to 5, where 5 is thehighest severity.

$sourceId This element contains a source identifier of theevent.

$status This element displays the status of the event:

1: open

2: acknowledged

3: closed

4: escalated

5: deleted

$type This element displays the type of the event:

1: information

2: state change

3: error

4: warning

5: alarm

6: response

Note: If the probe fails to connect to an agent or if a connection with an agent islost, the probe forwards an error event to the ObjectServer. This event comprisesthe $node, $description, and $security elements. For details about these messages,see “ProbeWatch messages” on page 19.

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, (SC14-7608).

Table 6. Error messages

Error Description Action

All agent connections aredead - aborting

The connections to agentshave ceased (and store andforward is not enabled in theprobe).

Check that the BMC Patrolsystem is available.

Failed to create/set:token name

The probe is unable to createan element.

Contact IBM SoftwareSupport.

Failed to install SIGUSR1handler

The probe was unable toinstall a signal handler foreither a QUIT, INT or TERM. Theprobe will try to continue,however any further signalhandling will result in anerror on exit.


Failed to parse host nameon line host name

Failed to parse passwordon line password

Failed to parse port online line number

Failed to parse usernameon line username

The probe was unable toparse the data specified.


Failed to perform initialstat of PatrolDefFile!

The probe was unable toperform the initial stat on thepatrol.def file.

Check that the file exists andthat the permissions arecorrect.

Failed to processarguments

Internal error. Contact IBM SoftwareSupport.

FAILED TO RECOVER The recovery file could not befound or could not beaccessed and so the tailingbegins from the current linevalue.

Check that theRecoveryFileName property isset correctly and that the userrunning the probe has readand write permissions overthe file.

Failed to send alert The probe was unable to sendan alert (usually an internalalert) to the ObjectServer.

Check that the ObjectServer isavailable.

Failed to setFirstOccurrence

Failed to setLastOccurrence

Some application has affectedthe operation of the probe.

Rerun the probe.

Failed to statPatrolDefFile

Failed to perform initialstat of PatrolDefFile

The probe cannot obtain thestatus of the file specified.

Check that the file exists andthat the permissions are setcorrectly.


Table 6. Error messages (continued)


Failed to statPatrolDefFile!

The probe was unable toperform a stat on thepatrol.def file.

Check that the file exists andthat the permissions arecorrect.

gethostbyaddr(): failedto find host host name

gethostbyname(): failedto find agent host hostname

Hostname resolutionproblems

The probe was unable to logon to the host.

Check that the properties areset correctly.

gethostbyaddr(): failedto find host hostname

The probe was unable to findthe host specified in thepatrol.def file.

Check that the specified hostis running and reachable.

gethostbyname(): failedto find host HostName

The probe was unable to findthe host specified in thepatrol.def file.

Check that the specified hostis running and reachable.

Incomplete final line inline number

A line from the alert file is notin the correct format.

Check that the BMC Patrol isrunning correctly.

Invalid port on line

Patrol Agent host isunreachable

There is a problem with yourmachine, the network, or theprobe configuration.

Check that there are noproblems with your networkand that you configured thecorrect port number in theprobe properties file.

Memory problems

Out of memory

A memory allocation problemoccurred.

Make more memory available.

No agents configured inPatrol Def file

No patrol agentsconfigured - aborting

Patrol Def file errors

The BMC Patrol definition filedoes not contain the agentdetails.

Add the agent details in theBMC Patrol definition file.


The agents have not beenconfigured or have beenincorrectly configured.

Check that the definition fileexists and that the agents towhich the probe connectshave been correctlyconfigured.


There are no BMC PatrolAgents defined in thepatrol.def file.

Add some BMC Patrol Agentsto your patrol.def file.

Patrol API problems Internal errors. Contact IBM SoftwareSupport.

Probe has been givenUnknown RecoveryModeRecovery Mode Value.Defaulting to NORMAL MODE

Unknown RecoveryModeRecovery Mode Value.Defaulting to NORMAL MODE

As the given value for theRecoveryMode property isincorrect, the probe revertsback to the NORMAL mode.

Correct the RecoveryModevalue in the properties file.


Table 6. Error messages (continued)


PropertyName is greaterthan the maximum

PropertyValue of NumberMilliseconds - usingmaximum

The property specified in theproperties file or at thecommand line is greater thanthe maximum permitted. Themaximum permitted value isused.

Correct the entry in theproperties file.

PropertyName is less thanthe minimum PropertyValueof Number Milliseconds -using minimum

The property specified in theproperties file or at thecommand line is lower thanthe minimum permitted. Theminimum permitted value isused.

Correct the entry in theproperties file.

Rules processing failed:errordescription

There is an error in the rulesfile format or syntax.

Check the rules file andcorrect the problem.

Session create failed –aborting

Internal errors. Contact IBM SoftwareSupport.

The number of agents isgreater than therecommended absolutemaximum of maximum limit

Too many agentsconfigured in Patrol Deffile

The number of agentsspecified in the BMC Patroldefinition file is more than thedefault limit.

Reduce the number of agentsin the BMC Patrol definitionfile to the limit shown in theerror message.

Unable to ping Host:HostName Port: PortValueResponded With:errordescription

The probe lost its connectionto the server.

Check that the BMC Patrol isrunning correctly on thesocket shown in the errormessage.

Unable to read recoveryfile: filename

Unable to write recoveryfile: filename

The probe cannot open, read,or reset the recovery file.

Check that the file exists andthat the permissions are setcorrectly.

ProbeWatch messagesDuring normal operations, the probe generates ProbeWatch messages and sendsthem to the ObjectServer. These messages tell the ObjectServer how the probe isrunning.

The following table describes the raw ProbeWatch error messages that the probegenerates. For information about generic ProbeWatch messages, see the IBM TivoliNetcool/OMNIbus Probe and Gateway Guide, (SC14-7608).

Table 7. ProbeWatch messages

ProbeWatch message Description Triggers/causes

Agent on host Hostnamehas exceeded theInactivityTimeout periodof seconds seconds

The agent on the specifiedhost has exceeded thespecified inactivity timeoutperiod.

The connection between theagent on the specified hostand the probe has beeninactive.

All agent connections aredead - abortintg

This is an information onlymessage.

There are no live connections.


Table 7. ProbeWatch messages (continued)


Closed connection toPatrolAgent on host host,port port due tousername/passwordproblems. This agent willNOT be contacted again.

The user name and passwordsupplied were not valid forthe host.

Check the user name andpassword details and ensurethat they are valid for thehost.

Closed Connection toPatrolAgent on HostHostname, Port Portnumberdue to username/passwordproblems. This agent willNOT be contacted again.

There was a username/password mismatch, orthe username used is notpermitted to log in to thespecified host.

Check that the user name andpassword have been enteredcorrectly. Also, ensure that thepermissions on the specifiedhost permit the user to log in.

Closed connection toPatrolAgent on hostHostname, portPortnumber. Failed toconnect Number times.This agent will NOT becontacted again.

The probe could not contactthe specified host.

Check that the specified hostis running and can bereached.

Connection report: Numberpending, Number open,Number closed, Numberdead

This is an informationmessage that gives a reporton the number of connections.

No action required.

Connection request toAgent on host Hostnamehas exceeded theAgentTimeout period ofTimeoutPeriodmilliseconds!

The probe exceeded the setwaiting period for connectionto the agent.

The host is not running or isunreachable.

Connection to thePatrolAgent on host host,port host closed, nolonger required.

The probe was connected tothe specified host, but when itread the patrol.def file, theagent was not found and theconnection was closed.

Check the reference to theagent in the patrol.def file.

Connection to thePatrolAgent on HostHostname, port Portnumberclosed, no longerrequired.

This is an informationmessage. The probe hasdisconnected from an agent.

This message can be used tocorrelate the connection stateof all BMC Patrol agentsmonitored by one or moreprobes.

Connection to thePatrolAgent on hostHostname, port Portnumberfailed. Will retry inNumber timer ticks.(Number tries left).

There is a problem connectingto the specified host.

Check that the specified hostis running and can bereached.

Host: Hostname Port:Portnumber RespondedWith: String.

This message is sent when theprobe tests a connection. Thefinal string originates fromBMC Patrol. It may be one ofthe following: OK, WARN, ALARM,OFFLINE, VOID, or timeout.Consult your BMC Patroldocumentation for furtherinformation.

This message can be used tocorrelate the connection stateof all BMC Patrol agentsmonitored by one or moreprobes.


Table 7. ProbeWatch messages (continued)


Unable to read recoveryfile. CANNOTRECOVER!Unable to writerecovery file. This maycause data loss betweentwo restarts of theprobe.

The probe could not read therecovery file.

The recovery file is corrupt orit has wrong permissionsettings or an incorrect valueis set in the properties file.

BMC Patrol API messagesThe following table describes the API messages specific to this probe. Forinformation about generic API messages, see the IBM Tivoli Netcool/OMNIbus Probeand Gateway Guide, (SC14-7608).

Table 8. Properties and command line options

Property name Command line option Description

BMC: Message The message comesdirectly from the BMCPatrol API.

Refer to the BMC Patroldocumentation for information.

Unknown message fromPEM: Message

The message comesdirectly from the BMCPatrol API, but was notclassified INFO, WARN, orERROR.

Refer to the BMC Patroldocumentation for information.



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. 2008, 2012 23

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.


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. inthe United 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 25


��

Printed in USA

SC23-6005-03

Documents

IBM Tivoli Netcool/OMNIbus Probe for BMC Patrol: … · · 2018-04-11IBM ®Tivoli Netcool/OMNIbus Probe for BMC Patrol Version 8.0 Reference Guide August 3,2012 SC23-6005-03