IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 ... · The Alcatel-Lucent 5620 Service...

IBM® Tivoli® Netcool/OMNIbus Probe for Alcatel-Lucent5620 SAM JMSVersion 2.0 (for SAM R5), 2.0 (for SAM R6), 2.0 (for SAM R7), 1.0(for SAM R8), 1.0 (for SAM R9)

Reference GuideMay 11, 2012

SC23-7663-09

��

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

Edition notice

This edition (SC23-7663-09) applies to version 2.0 (for SAM R5), 2.0 (for SAM R6), 2.0 (for SAM R7), 1.0 (for SAMR8), 1.0 (for SAM R9) of the Tivoli Netcool/OMNIbus Probe for Alcatel 5620 SAM and to all subsequent releasesand modifications until otherwise indicated in new editions.

This edition replaces SC23-7663-08.

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

Contents

About this guide . . . . . . . . . . . vDocument Control Page . . . . . . . . . . vConventions used in this guide . . . . . . . vii

IBM Tivoli Netcool/OMNIbus Probe forAlcatel-Lucent 5620 SAM JMS . . . . . 1Summary . . . . . . . . . . . . . . . 2Installing probes . . . . . . . . . . . . . 4Configuring the probe . . . . . . . . . . . 5

Obtaining the probe-nonnative patch . . . . . 5Jar files . . . . . . . . . . . . . . . 5Configuring lookup tables . . . . . . . . . 6Configuring SSL connections . . . . . . . . 6Running the probe . . . . . . . . . . . 8

Data acquisition . . . . . . . . . . . . . 8Using durable subscriptions . . . . . . . . 8Retrieving events . . . . . . . . . . . . 9Jms topic . . . . . . . . . . . . . . 10JMS acknowlegement modes. . . . . . . . 11Filtering events . . . . . . . . . . . . 11Alcatel-Lucent SAM server redundancy . . . . 13Peer-to-peer failover functionality . . . . . . 13Timeout and reconnection . . . . . . . . 14Resynchronization . . . . . . . . . . . 15

Properties and command line options . . . . . 15Elements . . . . . . . . . . . . . . . 21

Common elements . . . . . . . . . . . 22Alarm event elements . . . . . . . . . . 22Attribute value change event elements . . . . 23State change event elements . . . . . . . . 24Alarm status change event elements . . . . . 24Object deletion event elements . . . . . . . 25Relationship change event elements . . . . . 25Elements generated for object creation events . . 25Client session event elements . . . . . . . 28File available event elements . . . . . . . 28Database activity event elements . . . . . . 28Database connection state change event elements 28Database error event elements . . . . . . . 29Database proxy state change event elements . . 29

Error messages . . . . . . . . . . . . . 29ProbeWatch messages . . . . . . . . . . . 30Troubleshooting . . . . . . . . . . . . . 31

Appendix. Notices and Trademarks . . 33Notices . . . . . . . . . . . . . . . . 33Trademarks . . . . . . . . . . . . . . 35

© Copyright IBM Corp. 2006, 2012 iii

iv IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 SAM JMS: Reference Guide

About this guide

The following sections contain important information about using this guide.

Document Control PageUse this information to track changes between versions of this guide.

The IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 SAMdocumentation is provided in softcopy format only. To obtain the most recentversion, visit the IBM® Tivoli® Netcool® Knowledge Center.

http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/common/kc_welcome-444.html?lang=en

Table 1. Document modification history

Documentversion

Publicationdate

Comments

SC23-6020-00 September 11,2006

First IBM publication.

SC23-7663-00 June 26, 2007 Summary table updated.

Support for Alcatel-Lucent SAM version R5.0 added.

Configuration section added for Alcatel-Lucent SAM R5.0.

Use of a SAX parser in place of a DOM server.

Addition of the Optimize, ClearClientRemovedAlarm, andNbEventsStoreRecovery properties for Alcatel-Lucent SAMversion R5.0.

MaxEventsPerSecond property removed.

SC23-7663-01 September 25,2007

Details of how to access the probe-nonnative-base-0patch added.

Warning added to the “Peer-to-peer failoverfunctionality” on page 13 section about not setting theJmsFilter property on the master and slave probes to thesame value.

SC23-7663-02 March 28,2008

Reference guide converted to new IBM format.

Durable subscription information added.

Properties and command line options table updated.

© Copyright IBM Corp. 2006, 2012 v



Table 1. Document modification history (continued)

Documentversion

Publicationdate

Comments

SC23-7663-03 June 30, 2008 Summary section updated.

Jar files for SAM V6 section added.

Lookup tables for SAM V6 section added.

Using durable subscriptions section updated.

JMS topics section updated.

Resynchronization section updated.

XMLretrieveUseInService property added.

Properties and command line options section updated.

Common elements section updated.

Alarm elements section updated.

SC23-7663-04 February 28,2009

Guide updated to reflect support for Alcatel-Lucent SAMR6.1.

Summary table updated.

"Installing the probe" topic added.

"Connectivity and firewall considerations" topic added.

Note added to the "Peer-to-peer failover" topic for APARIY93703.

"JMS acknowledgement modes" topic added.

Note added to the "Using durable subscriptions" forAPAR IZ28260.

JMSAcknowledgeMode property description added to theProperties and command line options table.

"Troubleshooting" section added.

SC23-7663-05 July 1, 2010 “Summary” on page 2 updated.

“Using durable subscriptions” on page 8 updated.

ClearClientRemovedAlarm property removed from“Properties and command line options” on page 15.

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

v CertificateStoreType

v CertificateStore

v CertificateStorePassword

v Durable

v TrustStore

v TrustStorePassword

v UseSSL

vi IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 SAM JMS: Reference Guide

Table 1. Document modification history (continued)

Documentversion

Publicationdate

Comments

SC23-7663-06 March 31,2011

Installation section replaced by “Installing probes” onpage 4.

SC23-7663-07 July 1, 2011 Guide updated to reflect support for Alcatel-Lucent SAMR9.0.

“Summary” on page 2 updated.

The following property added to “Properties andcommand line options” on page 15 :

v StoreEvents

The default is 600.

SC23-7663-08 March 2, 2012 Package version for Alcatel-Lucent SAM R8.0 has beenupdated to 1.0 in “Summary” on page 2.

SC23-7663-09 May 25, 2012 “Configuring SSL connections” on page 6 updated.

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.

About this guide vii

