netcool/omnibus probe foralcatel-lucent 5529 oss alarm ... · retrieval of real-time and stored...

Netcool/OMNIbus Probe for Alcatel-Lucent 5529 OSSAlarm Dispatcher (OAD) V5.1Version 1.0

Reference GuideSeptember 11, 2014

SC23-9107-07

��

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

Edition notice

This edition (SC23-9107-07) applies to version 1.0 of Probe for Alcatel-Lucent 5529 OAD and to all subsequentreleases and modifications until otherwise indicated in new editions.

This edition replaces SC23-9107-06.

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

Contents

Document control page . . . . . . . . vAbout this guide . . . . . . . . . . . . vii

Conventions used in this guide . . . . . . vii

IBM Tivoli Netcool/OMNIbus Probe forAlcatel-Lucent 5529 OSS AlarmDispatcher (OAD). . . . . . . . . . . 1Summary . . . . . . . . . . . . . . . 1Installing probes . . . . . . . . . . . . . 2Configuring the probe . . . . . . . . . . . 3

Obtaining the probe-nonnative patch . . . . . 3Java files. . . . . . . . . . . . . . . 4Additional considerations . . . . . . . . . 4

Data acquisition . . . . . . . . . . . . . 4Peer-to-peer failover functionality . . . . . . 5

Using HTTP or HTTPS protocol . . . . . . . 6Java Messaging Service . . . . . . . . . . 7Using durable subscriptions . . . . . . . . 7Disabling durable subscriptions . . . . . . . 7Java Messaging Service filter . . . . . . . . 8Inactivity . . . . . . . . . . . . . . 8Command line interface . . . . . . . . . 8

Properties and command line options . . . . . . 9Elements . . . . . . . . . . . . . . . 15Error messages . . . . . . . . . . . . . 18ProbeWatch messages . . . . . . . . . . . 19

Appendix. Notices and Trademarks . . 21Notices . . . . . . . . . . . . . . . . 21Trademarks . . . . . . . . . . . . . . 23

© Copyright IBM Corp. 2006, 2014 iii

iv IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5529 OAD V5.1: Reference Guide

Document control page

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

The Probe for Alcatel-Lucent 5529 OAD documentation is provided in softcopyformat only. To obtain the most recent version, visit the IBM® Tivoli® InformationCenter:

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

Table 1. Document modification history

Documentversion

Publicationdate

Comments

SC23-9107-01 December 31,2008

First IBM publication.

SC23-9107-02 June 20, 2009 Support for Alcatel-Lucent 5529 OAD version 5.1 added.

“Summary” on page 1 updated.

“Configuring the probe” on page 3 added.

Section added to discuss performing partialresynchronization by specifying filtering properties. See“Resynchronizing alarms” on page 6.

Support for the acknowledge_alarm command added. See“Command line interface” on page 8.

Descriptions for the following properties added to“Properties and command line options” on page 9:

v AcknowledgeFilter

v AlarmRetrievalMgrURL

v AlarmRetrievalMgrExtURL

v DiscoveryGroup

v ClusterURL

v PartitionName

v ProbableCauseFilter

v ScopeFilter

© Copyright IBM Corp. 2006, 2014 v



Table 1. Document modification history (continued)

Documentversion

Publicationdate

Comments

SC23-9107-03 June 4, 2010 Support for Alcatel-Lucent 5529 OAD version 6.0 added.

List of required JBoss libraries updated in “Java files” onpage 4.

Descriptions for the following properties added to“Properties and command line options” on page 9:

v InventoryRetrievalMgrExtnsURL

v MaxSameSingletonRetryTime

v OS.Host

v OS.Port

v RetryWait

Descriptions for the following properties updatedin“Properties and command line options” on page 9:

v AlarmRetrievalMgrExtURL

v AlarmRetrievalMgrURL

v AlarmsBatchSize

v CleanupPersistentJmsId

v HttpPort

v PersistentJmsId

v UseSsl

SC23-9107-04 December 31,2010

“Summary” on page 1 updated.

