ibm tivoli netcool/omnibus probe for huawei u2000

IBM® Tivoli® Netcool/OMNIbus Probe forHuawei U20005.0

Reference GuideOctober 15, 2015

IBM

SC27-2725-06

Notice

Before using this information and the product it supports, read the information in Appendix A, “Noticesand Trademarks,” on page 23.

Edition notice

This edition (SC27-2725-06) applies to version 5.0 of the IBM Tivoli Netcool/OMNIbus Probe for Huawei U2000 and toall subsequent releases and modifications until otherwise indicated in new editions.

This edition replaces SC27-2725-05.© Copyright International Business Machines Corporation 2010, 2015.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract withIBM Corp.

Contents

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

Chapter 1. Probe for Huawei U2000....................................................................... 1Summary...................................................................................................................................................... 1Installing probes.......................................................................................................................................... 2Configuring the probe.................................................................................................................................. 3

Configuring SSL connections..................................................................................................................3Huawei U2000 authentication lock-out...................................................................................................... 5Running the probe........................................................................................................................................5Data acquisition........................................................................................................................................... 5

Specifying filtering operations for resychronization..............................................................................5Command line interface....................................................................................................................... 11Peer-to-peer failover functionality...................................................................................................... 12

Properties and command line options...................................................................................................... 12Elements.................................................................................................................................................... 18Error messages.......................................................................................................................................... 20ProbeWatch messages.............................................................................................................................. 21Known issues............................................................................................................................................. 22

Appendix A. Notices and Trademarks................................................................... 23Notices....................................................................................................................................................... 23Trademarks................................................................................................................................................ 24

iii

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 Huawei U2000 documentation is provided in softcopy formatonly. To obtain the most recent version, visit the IBM® Tivoli® Knowledge Center:

https://www.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/common/Probes.html

Table 1. Document modification history

Documentversion

Publicationdate

Comments

SC27-2725-00 February 19,2010

First IBM publication.

SC27-2725-01 June 4, 2010 “Summary” on page 1 updated.

Description for the resyncAll command added to “Command lineinterface” on page 11

Descriptions for the following properties added to “Properties andcommand line options” on page 12:

• ProbeKeyStore• ProbeKeyStorePassword• ResynchBatchSize• TrustedCertsStore• TrustedCertsStorePassword

SC27-2725-02 October 3,2010

“Summary” on page 1 updated.

Descriptions for the following properties added to “Properties andcommand line options” on page 12:

• EnableEndPointFailover• SecondaryTransportFile• SecondaryTransportType• SecondaryResyncHTTPConnectionURL• SecondaryUpdateHTTPConnectionURL

SC27-2725-03 March 31,2011

Installation section replaced by “Installing probes” on page 2.

© Copyright IBM Corp. 2010, 2015 v

https://www.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/probes/common/Probes.html

Table 1. Document modification history (continued)

Documentversion

Publicationdate

Comments

SC27-2725-04 May 11, 2012 Information about operating system conventions added in“Conventions used in this guide” on page vi.

Multicultural support information added in “Summary” on page1.

SSL configuration information updated in “Configuring SSLconnections” on page 3.

Information about running the probe added in “Running the probe”on page 5.

SC27-2725-05 November 7,2014

Summary updated.

SC27-2725-06 October 15,2015

“Summary” on page 1 updated.

Description of the SecurityProtocol property has been added toProperties and Command line options on page 13.

Enhancements: Version 5 of the Probe for Huawei U2000 includesthe following enhancement:

RFE 70546: Support for TLSv1.2 Security Protocol added.

Conventions used in this guideAll probe guides use standard conventions for operating system-dependent environment variables anddirectory paths.

Operating system-dependent variables and pathsAll probe guides use standard conventions for specifying environment variables and describing directorypaths, depending on what operating systems the probe is supported on.

For probes supported on UNIX and Linux operating systems, probe guides use the standard UNIXconventions such as $variable for environment variables and forward slashes (/) in directory paths. Forexample:

$OMNIHOME/probes

For probes supported only on Windows operating systems, probe guides use the standard Windowsconventions such as %variable% for environment variables and backward slashes (\) in directory paths.For example:

%OMNIHOME%\probes

For probes supported on UNIX, Linux, and Windows operating systems, probe guides use the standardUNIX conventions for specifying environment variables and describing directory paths. When using theWindows command line with these 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 the UNIX conventions.

Note : The names of environment variables are not always the same in Windows and UNIX environments.For example, %TEMP% in Windows environments is equivalent to $TMPDIR in UNIX and Linuxenvironments. Where such variables are described in the guide, both the UNIX and Windows conventionswill be used.

vi IBM Tivoli Netcool/OMNIbus Probe for Huawei U2000: Reference Guide

Operating system-specific directory namesWhere Tivoli Netcool/OMNIbus files are identified as located within an arch directory under NCHOME orOMNIHOME, arch is a variable that represents your operating 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 the table.

Table 2. Directory names for the arch variable

Operating system Directory name represented by arch

AIX® systems aix5

Red Hat Linux® and SUSE systems linux2x86

Linux for System z linux2s390

Solaris systems solaris2

Windows systems win32