Operating system-specific directory names

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

$OMNIHOME/probes/arch

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

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

Table 2. Directory names for the arch variable

Operating system Directory name represented by arch

AIX® systems aix5

HP-UX PA-RISC-based systems hpux11

HP-UX Integrity-based systems hpux11hpia

Red Hat Linux and SUSE systems linux2x86

Linux for System z® linux2s390

Solaris systems solaris2

Windows systems win32

OMNIHOME location

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

viii IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 SAM JMS: Reference Guide

IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620SAM JMS

The Alcatel-Lucent 5620 Service Aware Manager (SAM) is a network managementsystem that is used to manage network nodes. Distributed Alcatel-Lucent 5620SAM elements are monitored by the Alcatel-Lucent 5620 SAM database using GUIand network management components through a Java-based application. TheProbe for Alcatel-Lucent 5620 SAM acquires data from Alcatel-Lucent 5620 SAMusing a Java™ Messaging System (JMS).

The Probe for Alcatel-Lucent 5620 SAM supports the following versions of SAM:

Table 3. Supported SAM versions

Executable name Supported SAM versions

nco_p_alcatel_5620_sam_v5 R5.0

nco_p_alcatel_5620_sam_v6 R6.0, R6.1




nco_p_alcatel_5620_sam_v9.bat R9.0 (on Windows operating systems)

This guide contains the following sections:v “Summary” on page 2v “Installing probes” on page 4v “Configuring the probe” on page 5v “Data acquisition” on page 8v “Properties and command line options” on page 15v “Elements” on page 21v “Error messages” on page 29v “ProbeWatch messages” on page 30v “Troubleshooting” on page 31

© Copyright IBM Corp. 2006, 2012 1

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 5620 SAM.

Table 4. Summary

Probe target Alcatel-Lucent 5620 Service Aware Manager (SAM)version R5.0, R.6.0, R6.1, R8.0 and R9.0.

Note: Versions 2, 3, and 4 of SAM are no longersupported.

Probe executable names nco_p_alcatel_5620_sam_v5 (for version R5.0 ofAlcatel-Lucent 5620 SAM)

nco_p_alcatel_5620_sam_v6 (for version R6.0 and R6.1of Alcatel-Lucent 5620 SAM)

nco_p_alcatel_5620_sam_v7 (for version R7.0 ofAlcatel-Lucent 5620 SAM)



nco_p_alcatel_5620_sam_v9.bat (for version R9.0 ofAlcatel-Lucent 5620 SAM on Windows OS)

Probe installation packages omnibus-arch-probe-nco-p-alcatel-5620-sam-v5-2_0(for SAM version R5.0)

omnibus-arch-probe-nco-p-alcatel-5620-sam-v6-2_0(for SAM version R6.0 and R6.1)

omnibus-arch-probe-nco-p-alcatel-5620-sam-v7-2_0(for SAM version R7.0)



Properties files $OMNIHOME/probes/arch/alcatel_5620_sam_v5.props fornco_p_alcatel_5620_sam_v5

$OMNIHOME/probes/arch/alcatel_5620_sam_v6.props fornco_p_alcatel_5620_sam_v6




2 IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 SAM JMS: Reference Guide

Table 4. Summary (continued)

Rules files $OMNIHOME/probes/arch/alcatel_5620_sam_v5.rules fornco_p_alcatel_5620_sam_v5

$OMNIHOME/probes/arch/alcatel_5620_sam_v6.rules fornco_p_alcatel_5620_sam_v6




Requirements A currently supported version of IBM TivoliNetcool/OMNIbus.

Probe-nonnative-base is installed as part of the packagewith Netcool/OMNIbus 7.3, but for pre 7.3 versionsprobe-nonnative-base must be installed, (for detailsabout how to obtain this patch, see “Obtaining theprobe-nonnative patch” on page 5)

omnibus-solaris2-probe-sdk-java-1_0 (or later)

Java version 1.5 or later.Note: Sun Java 1.6 is required if you are configuringSSL communications.Note: Sun Java 1.6 is not supported on AIX, thereforeSSL communications are not supported when runningthe probe on the AIX operating system.

v samOss.jar

v xercesImpl.jar

The following files are required by version 9.0 of theprobe on the Windows OS:

v advcorr.sql

v nco_p_alcatel_5620_sam_v9.xml

Connection method Java Messaging System (JMS) and HTTPS Port(optional)

Remote connectivity The Probe for Alcatel-Lucent 5620 SAM can connect to aremote device. Details of the remote device are specifiedusing the Host, EJBPort, and HTTPPort properties in theproperties file.

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

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

IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 SAM JMS 3

Table 4. Summary (continued)

IP environment IPv4 or IPv6

Note: The probe is supported on IPv6 when running onIBM Tivoli 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, 7.4.0, and8.1 use 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.

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

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

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

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

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


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

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

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

This section contains topics on the Alcatel-Lucent 5620 SAM configurationrequirements:v “Obtaining the probe-nonnative patch”v “Jar files”v “Configuring lookup tables” on page 6

Obtaining the probe-nonnative patchIf you are running a pre 7.3 version of Netcool/OMNIbus, you must alsodownload the probe-nonnative patch

To obtain the probe-nonnative-base 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.

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

The following binaries are required by version 4 of the probe:v nms_common.jar

v xercesImpl.jar

v jbossall-client.jar

The following binaries are required by versions 5, 6, 7, 8 and 9 of the probe:v samOss.jar

v xercesImpl.jar

These form a part of the Alcatel-Lucent server installation and must be copied tothe following location:

$OMNIHOME/probes/java

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

The default install locations for these files (the locations from which you can copythe files) are described in the sections that follow.

Location of the jar files

If you use default installation, you can find the jar files in the following locations:v /opt/5620sam/server/nms/jboss/lib/endorsed/xercesImpl.jar


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

v /opt/5620sam/server/nms/integration/SAM_O/samOss.jar

Configuring lookup tablesThe probe is supplied with a lookup table that contains details of the various typesof alarms that Alcatel-Lucent 5620 SAM generates. You may need to update therules file to include the path to the lookup table in your installation.

Following lookup file accompanies the Probe for Alcatel-Lucent 5620 SAM:v alcatel_5620_sam_v4.lookup (for R4.0 of the probe)v alcatel_5620_sam_v5.lookup (for R5.0 of the probe)v alcatel_5620_sam_v6.lookup (for R6.0 and R6.1 of the probe)v alcatel_5620_sam_v7.lookup (for R7.0 of the probe)v alcatel_5620_sam_v8.lookup (for R8.0 of the probe)v alcatel_5620_sam_v9.lookup (for R9.0 of the probe)