Installation section replaced by “Installing probes” onpage 2.

Resynchronization configuration information corrected in“Resynchronizing alarms” on page 6.

Descriptions for the OS.Password and OS.UserNameproperties added to “Properties and command lineoptions” on page 9.

SC23-9107-05 October 28,2011

Summary details updated.

Descriptions for the OS.Password and OS.UserNameproperties updated, and description for the ResyncSQLCmdproperty added to “Properties and command lineoptions” on page 9.

SC23-9107-06 March 2, 2012 References to Alcatel-Lucent 5529 OAD version V6.0removed from this guide.

SC23-9107-07 September 11,2014

Suport for Alcatel-Lucent 5529 OAD versions R4.0 andR5.0 withdrawn.

Note: The Probe for Alcatel-Lucent 5529 OAD V6 is now documented in the Probefor Alcatel-Lucent 5529 OAD V6 reference guide.

vi IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5529 OAD V5.1: Reference Guide

About this guideThe following sections contain important information about using this guide.

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 systemcurrently supported by Netcool/OMNIbus.

Table 2. Directory names for the arch variable

Operating system Directory name represented by arch

AIX® systems aix5

HP-UX PA-RISC-based systems hpux11

HP-UX Integrity-based systems hpux11hpia

Document control page vii

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

viii IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5529 OAD V5.1: Reference Guide

IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5529OSS Alarm Dispatcher (OAD)

The Alcatel-Lucent 5529 OSS Alarm Dispatcher (OAD) collects alarms frommultiple Alcatel-Lucent Element Management Systems (EMS), and sends them tomultiple client Operational Support Systems (OSS) using SOAP/XML requests. Therequests pass through the Multi-Technology Operations System Interface (MTOSI).

The Alcatel 5529 OAD permits the subscription and filtering mechanism forretrieval of real-time and stored alarms.

The Probe for Alcatel-Lucent 5529 OAD connects to the Alcatel 5529 OAD systemwith the MTOSI/JMS standard interface, and formats the received alarms using theMTOSI 1.1 standard.

This guide contains the following sections:v “Summary”v “Installing probes” on page 2v “Configuring the probe” on page 3v “Data acquisition” on page 4v “Properties and command line options” on page 9v “Elements” on page 15v “Error messages” on page 18v “ProbeWatch messages” on page 19

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 Alcatel-Lucent 5529OAD.

Table 3. Summary

Probe target Alcatel 5529 OAD version 5.1

Probe executable names nco_p_alcatel_5529_oad_5_1

Probe installation packages omnibus-arch-probe-nco-p-alcatel-5529-oad-5-1-1_0

Probe supported onFor details of supported operating systems, see thefollowing Release Notices on the IBM Software SupportWebsite:

https://www-304.ibm.com/support/docview.wss?uid=swg21412196

Properties files $OMNIHOME/probes/arch/alcatel_5529_oad_5_1.props

Rules files $OMNIHOME/probes/arch/alcatel_5529_oad_5_1.rules

© Copyright IBM Corp. 2006, 2014 1



Table 3. Summary (continued)

Requirements A currently supported version of IBM TivoliNetcool/OMNIbus

probe-nonnative-base-7_0

probe-command-port-2_0

Java 1.6Note: Java patches are no longer supplied with IBMTivoli Netcool/OMNIbus.

Several Java files (available from Alcatel-Lucent) arerequired by the probe . For a full list of the requiredfiles, see “Java files” on page 4.

Connection method HTTP/HTTPS and JMS

Remote connectivity The Probe for Alcatel-Lucent 5529 OAD can connect toa device on a remote host. Details of the remote hostare specified using the HttpHost and HttpPortproperties in the properties file.

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

The probe is supported on IPv6 when running on IBMTivoli Netcool/OMNIbus V7.3.0, 7.3.1 and 7.4.0.

Federal Information ProcessingStandards (FIPS)