OMNIHOME locationProbes and older versions of Tivoli Netcool/OMNIbus use the OMNIHOME environment variable in manyconfiguration files. Set the value of OMNIHOME as follows:

• On UNIX and Linux, set $OMNIHOME to $NCHOME/omnibus.• On Windows, set %OMNIHOME% to %NCHOME%\omnibus.

About this guide vii

viii IBM Tivoli Netcool/OMNIbus Probe for Huawei U2000: Reference Guide

Chapter 1. Probe for Huawei U2000

The Huawei U2000 is a unified network management system that provides both element managementand network management functions for telecommunications networks. The probe acquires XMLmessages from the system using a secure JMS and Webservices connection, and then stores them asevent records in the Netcool/OMNIbus ObjectServer.

The probe is described in the following topics:

• “Summary” on page 1• “Installing probes” on page 2• “Configuring the probe” on page 3• “Huawei U2000 authentication lock-out” on page 5• “Running the probe” on page 5• “Data acquisition” on page 5• “Properties and command line options” on page 12• “Elements” on page 18• “Error messages” on page 20• “ProbeWatch messages” on page 21• “Known issues” on page 22

SummaryEach probe works in a different way to acquire event data from its source, and therefore has specificfeatures, default values, and changeable properties. Use this summary information to learn about thisprobe.

The following table provides a summary of the Probe for Huawei U2000.

Table 3. Summary

Probe target Huawei iManager U2000 MTOSI Release 2.0

Probe executable name nco_p_u2000

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

Package version 5.0

Probe supported on For details of supported operating systems, see the followingRelease Notice on the IBM Software Support website:

http://www.ibm.com/support/docview.wss?uid=swg21432738

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

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

Requirements For details of any additional software that this probe requires,refer to the description.txt file that is supplied in itsdownload package.

© Copyright IBM Corp. 2010, 2015 1

http://www.ibm.com/support/docview.wss?uid=swg21432738

Table 3. Summary (continued)

Connection method JMS and HTTP

Secure JMS and Webservices (XMLover HTTP) remote connectivity

The Probe for Huawei U2000 can connect to a device on aremote host.

Multicultural support Not Available

Peer-to-peer failover functionality Available

IP environment IPv4 and IPv6

Note : The probe is supported on IPv6 when running on IBMTivoli Netcool/OMNIbus 7.4.0.

Federal Information ProcessingStandards (FIPS)

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

Installing probesAll probes are installed in a similar way. The process involves downloading the appropriate installationpackage for your operating system, installing the appropriate files for the version of Netcool/OMNIbusthat you are running, and configuring 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 system supported. For details abouthow to locate and download the installation package for your operating system, visit the following pageon the IBM Tivoli Knowledge 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 supported versions of Netcool/OMNIbus.For details about how to install the probe to run with your version of Netcool/OMNIbus, visit thefollowing page on the IBM 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 this probe. It combines topicsthat are common to all probes and topics that are peculiar to this probe. For details about additionalconfiguration that is common to all probes, see the IBM Tivoli Netcool/OMNIbus Probe and GatewayGuide.

2 IBM Tivoli Netcool/OMNIbus Probe for Huawei U2000: 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





Configuring the probeBefore running the probe, you must perform the configuration steps described in this topic.

Install Apache ActiveMQ1. Download Apache ActiveMQ version 5.2.0 from the following website:

http://activemq.apache.org/download.html2. Copy the activemq-all-5.2.0.jar file to the $OMNIHOME/probes/java directory.

Configure the JMS transport propertiesEdit the jmsTransport.properties file located in the $OMNIHOME/java/conf directory, and specifyvalues for the following properties:

• providerURL: Set this property to the URL of the JMS provider.• queueName: Set this property to the name of a queue on which to receive messages.• queueConnectionFactory: Set this property to the identifier of the queue connection factory for the

JMS.• topicName: Set this property to the name of a topic to listen on for messages.• topicConnectionFactory: Set this property to the identifier of the topic connection factory for the

JMS.• username: Set this property to the user name of the JMS.• password: Set this property to the password of the JMS.• initialContextFactory: Set this property to the name of the JMS provider's context factory class.

As the probe is making use of ActiveMQ as the JMS broker, this property injmsTransport.properties should be set to the following:

initialContextFactory=org.apache.activemq.jndi. ActiveMQInitialContextFactory