This file is installed in the following location:

$OMNIHOME/probes/includes

Each version of the lookup file contains details of the alarm names and probablecauses generated by the compatible Alcatel-Lucent 5620 SAM. The path to this fileis included in the rules file. If you are not running the probe from$OMNIHOME/probes, you must change this path accordingly.

Note: You cannot use $OMNIHOME in the paths to the lookup files; you must use thefull path in the rules file.

Configuring SSL connectionsYou can enable Secure Socket Layer (SSL) encryption of data exchanged over JMSand HTTP. A Java keystore file is required for this HTTPS connection, access towhich is specified using the CertificateStore and CertificateStorePasswordproperties. The keystore file can be created using the Java keytool command.

For general details of JMS connections over SSL guidelines, seehttps://community.jboss.org/wiki/JMSOverSSL?_sscc=t.

To enable SSL encryption, use the following steps:1. Use the keytool command to generate the keystore by running the following

command:keytool -genkey -alias sslclientcert -keyalg RSA -keystorealcatelsam.jks -keysize 2048

Note: If you are running more than one probe, you must generate a keystorefor each probe and provide a different name for each, for example,alcatelsam01.jks, alcatelsam02.jks, alcatelsam03.jks, and so forth.

2. When prompted for a password, press ENTER to use the same password as thekeystore password.

Note: To reset the password for the probe's Java keystore at a later date, youcan use the following command:

keytool -storepasswd -new new_storepass -keystore alcatelsam.jks


https://community.jboss.org/wiki/JMSOverSSL?_sscc=t

3. Store the keystore file in the following directory:$OMNIHOME/probes/java/keystore/nco_p_alcatel_5620_sam_v9/

4. Obtain the Alcatel EMS certficate (alcatelclient.cert) certificate. Consult yourAlcatel documentation for instructions about obtaining certificate files.

5. Import the Alcatel EMS certficate into the keystore file using the followingcommand:keytool -import -trustcacerts -alias sslclientcert -filealcatelclient.cert -keystore alcatelsam.jks

6. Verify that the certificate has been imported into the keystore using thefollowing command:keytool -list -v -keystore alcatelsam.jks

7. Set the probe's UseSSL property to true and configure the probe's HTTPPortproperty to use the default Alcatel EMS HTTPS port, 8443.

8. Specify values for the following probe properties, using the same Java keystorefile as both certificate store and trusted certificates store, using the samepassword for each:v CertificateStoreType: Specify the type of certificate obtained from the

keystore; in this example, it is JKS.v CertificateStore: Specify the path of the probe's Java keystore that you

created.v CertificateStorePassword: Specify the password that you set for the Java

keystore.v TrustStore: Specify the same value as that set for the CertificateStore

property.v TrustStorePassword: Specify the same value as that set for the

CertificateStorePassword property.

Example SSL configuration property settings

The following example shows SSL configuration settings from the properties file ofan example Probe for Alcatel-Lucent 5620 SAM:Host : "198.162.20.21"HTTPPort : 8443UseSSL : "true"CertificateStoreType : "JKS"CertificateStore :"/opt/IBM/tivoli/netcool/omnibus/probes/java/keystore/nco_p_alcatel_5620_sam_v9/alcatelsam.jks"CertificateStorePassword : "ECEDBJAGBJFHGD"TrustStore :"/opt/IBM/tivoli/netcool/omnibus/probes/java/keystore/nco_p_alcatel_5620_sam_v9/alcatelsam.jks"TrustStorePassword : "ECEDBJAGBJFHGD"


Running the probeTo start the probe on UNIX or Linux operating systems, use the followingcommand: $OMNIHOME/bin/nco_p_alcatel_5620_sam_version

To start the probe on a Windows operating systems, use the following command:$OMNIHOME\bin\nco_p_alcatel_5620_sam_v9.bat

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 5620 SAM acquires events by connecting directly tothe Java Messaging Service (JMS) running on the Alcatel-Lucent 5620 SAM server.The probe can also obtain current alarms and downtime alarms (if there is a loss ofconnection) by connecting to the HTTP port on the Alcatel-Lucent 5620 SAMserver.

When running Alcatel-Lucent 5620 SAM version R4.0, R5.0, R6.0, R6.1 R8.0 or R9.0the probe obtains data from Alcatel-Lucent 5620 SAM as follows:1. The probe connects to Alcatel-Lucent 5620 SAM.2. If the XMLretrieve property is set to 1, the probe sends a request to

Alcatel-Lucent 5620 SAM for events that currently exist.3. The probe subscribes to the JMS to receive new events as they are generated.

Note: You can specify filter criteria that the probe sends with the request usingthe JmsFilter property.

4. Alcatel-Lucent 5620 SAM sends all existing events that meet the filter criteria tothe probe.

5. The probe extracts event information using a SAX parser.

Using durable subscriptionsThe probe can make a durable or a non-durable subscription with a JMS topic.

In durable subscription to a topic, an active subscriber specified by the probereceives messages that were published on the topic while the subscriber wasinactive. When the durable subscription is enabled, the JMS stores messagespublished on the specified topic while the subscriber is not active or disconnectedfrom the JMS.

In a non-durable subscription to a topic, the subscriber only receives messages thatare published on that topic while the subscriber is active. The JMS drops othermessages that are sent while the subscriber is inactive.

Enabling durable subscriptions

You can specify the identifier of the subscriber in the PersistentJmsId property,and enable a durable subscription using the Durable property. When the probereconnects with the same subscriber value, the JMS sends the stored events.

In durable subscription mode, if you stop the probe manually using Ctrl - C theJMS session becomes inactive. However, when the probe is stopped unexpectedly


the durable JMS session remains active. For example, if the probe is stopped due toa system crash, the JMS session remains active. This helps the probe receive alarmsgenerated when it was inactive.

Note: Make sure that the same JMS ID value specified using the PersistentJmsIDproperty is part of the JmsFilter property value.

Disabling durable subscriptions

To disable the durable subscription mode, set the value for the Durable property tofalse. If the value specified for this property is false, the probe makes anon-durable subscription with the JMS topic and receives active alarms.