IBM Tivoli Netcool/OMNIbus V7.3.0, 7.3.1 and 7.4.0 usethe FIPS 140-2 approved cryptographic provider: IBMCrypto for C (ICC) certificate 384 for cryptography. Thiscertificate 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.

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 IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5529 OAD V5.1: 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

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

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.

Configuring the probeAfter installing the probe, you need to make various configuration settings to suityour environment.

This section contains topics on the Alcatel-Lucent 5529 OAD configurationrequirements:v “Obtaining the probe-nonnative patch”v “Java files” on page 4v “Additional considerations” on page 4

Obtaining the probe-nonnative patchAs well as the basic patch, you must also download the probe-nonnative-7_0patch.

To obtain the probe-nonnative-7_0 patch:1. Access the Passport Advantage website: http://www-306.ibm.com/software/

howtobuy/passportadvantage/2. Select Software Downloads.3. Perform a text search on nonnative.4. Select Expand All to see all search results.5. Select the patch that corresponds to your hardware platform.

IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5529 OSS Alarm Dispatcher (OAD) 3

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

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

http://www-306.ibm.com/software/howtobuy/passportadvantage/

http://www-306.ibm.com/software/howtobuy/passportadvantage/

Java filesAs a part of the configuration process, you must copy various Java files to the javafolder in your Netcool/OMNIbus installation and include their path in your$CLASSPATH environment variable.

The following JBoss libraries are required by the OAD 5.1 version of the probe:v axs-mobject-remote-api.jar

v concurrent.jar

v bossall-client.jar

v jboss-client.jar

v jboss-common-client.jar

v jbossha-client.jar

v jbossmq-client.jar

v jbosssx-client.jar

v jboss-system-client.jar

v jnp-client.jar

v log4j.jar

These files are available from Alcatel-Lucent. They form a part of the serverinstallation and must be copied to the following location:

$OMNIHOME/probes/java

You must also include this path in the $CLASSPATH environment variable.

Additional considerationsOAD can only function with security enabled for JMS Notifications. The probecannot allow security to be enabled for JMS Notifications and disabled for WebServices interface at the same time. Therefore, both JMS Notification and the WebServices interface must have security enabled.

When OAD is installed in a cluster, the notification identifiers assigned by oneAMS do not follow those assigned by another AMS. Since Netcool/OMNIbus usesthe notification identifier to correlate some alarms in the EventList, if the activityhas switched from one OAD to another in the cluster, the EventList can potentiallycorrelate unrelated alarms since their notification identifiers match.

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 Alcatel-Lucent 5529 OAD connects to the Alcatel 5529 OAD systemusing the HTTP or HTTPS protocol. The probe subscribes to the JMS topic toretrieve new alarms as they are generated. It then sends a resynchronizationrequest by calling the MTOSI getActiveAlarms functions.

Data acquisition is described in the following topics:v “Peer-to-peer failover functionality” on page 5v “Using HTTP or HTTPS protocol” on page 6v “Java Messaging Service” on page 7


v “Using durable subscriptions” on page 7v “Disabling durable subscriptions” on page 7v “Java Messaging Service filter” on page 8v “Inactivity” on page 8v “Command line interface” on page 8

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"


Using HTTP or HTTPS protocolThe probe builds an HTTP or HTTPS URL connection to the Alcatel-Lucent 5529OAD system using the host and port values specified by the HttpHost andHttpPort properties. The probe then starts resynchronizing alarms in theAlcatel-Lucent 5529 OAD system.

Using the HTTP protocolThe probe connects to an HTTP port and sends a SOAP/XML request using thehost and its port values specified by the HttpHost and HttpPort properties.

Using the HTTPS protocolThe Probe for Alcatel-Lucent 5529 OAD uses Java keystore files and an HTTPSURL Connection to connect directly to the system using the HTTPS protocol.

For the probe to connect to the system in HTTPS mode, enable the SSL connectionusing the UseSsl property. To access the keys and certificates in the Java keystorefile required for this HTTPS connection, specify the CertificateStore and theCertificateStorePassword properties. To attest the certificates in the Java keystore,add the trusted authority certificate using the TrustedStore andTrustedStorePassword properties.