You need to set initialContextFactory (the name of the JMS provider's context factory class)

Configure the probe propertiesSpecify values for the following probe properties:

• ResyncHTTPConnectionURL: Set this property to the URL of the initial HTTP resynchronizationconnection used by the Huawei U2000 server.

• UpdateHTTPConnectionURL: Set this property to the URL of the HTTP connection which is used toupdate alarms on the Huawei U2000 server.

• ResyncFilterFile: Specify the filter used for resynchronization operations.

Configuring SSL connectionsYou can enable Secure Socket Layer (SSL) encryption of data exchanged over JMS and HTTP.

To enable SSL encryption, use the following steps:

1. Use the following Java keytool command to generate a key pair for the probe, along with a keystorefile and its associated password:

keytool -genkey -alias alias_id -keystore $OMNIHOME/java/conf/trusted_keystore.jks -storepass password

2. When prompted, enter the following details:

• First and Last Name: U2000 probe at server_hostname• Organizational Unit: Netcool/OMNIbus Organization IBM

Chapter 1. Probe for Huawei U2000 3

http://activemq.apache.org/download.html

• Organization: IBM• City: N/A• State: N/A• Country: US• Enter key password: To use the same password that you specified for the keystore password,

press ENTER without entering any characters at this prompt.3. For each server where an instance of the probe is installed, generate an X.509 self-signed certificate

for the probe using the following command:

keytool -selfcert -alias alias_id -keystore $OMNIHOME/java/conf/trusted_keystore.jks -storepass password

4. For each server where an instance of the probe is installed, generate and export a certificate file forthe probe (probe_cert_filename.cer) using the following command:

keytool -export -alias alias_id -keystore $OMNIHOME/java/conf/trusted_keystore.jks -storepass password -file probe_cert_filename.cer

Use a unique alias_id value and probe_cert_filename value for each certificate file.5. Manually transport each certificate file generated in step 4 to the Huawei U2000 server.6. Import each certificate file generated in step 4 to the Huawei U2000 server. Consult your Huawei

documentation for instructions about importing certificate files into the Huawei U2000 system.7. Obtain and export the Huawei U2000 system certificate file (huawei_cert_filename.cer).

Consult your Huawei documentation for instructions about exporting certificate files from the HuaweiU2000 system.

8. For each server where an instance of the probe is installed, import the Huawei U2000 systemcertificate (huawei_cert_filename.cer) using the following command:

keytool -import -alias alias_id -file huawei_cert_filename.cer -keystore$OMNIHOME/java/conf/trusted_keystore.jks -storepass password

Note : If the HTTP interface and the JMS interface of Huawei U2000 do not share the samecertificate, repeat steps 7 and 8 for both the HTTP and JMS interface certificates of the HuaweiU2000 system.

9. Specify values for the following probe properties, using the same Java keystore file as both a keystore and a trusted certificates store, and using the same password for each file:

• ProbeKeyStore: Specify the location of the trusted_keystore.jks file.• ProbeKeyStorePassword: Specify an unencrypted password for the trusted_keystore.jksfile.

• TrustedCertsStore: Specify the location of the trusted_keystore.jks file.• TrustedCertsStorePassword: Specify the same unencrypted password you used for theProbeKeyStorePassword property.

Note : If the keystore file does not require a password, set the ProbeKeyStorePassword propertyto "".

10. For SSL connections over a HTTP interface, the values that you specify for theResyncHTTPConnectionURL and UpdateHTTPConnectionURL properties must begin with httpsinstead of the default http. For example:

https://217.0.0.1/AlarmHandling/updateAlarms11. In the jmsTransport.properties file (located in the $OMNIHOME/java/conf directory), change

the default value of the providerURL property to the following value:

ssl://IP_address:61617

The probe is now enabled to use SSL connections for exchanging data with the Huawei U2000 systemover JMS and HTTP.


Huawei U2000 authentication lock-outThe Huawei U2000 system is normally configured to temporarily lock a user account for period of time ifincorrect authentication information is repeatedly provided.

If the Probe for Huawei U2000 is configured to automatically retry authentication, and if the incorrectuser name or password is specified, the Huawei U2000 system will lock the account. When you havecorrected the user name and password, the probe will still need to wait for the lock-out period to expirebefore the connection can be reestablished.

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

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

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

Data acquisitionEach probe uses a different method to acquire data. Which method the probe uses depends on the targetsystem from which it receives data.

The Probe for Huawei U2000 gathers events from Huawei U2000 using a secure JMS and Webservicesconnection, and then stores them as event records in the Netcool/OMNIbus ObjectServer.

Data acquisition is further described in the following topics:

• “Specifying filtering operations for resychronization” on page 5• “Command line interface” on page 11• “Peer-to-peer failover functionality” on page 12

Specifying filtering operations for resychronizationDuring resynchronization, the probe can perform various filtering operations, the details of which aredefined in the filter file specified by the ResyncFilterFile property.

Simple filtersSimple filters use the following syntax:

<v11:filter> <v11:attributeNameList> <v13:attributeName>POSSIBLE_VALUE</v13:attributeName> </v11:attributeNameList> </v11:filter>

Where attributeName is one of the event attributes listed in the table below, and POSSIBLE_VALUE isone of the values listed for that attribute.

The following example code shows how to use the filter file to select for resynchronization all thoseevents that have a perceivedSeverity of MINOR:

<v11:filter> <v11:perceivedSeverityList> <v13:perceivedSeverity>MINOR</v13:perceivedSeverity> </v11:perceivedSeverityList> </v11:filter>




More complex filtersComplex filters use the following syntax:

<v11:filter> <v11:source>AlarmSourceType</v11:source> <v11:scope> <v12:name> <v12:rdn> <v12:type></v12:type> <v12:value></v12:value> </v12:rdn> </v12:name> </v11:scope>

<v11:attributeNameList> <v13:attributeName>POSSIBLE_VALUE</v13:attributeName> <v13:attributeName>POSSIBLE_VALUE</v13:attributeName> </v11:attributeNameList>

<v11:probableCauseList> <v14:prc extension="?" qualifier="?"> <v14:ru>false</v14:ru> <v14:contra>false</v14:contra> <v14:probableCause>PROBABLE_CAUSE</v14:probableCause> </v14:prc> </v11:probableCauseList>

<v11:acknowledgeIndication>ACKNOWLEDGEMENT_STATUS</v11:acknowledgeIndication></v11:filter>

The following example code shows how to use the filter file to select for resynchronization only thosealarms generated by Huawei U2000, that have a perceivedSeverity of either WARNING, or MINOR, andwhose probable cause is transmission failure.

<v11:filter> <v11:source>INTERNAL</v11:source> <v11:scope> <v12:name> <v12:rdn> <v12:type>MD</v12:type> <v12:value>Huawei/U2000</v12:value> </v12:rdn> </v12:name> </v11:scope>

<v11:perceivedSeverityList> <v13:perceivedSeverity>WARNING</v13:perceivedSeverity> <v13:perceivedSeverity>MINOR</v13:perceivedSeverity> </v11:perceivedSeverityList>

<v11:probableCauseList> <v14:prc extension="?" qualifier="?"> <v14:ru>false</v14:ru> <v14:contra>false</v14:contra> <v14:probableCause>TX_FAIL</v14:probableCause> </v14:prc> </v11:probableCauseList>

<v11:acknowledgeIndication>?</v11:AI_EVENT_UNACKNOWLEDGED>

</v11:filter>

Attribute names and their corresponding values

The following table shows all the attributes that you can use within filter files, and their correspondingpossible values.


Table 4. Filter attributes and associated values

Attribute name Possible values

AcknowledgeIndicationType • ACKNOWLEDGED• UNACKNOWLEDGED• NOT_APPLICABLE

AssignedSeverityEnumType • INDETERMINATE• CRITICAL• MAJOR• MINOR• WARNING• NOT_ALARMED• FREE_CHOICE

EquipmentProtectionGroupTypeEnumType • MINOR_EXT• M_FOR_N• M:N• EPG_1_PLUS_1• EPG_INBD_1_PLUS_1• EPG_1_FOR_N• BPS

EquipmentSwitchReasonEnumType • MINOR_EXT• VENDOR_EXT• NOT_APPLICABLE• FAILURE• MANUAL

G_774_3_APSfunctionEnumType • MINOR_EXT• VENDOR_EXT• G.783• Legacy

PerceivedSeverity • INDETERMINATE• CRITICAL• MAJOR• MINOR• WARNING• CLEARED


Table 4. Filter attributes and associated values (continued)

Attribute name Possible values

ProtectionGroupTypeEnumType • MINOR_EXT• PGT_MSP_1_PLUS_1• PGT_MSP_1_FOR_N• PGT_2_FIBER_BLSR• PGT_4_FIBER_BLSR• PGT_1VN• PGT_1P1• PGT_UNKNOWN

ProtectionTypeEnumType • MINOR_EXT• VENDOR_EXT• MSP_APS• PGT_MSP_1_PLUS_1• PGT_MSP_1_FOR_N• PGT_2_FIBER_BLSR• PGT_4_FIBER_BLSR• PT_SNCP• PT_UNKNOWN

ServiceAffectingType • UNKNOWN• SERVICE_AFFECTING• NON_SERVICE_AFFECTING

SwitchReasonType • NOT_APPLICABLE• RESTORED• SIGNAL_FAIL• SIGNAL_MISMATCH• SIGNAL_DEGRADE• AUTOMATIC_SWITCH• MANUAL

ReversionModeType • UNKNOWN• NON_REVERTIVE• REVERTIVE

The following table shows a list of attributes that you can use within complex filter files, and theircorresponding possible values.


Table 5. Complex filter attributes and associated values

Name Type Description Example

source AlarmSourceType Use this attribute to filter thealarms based on whether thealarm is a U2000 alarm. Theattribute can be set to one ofthe following values:

INTERNAL: The probe filtersthe alarms for U2000 alarms.

NOT_APPLICABLE or omitted:The probe does not filter onalarm source type.

Note : When you query aU2000 alarm, the sourceparameter should beINTERNAL.

<v11:source>INTERNAL</v11:source>

scope NamingAttributeListType

Use this attribute to filter thealarms based on specificmanaged elements. If nomanaged element is specified,alarms from all managedelements are selected.

Note : The specified valuemust be the MTOSI objectname of a network element.

When an network elementname is specified, it indicatesthe equipment from whichalarms are queried.

<v11:scope> <v12:name> <v12:rdn> <v12:type>MD</v12:type><v12:value>Huawei/U2000</v12:value> </v12:rdn> </v12:name></v11:scope>

perceivedSeverityList

PerceivedSeverity ListType

Use this attribute to filter thealarms based on a specifiedlevel of severity. This can beset to one of the followingvalues:

• CRITICAL• MAJOR• MINOR• WARNING

<v11:perceivedSeverityList><v13:perceivedSeverity>WARNING<v13:perceivedSeverity> <v13:perceivedSeverity>MINOR<v13:perceivedSeverity> </v11:perceivedSeverityList>


Table 5. Complex filter attributes and associated values (continued)


probableCauseList

ProbableCauseList Type

Use this attribute to filter thealarms based on a list ofprobable causes. If noprobable causes are specified,all alarms will be selected forresynchronization.

Note : You can specify any ofthe standard MTOSI probablecause descriptions. Fordetails, see the TM ForumMTOSI web site.

<v11:probableCauseList> <v14:prc> <v14:ru>false</v14:ru>

<v14:contra>false</v14:contra

<v14:probableCause>TX_FAIL</v14:probableCause></ v14:prc></v11:probableCauseList>

ru ProbableCauseList Type

The following sub-attribute isdefined for each probablecause:

ru: The Remote Unit (RU)parameter is used to indicatethe location of the networkresource associated with thealarm probable cause:

false: The alarm isassociated with a localnetwork resource.

true: The alarm is associatedwith a remote networkresource.

contra ProbableCauseList Type

The following sub-attribute isdefined for each probablecause:

contra: This parameter isused to distinguish thedirection of the signal relatedalarm:

false: The alarm is detectedon the signal related to thesink atomic function.

true: The alarm is detectedon the signal related to thesource atomic function.


Table 5. Complex filter attributes and associated values (continued)


acknowledgeIndication

AcknowledgeIndicationType

Use this attribute to filter thealarms based on theacknowledgement status. Theattribute can be set to one ofthe following values:

AI_EVENT_ACKNOWLEDGED:Acknowledged.

AI_EVENT_UNACKNOWLEDGED:Unacknowledged.

NOT_APPLICABLE:unknown.

<v11:acknowledgeIndication>AI_EVENT_UNACKNOWLEDGED</v11:acknowledgeIndication>

Command line interfaceThe Probe for Huawei U2000 is supplied with a Command Line Interface (CLI). This interface allows youto execute commands using the probe (for example, to acknowledge alarms or unacknowledge events inHuawei U2000).

To use the CLI, you must use the CommandPort property in the properties file to specify a port throughwhich commands will be sent. When you want to execute commands, telnet to this port.

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

Table 6. CLI commands

Command Description

exit/quit Use this command to close the connection.

help Use this command to display online help about the CLI.

acknowledgeAlarm <alarm_id><user_name>

Use this command to acknowledge an event in HuaweiU2000.

unacknowledgeAlarm <alarm_id><user_name>

Use this command to unacknowledge an event in HuaweiU2000.

resyncAll Use this command to perform a full resynchronizationwith the alarm list in Huawei U2000.

name Use this command to print the name information of theprobe.

version Use this command to print the version of the probe.

Note : As the CLI is based on Telnet connections, you can connect to the probe from anywhere by creatingdesktop tools to open a Telnet connection, send a command, and then to close the connection. Thismeans that simple scripts can be set up to allow users to acknowledge selected events from the IBMTivoli Netcool/OMNIbus event list.


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

While the slave probe receives heartbeats from the master probe, it does not forward events to theObjectServer. If the master probe shuts down, the slave probe stops receiving heartbeats from the masterand any events it receives thereafter are forwarded to the ObjectServer on behalf of the master probe.When the master probe is running again, the slave probe continues to receive events, but no longer sendsthem to the ObjectServer.

Example property file settings for peer-to-peer failover

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

Note : In the examples, make sure to use the full path for the property value. In other 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 a master probe:

Server : "NCOMS" RulesFile : "master_rules_file"MessageLog : "master_log_file"PeerHost : "slave_hostname"PeerPort : 6789 # [communication port between master and slave probe]Mode : "master"PidFile : "master_pid_file"

The following example shows the peer-to-peer settings from the properties file of the corresponding slaveprobe:

Server : "NCOMS" RulesFile : "slave_rules_file"MessageLog : "slave_log_file"PeerHost : "master_hostname"PeerPort : 6789 # [communication port between master and slave probe]Mode : "slave"PidFile : "slave_pid_file"

Properties and command line optionsYou use properties to specify how the probe interacts with the device. You can override the default valuesby using the properties file or the command line options.

The following table describes the properties and command line options specific to this probe. For moreinformation about generic Netcool/OMNIbus properties and command line options, see the IBM TivoliNetcool/OMNIbus Probe and Gateway Guide.

Table 7. Properties and command line options

Property name Command line option Description

CommandPort integer -commandport integer Use this property to specify theport number used by the probe tolisten for commands.

The default is 6970.


Table 7. Properties and command line options (continued)


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

The default is 10.

EnableEndPointFailoverstring

-enableendpointfailoverstring

Use this property to specifyfailover capability upon connectionor reconnection. If enabled and afailover occurs the probe willconnect both the JMS and HTTPinterfaces to the backup HuaweiU2000.

false: The probe does notattempt to connect to the backupHuawei U2000 upon failover.

true: The probe attempts toconnect to the backup HuaweiU2000 upon failover.

The default is false.

Note : IfEnableEndPointFailover isset to true, you must configure thefollowing properties:

• SecondaryResyncHTTPConnectionURL

• SecondaryUpdateHTTPConnectionURL

• SecondaryTransportType• SecondaryTransportFile

EncodingStandard string -encodingstandard integer Use this property to specify theEncoding Standard DefaultISO-8859-1 to include the Latinalphabet 1.

The default is ISO-8859-1.

HttpConnectionConnectTimeout integer

-httpconnectionconnecttimeout integer

Use this property to specify thetime (in seconds) following whichthe HTTP connection will timeouton connect operation.

The default is 20.




HttpConnectionReadTimeout integer

-httpconnectionreadtimeoutinteger

Use this property to specify thetime (in seconds) following whichthe HTTP connection will timeouton read operation.

The default is 300.

Note : The value of this propertyshould be increased to a valuegreater than the response time ofHuawei U2000 system

HttpPassword string -httppassword string Use this property to specify thepassword used to authenticate forHTTP operations.

The default is password.

Note : “Huawei U2000authentication lock-out” on page 5

HttpUsername string -httpusername string Use this property to specify theusername used to authenticate forHTTP operations.

The default is username.

Note : “Huawei U2000authentication lock-out” on page 5

Inactivity integer -inactivity integer Use this property to specify theperiod of inactivity (in seconds)before the probe disconnects.

The default is 0.

ProbeKeyStore string -probekeystore string Use this property to specify thepath to the keystore file containingthe private key and associatedcertificate for this probe.

Note : This property is requiredonly if the remote target system isconfigured to authenticate SSLclients.

The default is "".

ProbeKeyStorePasswordstring

-probekeystorepasswordstring

Use this property to specify thepassword required to access thekeystore file.





Resync string -resync

(This is equivalent to Resync witha value of true.)

-noresync

(This is equivalent to Resync witha value of false.)

Use this property to specifywhether the probe requests allactive alarms from the HuaweiU2000 system before connectingto the notification service for newalarms. This property takes thefollowing values:

false: The probe does notresynchronise with the targetsystem at startup.

true: The probe doesresynchronise with the targetsystem at startup.

The default is true.

ResyncBatchSize integer -resyncbatchsize integer Use this property to specify thenumber of alarms to retrieve ineach batch of resynchronizationalarms.

The default is 100.

Note : This property controls thequery efficiency and its valuedepends upon the responsivenessof the communication between theprobe and Huawei U2000 duringresynchronization. The higher thevalue to which you set theResyncBatchSize property, thegreater the query efficiency;however, the longer it will take tocomplete each batch. If the probetimes out before theresynchronization completes, setthis property to a lower value.

ResyncFilterFile string -resyncfilterfile string Use this property to specify thefilter used for resynchronizationoperations.

The default is "".

ResyncHTTPConnectionURLstring

-resynchttpconnectionurlstring

Use this property to specify theURL of the initial HTTPresynchronization connection.

The default is http://127.0.0.1/AlarmRetrieval?getAlarms.




ResyncInterval integer -resyncinterval integer Use this property to specify thetime (in seconds) that the probewaits before resynchronizing withthe U2000 system.

The default is 0.

Note : If no value is specified, theprobe will not perform an intervalresychronisation with the U2000system.

Retry string -retry

(This is equivalent to Retry with avalue of true.)

-noretry

(This is equivalent to Retry with avalue of false.)

Use this property to specifywhether the probe attempts toreconnect to the system followinga timeout:

false: The probe does notattempt to reconnect to thesystem.

true: The probe attempts toreconnect to the system.


SecondaryTransportFilestring

-secondarytransportfilestring

Use this property to specify thepath to the secondary copy of theJMS transport properties file whichspecifies the JMS connectionsettings for the secondary HuaweiU2000 server.

The default is "".

SecondaryTransportTypestring

-secondarytransporttypestring

Use this property to specify thetransport method being used.

The default is JMS.

SecondaryResyncHTTPConnectionURL string

-secondaryresynchttpconnectionurl string

Use this property to specify theHTTP URL of the alarm listresynchronization connection atthe secondary Huawei U2000server.

The default is "".

SecondaryUpdateHTTPConnectionURL string

-secondaryupdatehttpconnectionurl string

Use this property to specify theHTTP URL of the alarm list updateconnection on the secondaryHuawei U2000.

The default is "".




SecurityProtocol string -securityprotocol string Use this property to specify whichsecurity protocol the probe useswhen SSL encryption is enabled.

If no value is set for theSecurityProtocol property, theprobe uses the default protocol forthe JRE.

The default is "".

StreamCapture string -streamcapture string Use this property to specifywhether or not all output is savedto a file.


StreamCaptureFile string -streamcapturefile string Use this property to specify the fileto which the output is saved.

The default is:

$(OMNIHOME)/var/U2000.stream (UNIX).

%OMNIHOME%\var\U2000.stream (Windows).

TransformerFile string -transformerfile string Use this property to specify the filethat contains the transformerproperties.

The default is:

$(OMNIHOME)/java/conf/transformers.xml (UNIX).

%OMNIHOME%\java\conf\transformers.xml (Windows).

TransportFile string -transportfile string Use this property to specify the filethat contains the transportproperties.

The default is

$(OMNIHOME)/java/conf/jmsTransport.properties(UNIX)

%OMNIHOME%\java\conf\jmsTransport.properties(Windows).

SecondaryTransportTypestring

-secondarytransporttypestring

Use this property to specify thetransport method being used.

The default is JMS.




TransportType string -transporttype string Use this property to specify thetransport method being used onthe secondary Huawei U2000server..

The default is JMS.

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

The default is "".

TrustedCertsStorePassword string

-trustedcertsstorepasswordstring

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


UpdateHTTPConnectionURLstring

-updatehttpconnection string Use this property to specify theURL of the HTTP connection whichis used to update alarms on theU2000 server.

The default is http://127.0.0.1/AlarmHandling?updateAlarms.

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

The following table describes the elements that the Probe for Huawei U2000 generates. Not all theelements described are generated for each event; the elements that the probe generates depends uponthe event type.

Table 8. Elements

Element name Element description

$acknowledgeIndication This element indicates the acknowledgement status ofthe alarm. The possible values are:

• ACKNOWLEDGED• UNACKNOWLEDGED

$additionalText This element contains a brief description of the problembeing reported by the alarm.

$alias This element contains the name of the object reportingthe alarm as given in the EMS user interface.


Table 8. Elements (continued)

Element name Element description

$isClearable This element indicates whether the alarm can becleared. The possible values are:

• false• true

$layerRate This element indicates the layer to which the alarmapplies.

$nativeProbableCause This element indicates the probable cause as given in theEMS user interface.

$notificationId This element contains the unique identifier of the alarm.This is derived from the serial number of the alarm asused by the EMS.

$objectType This element indicates the type of object reporting thealarm.

$osTime This element indicates the time at which the alarm wasreported by the EMS.

$perceivedSeverity This element indicates the perceived severity of thealarm.

$probableCause This element contains the probable cause of the alarm.

$probableCauseQualifier This element contains the qualifier used to classify thealarm type.

$rdn This element indicates the Relative Distinguished Nameof the object reporting the event.

$serviceAffecting This element indicates whether the alarm has affectedthe service.

$sourceTime This elements indicates the time at which the erroroccurred in the network element.

$type This element indicates the type of the alarm.

$X733_AdditionalInformation This element indicates the X733 additional informationof the event.

$X733_EventType This element indicates the X733 event type.

$X733_SpecificProblems This element indicates the X733 specific problem of theevent.


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

The following table describes the error messages specific to this probe. For information about genericNetcool/OMNIbus error messages, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 9. Error messages

Error Description Action

Exception acknowledgingalarm

The probe was unable toacknowledge the alarm.

Check the exception informationand take the appropriate action.

Exceptionunacknowledging alarm

The probe was unable tounacknowledge the alarm.

Check the exception informationand take appropriate action.

Error: Connection URLString not set

The resynchronization or theupdate HTTP connection URL hasnot been set.

Check the values set for theResyncHTTPConnectionURLandUpdateHTTPConnectionURLproperties.

Malformed URL inHTTPTransport

The URLs specified by the HTTPURL properties are bothmalformed.

Check that the you have specifieda valid URL in theResyncHTTPConnectionURLandUpdateHTTPConnectionURLproperties.

Error connecting toendpoint inHTTPTransport

The resynchronization or theupdate HTTP connections areunable to connect.

Check that valid URLs have beenspecified and also check that theU2000 MTOSI interface isavailable.

Error getting contentfrom

The probe was unable to receivecontent from the endpoint.

Check that the U2000 MTOSIinterface is available.

Error creatingtransformer:

Unable to create the XSLTtransformer.

Check that TransformerFileproperty has been set correctlyand the Transformer module hasbeen correctly installed.

Failed to write tostream capture file:

The probe was unable to write tothe file specified by theStreamCaptureFile property.

Check that theStreamCaptureFile propertyhas been set correctly and theprobe user has WRITEpermissions.

Failed to transform: The transformer module wasunable to convert the event intothe appropriate XML format.

Run the probe in debug mode andcheck that the response from theU2000 server is valid XML.

Failed to close streamcapture file

The probe could not save thechanges made to the streamcapture file.

Check that this file exists and thelocal user has WRITE permissions.


Table 9. Error messages (continued)

Error Description Action

Error whiledisconnecting from JMS:

The probe could not disconnectproperly from JMS.

Check that the JMS endpoint isrunning and is accessible fromyour network.

Unable to match activealarm count:

The file referenced by theResyncFilterFile property hasbeen specified incorrectly andtherefore the probe was unable toget an active alarm count.

Run the probe in debug mode andensure that the get active alarmcount XML request returns validXML.

Error creatingtransport factory forJMS

General error creatingJMS transport

The transport module failed toconnect to JMS.

Check that the nominatedtransport file is valid.

ProbeWatch messagesDuring normal operations, the probe generates ProbeWatch messages and sends them to theObjectServer. These messages tell the ObjectServer how the probe is running.

The following table describes the ProbeWatch messages that the probe generates. For information aboutgeneric Netcool/OMNIbus ProbeWatch messages, see the IBM Tivoli Netcool/OMNIbus Probe andGateway Guide.

Table 10. ProbeWatch messages

ProbeWatch message Description Triggers/causes

Failed to open streamcapture file

The probe failed to open thestream capture file.

The probe failed to open thestream capture file specified bythe StreamCaptureFileproperty.

Failed to write tostream capture file

The probe failed to write to thestream capture file.

The probe failed to write to thestream capture file specified bythe StreamCaptureFileproperty.

Failed to close streamcapture file

The probe failed to close thestream capture file.

The probe failed to close thestream capture file specified bythe StreamCaptureFileproperty.

Failed to transform The probe failed to transform aHuawei U2000 event into tokens.

The probe failed to parse theevent messages from HuaweiU2000. Contact IBM SoftwareSupport.


Table 10. ProbeWatch messages (continued)

ProbeWatch message Description Triggers/causes

START SYNCHRONIZATION The probe has initiatedresynchronization with HuaweiU2000 on current active alarms.

The probe has been configured toperform resynchronization withHuawei U2000 via the HTTP/Sinterface at a time specified by theResynch or ResynchIntervalproperty.

END SYNCHRONIZATION The probe has endedresynchronization with HuaweiU2000 on current active alarms.

The probe has endedresynchronization with HuaweiU2000.

Fail-over triggered,attempting secondarytarget system

The probe has failed to connectwith the primary target system,and now will attempt to connect tothe secondary target system.

The probe has been configured toconnect to a secondary targetsystem by theEnableEndPointFailoverproperty when connection to theprimary target system is lost.

Fail-over triggered,attempting primarytarget system

The probe has failed to connectwith the secondary target system,and now will attempt to connect tothe primary target system.

The probe has been configured toconnect to the primary targetsystem by theEnableEndPointFailoverproperty when connection to thesecondary target system is lost.

Established connectionto primary/secondarytarget system

The probe has successfullyestablished a TCP connection toboth the HTTP and JMS interfaceson Huawei U2000.

This probe has established a TCP-level connection with HuaweiU2000.

Known issuesAt the time of release, there is a known issue that you should be aware of when running the probe.

Probe hanging at startup if invalid property value setIf an invalid property value is set, the probe may hang during startup.

As a temporary workaround, use the force kill command (kill -9) on the probe's PID to return to theprompt.

A fix has now been developed to resolve this issue. To receive the fix, contact IBM Support.


Appendix A. Notices and TrademarksThis appendix contains the following sections:

• Notices• 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 in other countries.Consult your local IBM representative for information on the products and services currently available inyour area. Any reference to an IBM product, program, or service is not intended to state or imply that onlythat IBM product, program, or service may be used. Any functionally equivalent product, program, orservice that does not infringe any IBM intellectual property right may be used instead. However, it is theuser's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in thisdocument. The furnishing of this document does not grant you any license to these patents. You can sendlicense inquiries, in writing, to:

IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual PropertyDepartment in your country or send inquiries, in writing, to:

IBM World Trade Asia Corporation Licensing 2-31 Roppongi 3-chome, Minato-ku Tokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any other country where suchprovisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATIONPROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer ofexpress or implied warranties in certain transactions, therefore, this statement may not apply to you.

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

Any references in this information to non-IBM Web sites are provided for convenience only and do not inany manner serve as an endorsement of those Web sites. The materials at those Web sites are not part ofthe materials for this IBM product 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 it believes appropriate withoutincurring any obligation to you.

Licensees of this program who want to have information about it for the purpose of enabling: (i) theexchange of information between independently created programs and other programs (including thisone) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation Software Interoperability Coordinator, Department 49XA

© Copyright IBM Corp. 2010, 2015 23

3605 Highway 52 N Rochester, MN 55901 U.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 material available for it are providedby IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, orany equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, theresults obtained in other operating environments may vary significantly. Some measurements may havebeen made on development-level systems and there is no guarantee that these measurements will be thesame on generally available systems. Furthermore, some measurements may have been estimatedthrough extrapolation. Actual results may vary. Users of this document should verify the applicable datafor their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, theirpublished announcements or other publicly available sources. IBM has not tested those products andcannot confirm the accuracy of performance, compatibility or any other claims related to non-IBMproducts. Questions on the capabilities of non-IBM products should be addressed to the suppliers ofthose products.

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

All IBM prices shown are IBM's suggested retail prices, are current and are subject to change withoutnotice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject to change before theproducts described become available.

This information contains examples of data and reports used in daily business operations. To illustratethem as completely as possible, the examples include the names of individuals, companies, brands, andproducts. All of these names are fictitious and any similarity to the names and addresses used by anactual business enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programmingtechniques on various operating platforms. You may copy, modify, and distribute these sample programsin any form without payment to IBM, for the purposes of developing, using, marketing or distributingapplication programs conforming to the application programming interface for the operating platform forwhich the sample programs are written. These examples have not been thoroughly tested under allconditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of theseprograms.

Each copy or any portion of these sample programs or any derivative work, must include a copyrightnotice 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 rights reserved.

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

TrademarksIBM, the IBM logo, ibm.com, AIX, Tivoli, zSeries, and Netcool are trademarks of International BusinessMachines Corporation in the United States, other countries, or both.

Adobe, Acrobat, Portable Document Format (PDF), PostScript, and all Adobe-based trademarks are eitherregistered trademarks or trademarks of Adobe Systems Incorporated in the United States, othercountries, or both.


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

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

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

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

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

Appendix A. Notices and Trademarks 25

IBM®

SC27-2725-06

ibm tivoli netcool/omnibus probe for huawei u2000

Documents