Note: The JMS removes the stored messages once the probe receives newmessages, when the stored messages expire, or when the durable subscription isdeleted.

Retrieving eventsThe probe can retrieve events using either JMS or HTTP.

The probe retrieves events by connecting directly to the JMS. The probe can also beconfigured to connect to an HTTP port and send a SOAP/XML request.

Connecting using JMS

To connect directly to the JMS, the probe performs the following actions:1. Probe connects to an EJB port on the SAM server.2. Probe connects to the JMS running on the SAM server.3. JMS sends asynchronous events to the probe.4. Probe parses these events and sends them to the ObjectServer.5. JMS sends regular heartbeat events to the probe to maintain the connection to

the EJB port.

Connecting using HTTP

To connect to Alcatel-Lucent 5620 SAM server using the HTTP port, set theXMLretrieve property to 1.

The probe retrieves events as follows:1. Probe connects to an HTTP port on the SAM server.2. Probe sends a SOAP/XML request to the SAM server.3. SAM server sends all alarms currently in the system to the probe in

SOAP/XML format.4. Probe parses these events and sends them to the ObjectServer.


Connectivity and firewall considerationsTo connect to the Alcatel-Lucent 5620 SAM server, the probe uses the EJBPort andHTTPPort properties.

The EJBPort property specifies the EJB port to which the probe connects. Thedefault value for this property is 1099. The HTTPPort property specifies the HTTPport to which the probe connects. The default value for this property is 8080.

For connectivity within a firewall, the Alcatel-Lucent 5620 SAM also uses the JMSport. The JMS service details are specified within the Alcatel-Lucent 5620 SAMserver. The JMS service can only be altered from the Alcatel-Lucent 5620 SAMserver configuration. The default value for the JMS port is 8093.

Connecting directly to the JMSTo connect directly to the JMS, the probe performs the following actions:1. Probe connects to an EJB port on the SAM server.2. Probe connects to the JMS running on the SAM server.3. JMS sends asynchronous events to the probe.4. Probe parses these events and sends them to the ObjectServer.5. JMS sends regular heartbeat events to the probe to maintain the connection to

the EJB port.

Connecting to an HTTP portTo connect to Alcatel-Lucent 5620 SAM server using the HTTP port, set theXMLretrieve property to 1.

The probe retrieves events as follows:1. Probe connects to an HTTP port on the SAM server.2. Probe sends a SOAP/XML request to the SAM server.3. SAM server sends all alarms currently in the system to the probe in

SOAP/XML format.4. Probe parses these events and sends them to the ObjectServer.

Jms topicThe probe can subscribe to a JMS topic and receive events in XML format.

The following table describes the topics to which the probe can subscribe using theJmsTopic property.

Table 5. JMS topics

JMS topic Description

5620-SAM-topic-xml-fault Subscribes to fault events in XML format.

5620-SAM-topic-xml-file Subscribes to findToFile events in XML format.

5620-SAM-topic-xml-all Subscribes to events related to statistics collection inXML format.

5620-SAM-topic-xml Subscribes to general events (such as object creationand deletion) in XML format.


JMS acknowlegement modesWithin the SAM server, the probe acts as a JMS client and supports either of thetwo acknowledgement modes: DUPS_OK_ACKNOWLEDGE orAUTO_ACKNOWLEDGE. You can set the JMSAcknowledgeMode property to a modein which the probe should run as a JMS client.

If the JMS is running in DUPS_OK_ACKNOWLEDGE mode, the probe allows theJMS provider to send a message more than once to the same destination. Thismode can be chosen when the performance and throughput of the probe decreaseto avoid duplicate messages.

If the JMS is running in AUTO_ACKNOWLEDGE mode, the probe automaticallyacknowledges a received message, and waits for a broker acknowledgement of themessage.

Filtering eventsYou can specify how the JMS filters the events sent to the probe by using theJmsFilter property. This property allows you to specify a filter that uses the JMSproperties associated with the event.

The following table describes the JMS properties available and their correspondingvalues.

Table 6. JMS properties

Property Values Description

MTOSI_NTType ALA_OTHER

NT_OBJECTCREATION

NT_OBJECTDELETION

NT_ATTRIBUTE_VALUE_ CHANGE

NT_STATE_CHANGE

NT_ALARM

NT_HEARTBEAT

ALA_ RELATIONSHIPCHANGE

Use this property to specify thetype of notification that you wantthe filter to send to the probe.

MTOSI_osTime Time in milliseconds Use this property to specify thetime when the event was createdon the server. The filter sends thistime of the event creation to theprobe.

MTOSI_objectName Object name Use this property to specify theobject name for the event thatyou want the filter to send to theprobe.

MTOSI_objectType Object type Use this property to specify theobject type for the event that youwant the filter to send to theprobe.


Table 6. JMS properties (continued)

Property Values Description

ALA_category SERVICE

EQUIPMENT

ACCOUNTING

GENERAL

FAULT

STATISTICS

DATABASE

SOFTWARE

Use this property to specify thecategory of the event that youwant the filter to send to theprobe.

ALA_allomorphic Allomorphic class for theobject type

Use this property to specify theallomorphic class for the objecttype that you want the filter tosend to the probe.

ALA_topic JMS topic Use this property to specify theJMS topic for the message thatyou want the filter to send to theprobe.

ALA_clientId Specific client ID or empty Use this property to specify theclient ID that you want the filterto send to the probe.

JMS filtersThe JMS filters help you retrieve data from the required JMS topics.

You can filter events using any of the JMS properties. For example, the followingfilters on fault messages with a severity class of Warning:ALA_category in (\’FAULT\’) and MTOSI_perceivedSeverity in (\’Warning\’)

By default, the JMS filters events sent to the probe using the following filter:ALA_category not in (\’STATISTICS\’, \’ACCOUNTING\’)

This instructs the JMS to send events that are neither statistics nor accountingevents.

Note: For Alcatel-Lucent 5620 SAM version R4.0, R5.0, R6.0, R6.1, R7, R8 and R9the filter must contain ALA_clientId in ('netcool@[email protected]', '').netcool@[email protected] is the default value of the PersistentJmsId property. If youchange the value of this property, you must also change the value of the JMS filteraccordingly.


Alcatel-Lucent SAM server redundancyTwo Alcatel-Lucent SAM servers can run in a redundancy pair (that is, one runs asthe primary server and the other as a backup server). This affects the way that youconfigure the probe.