Note: If a single keystore file contains all the certificates, then set theCertificateStore and TrustedStore properties to point the same keystore file; andset the CertificateStorePassword and TrustedStorePassword properties with samevalue.

Resynchronizing alarmsThe Probe for Alcatel-Lucent 5529 OAD resynchronizes with OAD by sending aSOAP/XML request. To specify that the probe performs a resynchronization, setthe Resync property to true. The probe receives a list of all active alarms from theAlcatel 5529 OAD system.

To set the number of alarms that the probe can resynchronize in one connection,use the AlarmsBatchSize property. If the number of active alarms in the Alcatel5529 OAD system exceeds the specified value, the probe resynchronizes once againuntil it receives all the remaining alarms from the Alcatel 5529 OAD system.

Performing partial resynchronizationIf you are using OAD 5.1 and above, you can perform a partial resynchronizationby limiting which alarms are retrieved using the following filtering properties:v AcknowledgeFilter: This property allows you to select alarms by their

acknowledgement state.v PerceivedSeverityFilter: This property allows you to select alarms by their

perceived severity.v ProbableCauseFilter: This property allows you to select alarms by their

probable cause.v ScopeFilter: This property allows you to select alarms by the device that

generated them.


Java Messaging ServiceJava Messaging Service (JMS ) is a set of interfaces and associated semantics thatdefine how the probe accesses the Alcatel-Lucent 5529 OAD system. The JMS topicis a JMS-managed object that distributes the messages between the probe and theAlcatel-Lucent 5529 OAD system.

Connecting to JMSThe Probe for Alcatel-Lucent 5529 OAD retrieves events by connecting directly toJava Messaging Service (JMS ) as follows:1. The probe connects to JMS running on the Alcatel-Lucent 5529 OAD server.2. The JMS sends asynchronous events to the probe.3. The probe parses these events and sends them to the ObjectServer.

Subscribing to a JMS topicOn connection with the Alcatel-Lucent 5529 OAD system, the Probe forAlcatel-Lucent 5529 OAD uses the values specified by the Username and Passwordproperties for authentication, and creates a topic connection.

Note: You can send only one command for each URL connection. After thecreation of a topic connection, the Probe for Alcatel-Lucent 5529 OAD subscribesover the MTOSI interface to the topic specified by the Topic property.

After each subscription, if resynchronization is enabled, the Probe forAlcatel-Lucent 5529 OAD attempts to retrieve all current active alarms from theAlcatel-Lucent 5529 OAD system.

Using durable subscriptionsWhen the Probe for Alcatel-Lucent 5529 OAD is running in durable subscriptionmode, the JMS stores messages published on the specified topic while thesubscriber is not active or disconnected from the JMS. The Probe for Alcatel-Lucent5529 OAD creates a subscriber with durable subscription using the value specifiedby the PersistentJmsId property. When the probe reconnects with the samesubscriber value, the JMS sends the stored events.

Disabling durable subscriptionsTo disable the durable subscription mode, do not specify a value for thePersistentJmsId property; setting the value of the CleanupPersistentJmsIdproperty to true makes the Probe for Alcatel-Lucent 5529 OAD unsubscribe fromthe JMS topic when shutting down.

Note: The probe removes the stored messages once the subscriber receives them,or when they expire, or when the durable subscription is deleted.


Java Messaging Service filterThe probe subscription filters events in a JMS topic using the filter specified by theJmsFilter property.

InactivityThe Probe for Alcatel-Lucent 5529 OAD has a timeout facility that allows it todisconnect from the JMS topic if it fails to receive the next alarm data within apredefined amount of time. You can specify how long the probe waits beforedisconnecting, using the Inactivity property. After this length of time, the probedisconnects from the switch, sends a ProbeWatch message to the ObjectServer, andtries to reconnect. To disable probe reconnection, set the Retry property to false.