If you are using two Alcatel-Lucent SAM servers in a redundancy pair, you willneed to run two instances of the Probe for Alcatel-Lucent 5620 SAM. One instanceof the probe connects to the primary server and the other to the backup server. Thesettings in the properties file for the two probe instances should be identical exceptfor the host name.

Since the backup server does not have an active connection until the primaryserver shuts down, the probe instance will not be able to make a valid connectionto it until the primary server shuts down. So that both instances of the probe canrun continuously, you must set the ReconnectionAttempts property to a high value;for example, to 20000000. This means that one instance of the probe will makecontinual attempts to connect to the backup Alcatel-Lucent SAM server while theprimary server is running; if the primary server shuts down, this instance of theprobe will connect on its next attempt. When the backup server is running, theother probe instance will make continual attempts to reconnect to the primaryAlcatel-Lucent SAM server.

Peer-to-peer failover functionalityThe Probe for Alcatel-Lucent 5620 SAM supports failover configurations where twoprobes run simultaneously. One probe acts as the master probe, sending events tothe ObjectServer; the other acts as the slave probe on standby. If the master probefails, the slave probe activates.

While the slave probe receives heartbeats from the master probe, it will notforward events to the ObjectServer. If the master shuts down, the slave probe willstop receiving heartbeats from the master and any events it receives thereafter willbe forwarded to the ObjectServer on behalf of the master probe. When the masteris running again, the slave will continue to receive events, but will no longer sendthem to the ObjectServer.

Note: Peer-to-peer functionality does not work if you specify the same value forthe JmsFilter property for both the master probe and the slave probe files. Youmust create two queues that both use the JMS filter that you want to use, andspecify one queue in the master probe properties file and specify the other queuein the slave probe properties file.


Example property file settings for peer-to-peer failover

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

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

The following example shows the peer-to-peer settings from the properties file of amaster probe:Server : "NCOMS"RulesFile : "master_rules_file"MessageLog : "master_log_file"PeerHost : "slave_hostname"PeerPort : 5555 # [communication port between master and slave probe]Mode : "master"PidFile : "$OMNIHOME/var/opc_ua"

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

Timeout and reconnectionYou can configure the probe to detect inactivity in the Alcatel-Lucent 5620 SAMserver, and to specify disconnection and reconnection behavior.

To determine the status of the Alcatel-Lucent 5620 SAM server, the probe uses thevalue specified by the AliveTimeout property. If the probe does not receive anevent for a period greater than that specified by this property, it sends aninformation message to the message log, disconnects from the server, and entersthe reconnection mode.

In the reconnection mode, the probe attempts to connect for the number of timesspecified by the ReconnectionAttempts property, waiting for the time specified bythe ReconnectionInterval property between attempts. After the maximum numberof unsuccessful reconnection attempts, the probe shuts down.

If the probe receives a TerminateClientSession alarm from the SAM server, itignores the ReconnectionAttempts property and shuts down.


ResynchronizationAfter a failover, the probe reconnects to an HTTP port of the primaryAlcatel-Lucent SAM R6.0 or R6.1 server, and sends a SOAP/XML request toresynchronize all active alarms from the secondary Alcatel-Lucent SAM R6.0 orR6.1 server.

Using the XMLretrieve property, the probe can resynchronize alarms generatedwhile the network elements managed by the SAM server are either inService(active) or inMaintenance (in the maintenance stage or inactive). The SAM servergenerates inService alarms when the associated network elements are active, andgenerates inMaintenance alarms when they are inactive. To resynchronize only theactive network elements and to receive only the inService alarms, set theXMLretrieveUseInService property to 1.

Fine tuning resynchronization

If you are experiencing a slow performance when retrieving alarms in XML format(for example, the probe is parsing events at a rate of 40 event per minute or less),there are two properties that you can use for fine tuning: OptimizeResynch andSizeBlockRead.

The OptimizeResynch property allows you to specify that the probe writes theresynchronized XML alarms to the log file, regardless of the setting of theMessageLevel property; this reduces the time required to process each XML alarm.The SizeBlockRead property allows you to specify the maximum size of the blockof data that the probe reads during resychronization.

For Alcatel-Lucent 5620 SAM version R5.0, R6.0, R6.1, R7, R8 and R9 theOptimizeResynch property has been renamed Optimize. If you set this property to1, the probe optimizes performance by not writing the resynchronized eventsreceived from the HTTP request and the JMS events to the log file.

Important: The OptimizeResynch property is only available for R4.0. The Optimizeproperty is only available for R5.0, R6.0, R6.1, R7, R8 and R9.

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 more information about generic Netcool/OMNIbus properties andcommand line options, see the IBM Tivoli Netcool/OMNIbus Probe and GatewayGuide.


Table 7. Properties and command line options

Property name Command lineoption

Description

AliveTimeout integer -alivetimeout integer Use this property to specify the time(in seconds) between JMS events thatthe probe uses to determine whetherthe SAM server has failed. If thetime between successive JMS eventsexceeds this period, the probedisconnects from the server andattempts to reconnect.

The default is 180.

CertificateStore string -certificatestorestring

Use this property to specify the pathof the certificate store file.

The default is "".

CertificateStorePasswordstring

-certificatestorepassword string

Use this property to specify thepassword required to access thecertificate store file.

The default is "".

CertificateStoreType string -certificatestoretypestring

Use this property to specify thecertificate type obtained from thecertificate store.

The default is JKS.

Durable string -durable string Use this property to specify that theprobe makes a durable subscriptionto the JMS.

false: JMS subscription is notdurable.

true: JMS subscription is durable.

The default is true.

EJBPort integer -ejbport integer Use this property to specify the EJBport to which the probe connects.

The default is 1099.

FlushBufferInterval integer -flushbufferintervalinteger

Use this property to specify howoften (in seconds) the probe flushesall alerts in the buffer to theObjectServer.

The default is 0 (which instructs theprobe to never flush the alerts to theObjectServer).

Host string -host string Use this property to specify the IPaddress of the host machine onwhich the Alcatel-Lucent 5620 SAMserver is running.

The default is localhost.


Table 7. Properties and command line options (continued)


Description

HTTPPort integer -httpport integer Use this property to specify theHTTP port to which the probeconnects.


JMSAcknowledgeMode string -jmsacknowledgemode string

Use this property to specify theacknowledgement mode in whichthe probe runs. This property takesthe following values:

AUTO_ACKNOWLEDGE: The probe runs inautomatic acknowledgement(AUTO_ACKNOWLEDGE) mode.

DUPS_OK_ACKNOWLEDGE: The proberuns in deduplication allowed(DUPS_OK_ACKNOWLEDGE)mode.

The default is DUPS_OK_ACKNOWLEDGE.

JmsFilter string -jmsfilter string Use this property to specify the filterthe probe uses to limit the eventsreceived from Alcatel-Lucent 5620SAM. For details of the format inwhich to specify this filter, see “JMSfilters” on page 12.

The default value is ALA_clientId in('netcool@[email protected]', '') andALA_category not in('STATISTICS', 'ACCOUNTING').

JmsTopic string -jmstopic string Use this property to specify the XMLtopic that the probe uses to subscribeto events within the JMS.

The default is 5620-SAM-topic-xml.

For details about valid values forthis property, see Table 5 on page 10.

MaxEventQueueSize integer -maxeventqueuesizeinteger

Use this property to specify themaximum number of events that canbe queued between the non nativeprocess and the ObjectServer.


Note: You can increase this numberto increase the event throughputwhen a large number of events isgenerated.




Description

NbEventsStore Recoveryinteger

-nbeventsstorerecovery integer

Use this property to specify thefrequency (in events) with which theprobe stores the MTOSI_osTime in therecovery file.

The default is 100 (every 100 events).

Note: This property is only used byAlcatel-Lucent SAM versions R5.0,R6.0, R6.1, R7, R8 and R9.

Optimize integer -optimize integer Use this property to specify whetherthe probe optimizes performance:

0: The probe does not optimizeperformance.

1: The probe optimizes performanceby writing neither events receivedfrom the HTTP request nor JMSevents to the log file.

The default is 1.

Note: This property is only used byAlcatel-Lucent SAM versions R5.0,R6.0, R6.1, R7, R8 and R9.

ParseSaxDebug integer -parsesaxdebuginteger

Use this property to specify thewhether the probe outputs extradebug information from the SAXParser.

The default is 0.

Note: Use this option for debugpurposes only.

PersistentJmsId string -persistentjmsidstring

Use this property to specify the ID ofthe JMS subscription.

The default is [email protected].

ReconnectionAttempts integer -reconnectionattemptsinteger

Use this property to specify themaximum number of times that theprobe attempts to reconnect to theAlcatel-Lucent 5620 SAM serverfollowing unexpected inactivity fromthe Java Messaging Service.

The default is -1.

ReconnectionInterval integer -reconnectionintervalinteger

Use this property to specify the time(in seconds) between successivereconnection attempts to theAlcatel-Lucent 5620 SAM server.

The default is 300.




Description

RecoveryFile string -recoveryfile string Use this property to specify thename of the recovery file in whichthe probe stores the timestamp of thelast keepAlive event read beforedisconnecting from theAlcatel-Lucent 5620 SAM server. Theprobe uses this when reconnecting tothe server.

The default is /$OMNIHOME/var/AlcatelSamRecovery.Note: You should backup therecovery file when switching to anew machine.

SAMServerPassword string -samserverpasswordstring

Use this property to specify thepassword required with theSAMServerUserName property to log into the JMS.

The default is "".

SAMServerUserName string -samserverusernamestring

Use this property to specify the username with which the probe logs into the JMS.

The default is "".

SizeBlockRead integer -sizeblockreadinteger

Use this property to specify thenumber of alarms in one block thatthe probe reads duringresynchronization.

The default is 50.

StoreEvents integer -storeevents integer Use this property to specify AlcatelSAM to continue to store events afterit has been stopped with the CTRL-Ccommand.

0: Alcatel SAM does not store eventsafter a CTRL-C stop.

1: Alcatel SAM stores events after aCTRL-C stop.

The default is 1.

TrustStore string -truststore string Use this property to specify the filepath of the truststore file.

The default is "".

TrustStorePassword string -truststorepasswordstring

Use this property to specify thepassword required to access thetruststore file containing the trustedcertificates.

The default is "".




Description

UseSSL string -usessl string Use this property to enable SSLauthentication when connecting tothe SAM server. This property takesthe following values:

false: SSL is not used whenconnecting to the SAM server.

true: SSL is used when connecting tothe SAM server.

The default is false.

Note: If UseSSL is set to true, theHTTPPort property must beconfigured to use the Alcatel SAMHTTPS port. The default AlcatelSAM HTTPS port is 8443. You mustalso configure the followingproperties for the Probe forAlcatel-Lucent 5620 SAM:

v CertificateStoreType

v CertificateStore

v CertificateStorePassword

v TrustStore

v TrustStorePassword

XMLFile string -xmlfile string Use this property to specify the XMLfile that the probe reads to check theSAX parser.

The default is "".


XMLFileRead integer -xmlread integer Use this property to specify whetherthe probe reads an XML file to checkthe SAX parser. This property takesthe following values:

0: The probe does not read an XMLfile.

1: The probe reads the XML filespecified by the XMLFile property.

The default is 0.





Description

XMLretrieve integer -xmlretrieve integer Use this property to specify whetherthe probe starts with an XML requestto retrieve current alarms prior toconnection with the JMS. Thisproperty takes the following values:

0: The probe does not start with anXML retrieve request.

1: The probe starts with an XMLretrieve request.

The default is 1.Note: If the probe needs toreconnect, it invokes the XMLretrieve request on reconnect.

XMLretrieveUseInServiceinteger

-xmlretrieveuseinservice integer

Use this property to specify whetherthe probe receives alarms from thenodes that are in either inService orinMaintenance mode. This propertytakes the following values:

0: The probe receives alarms from allthe nodes.

1: The probe receives alarms onlyfrom the nodes that are in theinService mode.

The default is 0.

Note: This property is only validfor Alcatel-Lucent 5620 SAM version6.0 and 6.1.

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.

This section describes the elements that the Probe for Alcatel-Lucent 5620 SAMgenerates. The elements that are generated depend on whether you are runningAlcatel-Lucent 5620 SAM version R4.0, R5.0, R6.0, or R6.1.


Common elementsThe probe generates a common set of elements for each event that it receives.

The following table describes the elements that are generated for all events.

Table 8. Common elements

Element name Element description

$ALA_allomorphic This element contains the allomorphic class of theobject.

$ALA_category This element shows the category of the message, forexample, FAULT.

$ALA_clientId This element contains the client identifier for themessage.