Command line interfaceThe Probe for Alcatel-Lucent 5529 OAD is supplied with a command line interface(CLI). This interface allows you to perform commands using the probe (forexample, to acknowledge alarms or to request a full resynchronization of the JMSinterface). To use the CLI, you must use the CommandPort property in the propertiesfile to specify a port through which commands will be sent. When you want toperform commands, telnet to this port.

The following table describes the commands that you can use with the commandline interface.

Table 4. CLI commands

Command Description

acknowledge_alarm alarmid1 alarmid2 ...alarmidn

This command allows you to send a requestto the OAD server to acknowledge the list ofalarms accompanying the command.

get_active_alarms This command allows you to get all activealarms in the MTOSI interface.

get_active_alarms_count This command displays the number ofactive alarms in the Alcatel-Lucent 5529OAD system.

help This command displays online help aboutthe CLI.

version This command displays the version of theprobe.

Note: As the CLI is based upon telnet connections, you can connect to the Probefor Alcatel-Lucent 5529 OAD from anywhere. This means that simple scripts can beset up to allow users to acknowledge selected events from the TivoliNetcool/OMNIbus event list by creating desktop tools to telnet to the Probe forAlcatel-Lucent 5529 OAD, send a command, and then close the connection.


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-7530).

Table 5. Properties and command line options

Property name Command line option Description

AcknowledgeFilter string -acknowledgefilter string Use this property to specify whichalarms the probe retrieves duringresynchronization, based on theiracknowledgement state. Thisproperty takes the followingvalues:

v AI_EVENT_ACKNOWLEDGED

v AI_EVENT_UNACKNOWLEDGED

v AI_NA

The default is ""

Note:

If you want to retrieve alarms ofmore than one acknowledgementstate, specify them as acomma-separated list. If you leavethis property blank, the proberetrieves alarms of allacknowledgement states.

AlarmRetrievalMgrExtURL string

-alarmretrievalmgrexturlstring

Use this property to specify thepath to the AlarmRetrievalMgrExtendpoint.

The default is oad/services/AlarmRetrievalMgrExt.

AlarmRetrievalMgrURLstring

-alarmretrievalmgrurlstring

Use this property to specify thepath to the AlarmRetrievalMgrendpoint.

The default isoad/services/AlarmRetrievalMgr.

AlarmsBatchSize integer -alarmsbatchsize integer Use this property to specify thenumber of alarms that the probecan receive during eachresynchronization.

The default is 100.


Table 5. Properties and command line options (continued)


CertificateStore string -certificatestore string Use this property to specify thepath to the Java keystore file thatcontains the SSL certificate.

The default is "".

Note: The probe uses thisproperty if SSL is used on theserver running Alcatel 5529 OAD.

CertificateStorePasswordstring

-certificatestorepassword string

Use this property to specifypassword that protects the Javakeystore file.

The default is "".

Note: Encrypt the password usingnco_g_crypt.

CleanupPersistentJmsIdstring

-cleanuppersistent jmsidstring (This is equivalent toCleanupPersistentJmsIdwith a value of true.)

-nocleanuppersistentjmsid (This is equivalentto CleanupPersistentJmsIdwith a value of false.)

Use this property to specifywhether the probe clears thedurable JMS subscription of thesubscribers before shutting down.This property takes the followingvalues:

false: The probe does not clearthe durable JMS subscription.

true: The probe clears the durablesubscription of the JMSsubscribers.

The default is false.

ClusterURL string -clusterurl string Use this property to specify the IPaddress and port number of eachOAD server in the cluster.

You must specify this propertyvalue as a comma-separated list,with each item in the list being inthe following format:ip_address:port_number

The default is localhost:1099.

Note: If the probe is running onthe same server as OAD, you canspecify localhost instead of the IPaddress of the host computer.

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 with the probe.

The default is 6970.




CommandPortLimit integer -commandportlimit integer Use this property to specify themaximum number of telnetconnections that the probe allows.

The default is 10.

DiscoveryGroup string -discoverygroup string Use this property to specify the IPaddress to which the probe sendsthe discovery query.

The default is 230.0.0.4.

HttpHost string -httphost string Use this property to specify thehost name of the server runningAlcatel 5529 OAD.

The default is localhost.

HttpPort integer -httpPort integer Use this property to specify theport number on which the Alcatel5529 OAD listens for HTTP orHTTPS requests.


Inactivity integer -inactivity integer Use this property to specify thetime (in seconds) the probe allowsbetween receiving JMS eventsbefore disconnecting from Alcatel5529 OAD.

The default is 70.

JmsFilter string -jmsfilter string Use this property to specify thefilter the probe uses to subscribe toevents on the JMS.

The default is "".

JmsPort integer -jmsport integer Use this property to specify theport number on which the Alcatel5529 OAD listens for JMSconnections.


Optimize string -optimize (This isequivalent to OptimizeJmsId with a value oftrue.)

-nooptimize (This isequivalent to Optimizewith a value of false.)

Use this property to specifywhether the probe can run withoptimized performance:

false: The probe does not runwith optimized performance.

true: The probe runs withoptimized performance.

The default is true.

Note: In optimized performancethe probe reduces the number ofmessages logged into the log file.




PartitionName string -partitionname string Use this property to specify thecluster partition name to which thediscovery query should berestricted.

The default is cluster-name.

Password string -password string Use this property to specify thepassword that the probe uses toauthenticate with Alcatel 5529OAD.

The default is "".

Note: You must specify thepassword encrypted bynco_g_crypt.

PerceivedSeverityFilterstring

-perceivedseverityfilterstring

Use this property to specify whichalarms the probe retrieves duringresynchronization based on theirperceived severity. This propertytakes the following values:

v PROP_UPDATE

v PS_CLEARED

v PS_CRITICAL

v PS_INDETERMINATE

v PS_MAJOR

v PS_MINOR

v PS_WARNING

The default is "".

Note:

If you want to retrieve alarms ofmore than one perceived severity,specify them as acomma-separated list. If you leavethis property blank, the proberetrieves alarms of all perceivedseverities.

PersistentJmsId string -persistentjmsid string Use this property to specify theidentifier of the durable subscriberin the JMS.

The default is "".




ProbableCauseFilterstring

-probablecausefilterstring

Use this property to specify whichalarms the probe retrieves duringresynchronization based on theirprobable cause.

Each value that you specify shouldbe in the following format:

ru=boolean,contra=boolean,type=description

Where ru indicates whether thealarm detected is from a device ona remote network, contra indicateswhether the alarm detected isrelated to the source atomicfunction, and description is apredefined MTOSI description ofthe probable cause.

Make sure you separate each partof the definition with a commaand do not include spaces.

The default is "".

Note:

If you want to retrieve alarms ofmore than one probable cause,specify them as asemicolon-separated list. If youleave this property blank, theprobe retrieves alarms of allprobable cause.

Resync string -noresync (This isequivalent to Resync witha value of false.)

-resync (This is equivalentto Resync with a value oftrue.)

Use this property to specifywhether the probe requests allactive alarms from the serverbefore acquiring new alarms. Thisproperty takes the followingvalues:

false: The probe does not performresynchronization.

true: The probe performsresynchronization.


Note: For details about how tospecify whether the probeperforms a full resynchronizationor a partial resynchronization, see“Resynchronizing alarms” on page6.




Retry string -noretry (This isequivalent to Retry with avalue of false.)

-retry (This is equivalentto Retry with a value oftrue.)

Use this property to specifywhether the probe attempts toreconnect to the system followinga timeout. This property takes thefollowing values:

false: The probe does not attemptto reconnect to the system.

true: The probe attempts toreconnect to the system.


ScopeFilter string -scopefilter string Use this property to specify whichalarms the probe retrieves duringresynchronization based on theirdevice type.

Each value that you specify shouldbe in the following format:mdNm=manufacturer,meNm=device

Where manufacturer is the name ofthe manufacturer of the devicefrom which the alarms originatedand device is the name of thedevice itself.