$correlationId This element contains the correlation identifier forthe related messages.

$eventName This element shows the type of event, for example,an attribute value change.

$MTOSI_NTType This element shows the notification type of themessage, for example, NT_ALARM.

$MTOSI_objectName This element contains the object full nameassociated with the event.

$MTOSI_objectType This element indicates the object type for themessage, for example, fm.AlarmObject.

$MTOSI_osTime This element shows the time that the message wascreated.

Alarm event elementsThe probe generates a standard set of elements for each alarm event that itreceives.

The following table describes the elements that are generated for alarm eventelements.

Table 9. Alarm event elements


$ALA_alarmType This element indicates the alarm type.

$ALA_OLC This element indicates the OLC state of the objectassociated to the event. A value of zero (0) indicatesno state for the object.

$ALA_application This element shows the tag associated with theapplication.

$ALA_span This element contains the span of control ID list.

$ALA_isCorr This element shows the isCorrelated flag. A valueof true indicates that the alarm is correlated at thecreation time to another alarm.

$MTOSI_aliasNameList This element indicates the alias for the alarm name.

$MTOSI_perceivedSeverity This element indicates the severity of the alarm.

$MTOSI_probableCause This element identifies the probable cause of thealarm.


Table 9. Alarm event elements (continued)


$MTOSI_serviceAffecting This element contains the identifies whether thealarm is service affecting.

Attribute value change event elementsAn attribute value change alarm indicates changes occurred to a particularproblem alarm that the probe received earlier. Based on the indicated changes, theprobe generates a standard set of elements for each attribute value change eventthat it receives.

The probe performs the following if the attribute value change alarm indicates thatthe severity field is updated with a value other than cleared in Attribute4:v deduplicates the problem alarm.v updates severity of the problem alarm with the latest value.v increments the count of the problem alarm by 1.

The probe performs the following if the attribute value change alarm indicates thatthe severity field is updated with a cleared value in Attribute4:v makes the attribute value change alarm as a new resolution alarm in the event

list. This action is performed as per the Netcool/OMNIbus generic clearstandards.

v clears both the problem alarm and the resolution alarm.

It is possible that the probe may receive another attribute value change alarmbefore the problem alarm get cleared. If this new attribute value change alarmindicates that the severity field is updated with a value other than cleared inAttribute4, then the probe performs the following:v deduplicates the problem alarm.v updates severity of the problem alarm with the latest value.v increments the count of the problem alarm by 1.

It is The probe performs the following if the attribute value change alarm indicatesthat attributes other than the severity field are updated in Attribute4:v deduplicates the problem alarm.v keeps the severity field with its current value.v increments the count of the problem alarm by 1.

The following table describes the elements that are generated for attribute valuechange events.

Table 10. Attribute value change event elements


$avc_n This element shows the attribute changed and itsassociated value.

$objectFullName This element contains the name of the object whoseattributes changed.


State change event elementsThe probe generates a standard set of elements for each state change event that itreceives.

The following table describes the elements that are generated for state changeevent elements.

Table 11. State change event elements


$maxAlarmCount This element shows the maximum alarm count.

$state This element indicates the state that changed.

$sysPrimaryIp This element shows the primary IP address of thesystem.

$sysStandbyIp This element shows the standby IP address of thesystem.

$sysStartTime This element shows the time that the system startedup.

Alarm status change event elementsThe probe generates a standard set of elements for each alarm status change eventthat it receives.

The following table describes the elements that are generated for alarm statuschange event elements.

Table 12. Alarm status change event elements


$Attributen This element contains the attribute changed and itsassociated value.

$objectFullName This element shows the name of the object whosealarm status has changed.

$olcState This element indicates whether the alarm isgenerated when the node is in inService orinMaintenance mode.

$spanObjectPointer This element identifies the span of object pointer.

$correlatingAlarm This element indicates whether the alarm has acorrelating alarm.

$isImplicitlyCleared This element indicates whether the alarm isimplicitly cleared.

$numberOfCorrelatedAlarms This element shows the number of alarms correlatedto the alarm.


Object deletion event elementsThe probe generates a single element for each database proxy state change eventthat it receives.

The following table describes the element that is generated for object deletionevent elements.

Table 13. Object deletion event elements


$objectFullName This element shows the name of the object deleted.

Relationship change event elementsThe probe generates a standard set of elements for each relationship change eventthat it receives.

The following table describes the elements that are generated for relationshipchange event elements.

Table 14. Relation change event elements


$changeType This element shows the type of change.

$fromObjectClass This element contains the class of the original object.

$fromObjectName This element identifies the name of the originalobject.

$objectFullName This element identifies the name of the object with achanged relationship.

$toObjectClass This element contains the class of the new object.

$toObjectName This element shows the name of the new object.

Elements generated for object creation eventsThe probe generates a standard set of elements for each object creation event that itreceives.

The following table describes the elements generated when alarm informationobjects are created.

Table 15. Elements for object creation events


$acknowledgedBy This element contains the name of the operator thatacknowledged the alarm.

$additionalText This element contains the additional descriptiveinformation about the alarm.

$affectedObjectClassIndex This element indicates the identifier of the managedobject class.

$affectedObjectClassName This element contains the name of the managedobject class to which the object with the alarmbelongs.

$affectedObjectDisplayedName This element contains the text version name of thealarm’s affected object.


Table 15. Elements for object creation events (continued)


$affectedObjectFullName This element contains the fully distinguished nameof the object against which the alarm was raised.

$affectedObjectInstanceIndex This element indicates the identifier of the managedobject instance.

$alarmClassTag This element shows the object class against whichthe alarm was raised.

$alarmName This element contains the alarm name.

$alarmType This element shows the vendor-specific and X.733standards for the type of the alarm.

$firstTimeDetected This element shows the date and time the alarmwas first raised.

$highestSeverity This element identifies the highest severity value ofthe alarm since it was generated.

$isAcknowledged This element indicates whether the alarm iscurrently acknowledged by an operator.

$isServiceAffecting This element indicates whether an alarm hasaffected a customer’s service.

$lastTimeAcknowledged This element shows the date and time at which thealarm was acknowledged.

$lastTimeCleared This element shows the date and time at which thealarm was cleared.

$lastTimeDeEscalated This element shows the date and time at which thealarm was de-escalated.

$lastTimeDemoted This element shows the date and time at which thealarm was demoted.

$lastTimeDetected This element shows the date and time the alarmwas most recently observed.