Make sure you separate each partof the definition with a commaand do not include spaces.

The default is "".

Note:

If you want to retrieve alarms ofmore than one device type, specifythem as a semicolon-separated list.If you leave this property blank,the probe retrieves alarms of alldevice types.

Topic string -topic string Use this property to specify theJMS topic to which the probesubscribes.

The default is topic/Fault.

TrustStore string -truststore string Use this property to specify thepath to the Java keystore file thatcontains the trusted authoritycertificate.

The default is "".




TrustStorePassword string -truststorepassword string Use this property to specify thepassword that protects the Javakeystore file that contains thetrusted authority certificate.

The default is "".

Note: You must specify thepassword encrypted bynco_g_crypt.

UseSsl string -nousessl (This isequivalent to UseSsl witha value of false.)

-usessl (This is equivalentto UseSsl with a value oftrue.)

Use this property to specifywhether the probe makes an SSLconnection to Alcatel 5529 OAD.This property takes the followingvalues:

false: The probe does not makean SSL connection to the system.

true: The probe makes an SSLconnection to the system.

The default is false.

Username string -username string Use this property to specify theuser name with which the probelogs onto Alcatel 5529 OAD.

The default is "".

XmlFileDebug string -xmlfiledebug string Use this property to specify theXML file that the probe replays.

The default is "".

Note: This file is used fordebugging purposes only.

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

Table 6. Elements

Element name Element description

$acknowledgeIndication This element indicates the status of theacknowledgement.

$activeAlarmCount This element contains the number of activealarms in the Alcatel 5529 OAD system.

$activityName This element indicates the name of the activity.

$activityStatus This element indicates the status of the activity.


Table 6. Elements (continued)


$AdditionalText This element displays additional informationabout the alarm.

$AffectedTPList0_Object Name This element displays a list of termination pointsaffected for Object specified.

$aliasName_0...n

$aliasValue_0...n

This element displays a list of the aliases used todescribe the network entity as per the userinterface of the operating system.

$batchSequenceEndOfReply This element indicates whether there are anymore alarms to be resynchronized.

$batchSequenceNumber This element displays the sequence number ofbatches received.

$clearedTimeStamp This element displays the time at which thealarm was cleared.

$commpressionType This element displays the type of compressionused for the event.

$communicationStyle This element displays the inter componentcommunication style.

$correlatedNotifications0..n_ ObjectName

This element displays the notification identifierwith its optional object name.

$correlationId This element displays the correlation identifier forCLEAR traps received.

$destinationURI This element displays the URI of the eventdestination.

$endTime This element displays the time an event loss wascleared.

$failureReplytoURI This element displays the URI of the system thatis expecting the failure reply response to thisevent.

$fileLocationURI This element indicates the location of the schemafile.

$isClearable This element indicates if the event is clearable (oris itself a clear).

$iteratorReferenceURI This element displays the URI to the iterator.

$lastAcknowledgedTimeStamp This element displays the time at which thealarm was last acknowledged.

$lastModificationTimeStamp This element displays the time at which thealarm was last modified.

$layerRate This element displays the layer to which theevent is related.

$msgType This element displays the message associatedwith the event.

$msgName This element displays the name of the messagetemplate.

$nativeProbableCause This element indicates the probable cause of theevent as defined in the user interface of theoperating system.

$neTime This element displays the time of the alarm asprovided by the network element.




$notificationId This element displays the identifier of thenotification.

$objectName_Object Name This element displays the event information onthe specified object.

$ObjectType This element displays the type of object.

$osNM This element displays the full distinguished nameof the object reporting the notification.

$OsTime This element displays the time when theoperating system reported the event.

$PackingType This element displays the packing type of thesource.

$PerceivedSeverity This element displays the severity of the alarm.

$Priority This element displays the priority as defined bythe Alcatel 5529 OAD system.

$probableCause_contra This element relates to the probable cause of theevent, indicating the direction of the signalrelated to the event.

$probableCause_ru This element relates to the probable cause of theevent, indicating the location of the networkresource.

$probableCause_type This element relates to the probable cause of theevent, indicating the type code of the probablecause.

$rcaiIndicator This element indicates whether the alarm is aroot cause alarm or a raw alarm.

$replyToURI This element displays the URI of the system thatis expecting a response to this message.

$requestedBatchSize This element displays the number of alarms thatthe probe expects as a batch from the Alcatel 5529OAD system.

$security This element indicates the security status of theevent.

$securityType This element indicates the mode of security usedwhen connecting.

$senderURI This element contains the URI of the messagesender.

$serviceAffecting This element indicates if the alarm has affectedservice.

$specificProblem_0...n This element identifies specific cause within theProbable cause of the alarm.

$startTime This element displays the time an event lossoccurred.

$timestamp This element displays the time when the eventhas occurred.

$type This element identifies the specific value withinthe Probable cause of the alarm.

$x733_BackupObject_Object Name This element indicates whether the objectemitting the alarm has been backed-up.




$X733_EventType This element displays the type of the alarm asper ITU-T X.733:

communicationsAlarm

environmentalAlarm

equipmentAlarm

processingErrorAlarm

qualityofServiceAlarm

$x733_TrendIndication This element indicates the current severity trendof the object.

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-7530).

Table 7. Error messages

Error Description Action

The command didn'tsucceed, due toauthentication pbs

Make sure your 'Username'and 'Password' propertiesvalues are correct

Failed to retrieveUsername property value :+ e

Failed to set theAuthenticator object

The probe could not make theHTTP connection with Alcatel5529 OAD system.

Check that the values set forthe UserName and Passwordproperties are correct.

Cannot re-open theconnection, giving up

The probe could not make theHTTPS connection withAlcatel 5529 OAD system.

Check the connection betweenthe sytem on which the probeis run and the Alcatel 5529OAD system.

Error while settingfollowing field in theevent : + name + "," +value + " : " + e

Error while trying tocreate and initialize anew NSProbeEvent

Error while sending eventto the OS

The probe could not assignthe value for the specifiedfield.

Check the connection betweenthe sytem on which the probeis run and the Alcatel 5529OAD system.


Table 7. Error messages (continued)

Error Description Action

At least one of thecertificate properties isempty

It's unlikely SSL will beset-up correctly

The probe could not find therequired information for SSLconnection.

Check that theCertificateStore,CertificateStorePassword,TrustStore,TrustStorePasswordproperties are set to thecorrect values.

If there is only one Keystorecontaining all certificates,ensure both theCertificateStore andTrustStore properties are setto the same Keystore.

Password is incorrectlength (ensure it hasbeen encrypted usingnco_g_crypt)

The probe found that thepassword entered did notadhere to the securitystandards.

Check the value entered forthe Password property hasbeen encrypted bynco_g_crypt.

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-7530).

Table 8. ProbeWatch messages

ProbeWatch message Description Triggers/causes

START SYNCHRONIZATION This indicates thatresynchronization has started.The probe issues agetActiveAlarms request toretrieve active alarms fromthe Alcatel 5529 OAD system.

The probe has reconnected toa JMS server and the Resyncproperty is set to true.

No Events received forinactivity seconds

The probe did not receiveevents for the specifiedperiod.

The probe has exceeded thetime out period already set.

SYNCHRONIZATION FAILED The probe failed to obtainactive alarms from the remoteserver.

The remote server may beunavailable because of anetwork outage. Check logfiles for more information.

END SYNCHRONIZATION The probe retrieved allcurrent active alarms from theAlcatel-Lucent 5529 OADsystem.

The probe has completedresynchronization with theAlcatel-Lucent 5529 OADsystem.


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. 2006, 2014 21

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 wish 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. 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.

Other company, product, or service names may be trademarks or service marks ofothers.

Appendix. Notices and Trademarks 23

��

Printed in USA

SC23-9107-07

netcool/omnibus probe foralcatel-lucent 5529 oss alarm ... · retrieval of real-time and stored...

Documents