$lastTimeEscalated This element shows the date and time at which thealarm was escalated.

$lastTimePromoted This element shows the date and time at which thealarm was promoted.

$lastTimeSeverityChanged This element shows the date and time at which thealarm was cleared.

$nodeId This element contains the IP address of the routerthat issued the alarm and contains the affectedobject.

$nodeName This element contains the text version name of therouter that issued the alarm and contains theaffected object.

$numberOfOccurrences This element indicates the number of times thealarm has been raised.

$numberOfOccurrencesSinceAck This element indicates the number of times thealarm has been raised since it was acknowledged.

$numberOfOccurrencesSinceClear This element indicates the number of times thealarm has been raised since it was cleared.


Table 15. Elements for object creation events (continued)


$operatorAssignedUrgency This element indicates the urgency setting of thealarm as determined by the user-configured valueset for the alarm. The possible values are:

0: Unspecified

1: Indeterminate

2: Minor

3: Major

4: Critical

$originalSeverity This element shows the severity of the alarm whenit was first raised.

$previousSeverity This element shows the severity value of the alarmprevious to the current value.

$probableCause This element shows the vendor-specific and X.733standards for the probable cause of the alarm.

$relatedObject This element contains the list of fully distinguishednames that point to other objects that are alsoaffected by a particular alarm.

$severity This element shows the vendor-specific, TMN, andX.733 standards for severity of the alarm. Thepossible values are:

0: Unspecified

1: Cleared

2: Indeterminate

3: Info

4: Condition

5: Warning

6: Minor

7: Major

8: Critical

$urgencyAssignedBy This element contains the name of the operator thatlast modified the urgency of the alarm.

$wasAcknowledged This element indicates whether the alarm has everbeen acknowledged by an operator.


Client session event elementsThe probe generates a single element for each client session event that it receives.

The following table describe the element that is generated for client session eventelements.

Table 16. Client session event elements


$clientId This element shows the identifier of the client in thissession.

File available event elementsThe probe generates a standard set of elements for file available event that itreceives.

The following table describes the elements that are generated for file availableevent elements.

Table 17. File available event elements


$fileName This element contains the name of the file required.

$requestId This element shows the identifier of the request.

Database activity event elementsThe probe generates a single element for each database activity event that itreceives.

The following table describes the element that is generated for database activityevent elements.

Table 18. Database activity event elements


$state This element shows the state associated with thedatabase activity.

Database connection state change event elementsThe probe generates a single element for each database connection state changeevent that it receives.

The following table describes the element that is generated for database connectionstate change event elements.

Table 19. Database connection state change event elements


$state This element indicates the state of the databaseconnection.


Database error event elementsThe probe generates a standard set of elements for each database error event that itreceives.

The following table describes the elements that are generated for database errorevent elements.

Table 20. Database error event elements


$error This element shows the description of the error.

$state This element identifies the database error state.

Database proxy state change event elementsThe probe generates a single element for each database proxy state change eventthat it receives.

The following table describes the element that is generated for database proxy statechange event elements.

Table 21. Database proxy state change event elements


$state This element indicates the state of the databaseproxy.

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 Netcool/OMNIbus error messages, see the IBM TivoliNetcool/OMNIbus Probe and Gateway Guide.

Table 22. Error messages

Error Description Action

Error from parser inreading input xml

There was a problem readinga line of XML from theAlcatel-Lucent 5620 SAMSever.

Check that the server isrunning correctly.

Error in parsing There was a error generatedby the SAX Parser.

Check that the SAX Parser isrunning correctly.

Failed to connect to theObjectManager

The probe cannot find theObjectManager reference inthe naming host.

Check that the ObjectManageris correctly registered with thedefined Naming Service.

Failed to create a URLconnection Object

The probe failed to create oropen an HTTP connection tothe Alcatel-Lucent 5620 SAMService.

Check that the server isrunning. Check the connectionto the host machine on whichthe server is running.

Failed to get properties The probe could not accessthe properties file.

Check the location of andpermissions set for theproperties file.


Table 22. Error messages (continued)

Error Description Action

Failed to make HTTPconnection to host

The probe was unable toconnect to the port specifiedby the HTTPPort property.

Check that you have specifiedthe correct port in theproperties file.

JNDI API lookup failed The probe failed to create atopicConnectionFactoryobject with which to connectto the JMS.

Contact IBM Software Support.

Unsuccessful attempt toto create default tokens

Unsuccessful attempt toset element_name element

The probe failed to create atoken from the alarm. Thisindicates a parsing error.

Contact IBM Software Support.

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 ProbeWatch messages that the probe generates.For information about generic Netcool/OMNIbus ProbeWatch messages, see theIBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 23. ProbeWatch messages

ProbeWatch message Description Triggers/causes

Could not find JNDIcontext topic topic_name

There was an error when theprobe attempted to connect tothe SAM server.

The JMS did not start properlyon the SAM server.

Failed to establish HTTPconnection

The probe has failed toestablish an HTTP connectionto the SAM server.

The probe failed to connect tothe port specified by theHTTPPort.

Going Down The probe is shutting down. The probe is shutting downafter performing the shutdownroutine.

JNDI API lookup failed There was an error when theprobe attempted to connect tothe SAM server.

The JMS did not start properlyon the SAM server.

No keepAlive event fornumber seconds

The probe has not receivedany events from the JMS forthe period specified by theAliveTimeout property.

The probe has stoppedreceiving events from the JMS.

Running ... The probe is runningnormally.

The probe has just been startedup.


TroubleshootingVarious issues arise as users work with the probe. Troubleshooting information isprovided to help you diagnose and resolve such issues.

Probe is missing some events and how to resolve it?

Part of the value set for the JmsFilter property includes the value set for thePersistentJmsId property. So, the probe will not work properly if the JmsFilterproperty is not updated after changing the value of the PersistentJmsId property.When the probe encounters this issue, the following debug message appears in thelogfile:

Debug: SAM: Sleeping until receiving the Sam server’s data?

To resolve this problem, set the JMS filter and the JMS ID to the same IP addressor host name, and not to a combination of local host and IP or host name.


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, 2012 33

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.

Appendix. Notices and Trademarks 35

��

Printed in USA

SC23-7663-09

IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 ... · The Alcatel-Lucent 5620 Service...

Documents

Transcript of IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent 5620 ... · The Alcatel-Lucent 5620 Service...