IBM Tivoli Netcool/OMNIbus Probe for ZTE M31 NetNumen …€¦ · IBM ®Tivoli Netcool/OMNIbus Probe for ZTE M31 NetNumen CDMA (CORBA) Version 5.0 Reference Guide November 4,2011

IBM® Tivoli® Netcool/OMNIbus Probe for ZTE M31NetNumen CDMA (CORBA)Version 5.0

Reference GuideNovember 4, 2011

SC27-2723-03

��

IBM® Tivoli® Netcool/OMNIbus Probe for ZTE M31NetNumen CDMA (CORBA)Version 5.0

Reference GuideNovember 4, 2011

SC27-2723-03

��

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

Edition notice

This edition (SC27-2723-03) applies to version 5.0 of IBM Tivoli Netcool/OMNIbus Probe for ZTE NetNumen M31CDMA (CORBA) and to all subsequent releases and modifications until otherwise indicated in new editions.

This edition replaces SC27-2723-02.

© Copyright IBM Corporation 2010, 2011.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 . . . . . . . . vi

IBM Tivoli Netcool/OMNIbus Probe forZTE NetNumen M31 CDMA (CORBA) . . 1Summary . . . . . . . . . . . . . . . 1Installing probes . . . . . . . . . . . . . 2Firewall considerations . . . . . . . . . . . 3Configuring the lookup table . . . . . . . . . 3Data acquisition . . . . . . . . . . . . . 4

Connecting to the CORBA interface. . . . . . 4Retrieving alarms and notifications . . . . . . 5Inactivity . . . . . . . . . . . . . . 5

Filtering notifications and alarms . . . . . . 5Command line interface . . . . . . . . . 6Peer-to-peer failover functionality . . . . . . 7Running multiple probes . . . . . . . . . 8

Properties and command line options . . . . . . 9Elements . . . . . . . . . . . . . . . 13Running the probe . . . . . . . . . . . . 14Error messages . . . . . . . . . . . . . 15ProbeWatch messages . . . . . . . . . . . 17

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

© Copyright IBM Corp. 2010, 2011 iii

iv IBM Tivoli Netcool/OMNIbus Probe for ZTE M31 NetNumen CDMA (CORBA): 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 ZTE NetNumen M31 CDMA(CORBA) documentation is provided in softcopy format only. To obtain the mostrecent version, visit the IBM® Tivoli® 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

SC27-2723-00 February 19,2010

First IBM publication.

SC27-2723-01 October 29,2010

“Summary” on page 1 updated.

The following sections were added:

“Installing probes” on page 2

“Firewall considerations” on page 3

“Running multiple probes” on page 8

SC27-2723-02 February 25,2011

“Summary” on page 1 updated.

“Properties and command line options” on page 9updated.

SC27-2723-03 November 04,2011

Information about operating system conventionsadded in “Conventions used in this guide” on page vi.

Requirements and multicultural support informationupdated in “Summary” on page 1.

Information about configuring the lookup file added in“Configuring the lookup table” on page 3.

Information about connecting to the CORBA interfacewas updated in “Connecting to the CORBA interface”on page 4.

The following properties were removed:

v EnableEndpointFailover

v RetryConstantWait

v RetryMaxTime

© Copyright IBM Corp. 2010, 2011 v



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

Operating system-dependent variables and paths

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

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

$OMNIHOME/probes

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

%OMNIHOME%\probes

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

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

Operating system-specific directory names

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

$OMNIHOME/probes/arch

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

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

Table 2. Directory names for the arch variable

Operating system Directory name represented by arch

AIX® systems aix5

HP-UX PA-RISC-based systems hpux11

HP-UX Integrity-based systems hpux11hpia

Red Hat Linux and SUSE systems linux2x86

vi IBM Tivoli Netcool/OMNIbus Probe for ZTE M31 NetNumen CDMA (CORBA): Reference Guide

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

Operating system Directory name represented by arch

Linux for System z® linux2s390

Solaris systems solaris2

Windows systems win32

OMNIHOME location

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

About this guide vii

viii IBM Tivoli Netcool/OMNIbus Probe for ZTE M31 NetNumen CDMA (CORBA): Reference Guide

IBM Tivoli Netcool/OMNIbus Probe for ZTE NetNumen M31CDMA (CORBA)

The ZTE NetNumen M31 CDMA system controls different interconnected networksand performs integrated network fault management, fault location, andperformance analysis. The centralized reporting function provides multiple viewsof the networks and helps to compare their performance.

The Probe for ZTE NetNumen M31 CDMA (CORBA) collects alarms from the ZTENetNumen M31 CDMA system using a Common Object Request BrokerArchitecture (CORBA) 3rd Generation Partnership Project (3GPP) interface. CORBAis an Object Management Group specification that provides a standard interfacedefinition between objects in a distributed environment.

This guide contains the following sections:v “Summary”v “Installing probes” on page 2v “Firewall considerations” on page 3v “Configuring the lookup table” on page 3v “Data acquisition” on page 4v “Properties and command line options” on page 9v “Elements” on page 13v “Running the probe” on page 14v “Error messages” on page 15v “ProbeWatch messages” on page 17

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 ZTE NetNumen M31CDMA (CORBA).

Table 3. Summary

Probe target ZTE NetNumen M31 CDMA

Probe executable name nco_p_zte_m31

Probe installation package omnibus-arch-probe-nco-p-zte-m31-version

Package version 5.0

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

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

Connection method CORBA

Remote connectivity The probe can connect to a remote device using theCORBA interface.

© Copyright IBM Corp. 2010, 2011 1

Table 3. Summary (continued)

Multicultural support Available

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

Peer-to-peer failover functionality Available

IP environment IPv4 and IPv6

Federal Information ProcessingStandards (FIPS)

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

2 IBM Tivoli Netcool/OMNIbus Probe for ZTE M31 NetNumen CDMA (CORBA): Reference Guide

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

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

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

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

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

Firewall considerationsWhen using CORBA probes in conjunction with a firewall, the firewall must beconfigured so that the probe can connect to the target system.

Most CORBA probes can act as both a server (listening for connections from thetarget system) and a client (connecting to the port on the target system to whichthe system writes events). If you are using the probe in conjunction with a firewall,you must add the appropriate firewall rules to enable this dual behavior.

There are three possible firewall protection scenarios, for which you mustdetermine port numbers before adding firewall rules:1. If the host on which the probe is running is behind a firewall, you must

determine what remote host and port number the probe will connect to.2. If the host on which the target system is running is behind a firewall, you must

determine the incoming port on which the probe will listen and to which thetarget system will connect.

3. If each host is secured with its own firewall, you must determine the followingfour ports:a. The outgoing port (or port range) for the probe.b. The hostname and port of the target system.c. The outgoing port on which the target system sends events if the probe is

running as a client.d. The incoming port on which the probe listens for incoming events.

Note: Most, but not all, CORBA probes listen on the port specified by theORBLocalPort property. The default value for this property is 0, which means thatan available port is selected at random. If the probe is behind a firewall, the valueof the ORBLocalPort property must be specified as a fixed port number.

CORBA probes that use EventManager or NotificationManager objects may usedifferent hosts and ports from those that use NamingService and EntryPointobjects. If the probe is configured to get object references from a NamingService orEntryPoint object, you must obtain the host and port information from the systemadministrator of the target system. When you have this information, you can addthe appropriate firewall rules.

Configuring the lookup tableThe probe is supplied with a lookup table that contains details of the various typesof alarms that ZTE NetNumen M31 CDMA generates. You might need to updatethe rules file to include the path to the lookup table.

At installation, the zte_m31.lookup file supplied with the probe installationpackage is installed to the following location:

$OMNIHOME/probes/includes/

To reference the lookup table from the rules file, add the following line to the rulesfile:

include "../includes/zte_m31.lookup"

IBM Tivoli Netcool/OMNIbus Probe for ZTE NetNumen M31 CDMA (CORBA) 3

Note: The include command assumes that the probe is run from the standard$OMNIHOME/probes/ directory. If you are running the probe from a differentdirectory, replace “..” with the absolute directory path to the lookup table. Do notuse the $OMNIHOME environment variable in this directory path.

Data acquisitionThe probe gathers events from the system using a CORBA 3GPP interface. Theprobe connects to the CORBA interface using an Entry Point IRP file, which isaccessed either by the local file system or over FTP.

Data acquisition is described in the following topics:v “Connecting to the CORBA interface”v “Retrieving alarms and notifications” on page 5v “Inactivity” on page 5v “Filtering notifications and alarms” on page 5v “Command line interface” on page 6v “Peer-to-peer failover functionality” on page 7v “Running multiple probes” on page 8

Connecting to the CORBA interfaceThe probe connects to the CORBA interface using Interoperable Object Reference(IOR) files.

Before it begins retrieving events from ZTE NetNumen M31 CDMA, the probeacquires the EntryPointIRP CORBA object. It gets this from the local IOR file (onthe same host as ZTE NetNumen M31 CDMA) specified by the EntryPointIRPFileproperty. If the EntryPointIRPFile property is left blank, the probe acquires theobject from a remote IOR file using File Transfer Protocol (FTP).

After it has acquired the EntryPointIRP object, the probe acquires the AlarmIRP andNotificationIRP objects. It needs the AlarmIRP object to perform resynchronizationand the NotificationIRP object to get real time alarms.

The probe acquires the AlarmIRP object from the IOR file specified by theAlarmIrpFile property. If the AlarmIrpFile property is left blank, the probe usesthe value specified by the AlarmIrpName property to locate the AlarmIRP objectwithin the EntryPointIRP object.

Likewise, the probe acquires the NotificationIRP object from the IOR file specifiedby the NotificationIrpFile property. If the NotificationIrpFile property is leftblank, the probe uses the value specified by the NotificationIrpName property tolocate the NotificationIRP object within the EntryPointIRP object.

Using FTP

If the Entry Point IRP file is on a remote system, the probe uses an FTP commandto retrieve it. To enable this, you must specify the following value for theSecurityIrpFtpCommand property:

ftp://username:password@host/

Where username and host are the user name and host name of the Entry Point IRPserver, and password is specified by the FtpPassword property.


Note: Encrypt the password using the nco_g_crypt utility supplied withNetcool/OMNIbus and use the encrypted string as the value of the FtpPasswordproperty. For more information about encrypting passwords, see the IBM TivoliNetcool/OMNIbus Administration Guide (SC14-7605).

Retrieving alarms and notificationsIf the Resync property is set to true, the probe initially receives a list of all activealarms from the EMS manager object. The probe then connects to the Subscriberobject and uses the CORBA notification push model to receive new alarms fromthe server as they are generated. If the Resync property is set to false, the probeonly receives new alarms.

InactivityThe probe has a timeout facility that allows it to disconnect from the socket if itfails to receive the next alarm data within a predefined amount of time. To specifyhow long the probe waits before disconnecting, use the Inactivity property. Afterthis length of time, the probe disconnects from the switch, sends a ProbeWatchmessage to the ObjectServer, and tries to reconnect.

You can also use the InactivityRetry property to specify the number ofconsecutive inactivity intervals that the probe allows before disconnecting. If thisproperty is set to 0, the probe disconnects after a single period of inactivity.

Filtering notifications and alarmsUsing the properties file, you can specify how the probe filters the events toreceive only the preferred notifications and alarms.

The NotificationFilter and AlarmFilter properties allow you to specify whatnotifications and alarms are sent to the probe. When you use these properties, youmust use the actual token names. For example, the token h represents the elementNV_PERCEIVED_SEVERITY; so, to specify that the probe is only sent notifications witha perceived severity of 3, you must set the NotificationFilter property to $h==3.

You can specify more complex filters using and and or statements; for example, tospecify that the probe is sent notifications with a perceived severity of 3 or 4, youmust set the NotificationFilter property to $h==3 or $h==4.

You can use the following properties as notification filter:v NV_MANAGED_OBJECT_CLASS

v NV_MANAGED_OBJECT_INSTANCE

v NV_NOTIFICATION_TYPE

v NV_EVENT_TIME

v NV_SYSTEM_DN

You can use the following properties as alarm filters:v NV_MANAGED_OBJECT_CLASS

v NV_MANAGED_OBJECT_INSTANCE

v NV_NOTIFICATION_ID

v NV_NOTIFICATION_TYPE

v NV_EVENT_TIME

v NV_SYSTEM_DN


v NV_PERCEIVED_SEVERITY

v NV_ALARM_ID

v NV_ACK_STATE

Command line interfaceThe probe is supplied with a Command Line Interface (CLI). This interface allowsyou to execute commands using the probe to acknowledge alarms or request a fullresynchronization.

To use the CLI, you must use the CommandPort property to specify a port throughwhich commands will be sent. The default port is 6970. When you want to issuecommands, use Telnet to connect through this port.

Note: If there is a firewall between the probe and the ZTE NetNumen M31 CDMAsystem, keep the following ports open: TCP 21115, TCP 21126, and TCP 21111.

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

Table 4. CLI commands

Command Description

acknowledgeAlarm <alarm ID> <user ID> Use this command to acknowledge an alarm inthe 3GPP interface by specifying the NV_ALARM_IDidentifier of the alarm and the user identifier ofthe user acknowledging the alarm.

Before using this command, you must specify avalue for the AckSystemId property.

acknowledgeAlarmNoID <alarm ID> Use this command to acknowledge an alarm inthe 3GPP interface by specifying the NV_ALARM_IDidentifier of the alarm.

Before using this command, you must specify avalue for the AckUserId property.

clearAlarm <alarm ID> <user ID> Use this command to clear an alarm byspecifying the NV_ALARM_ID identifier of the alarmand the user identifier of the user acknowledgingthe alarm.

Before using this command, you must specify avalue for the ClearSystemId property.

clearAlarmNoID <alarm ID> Use this command to clear an alarm byspecifying the NV_ALARM_ID identifier of the alarm.

Before using this command, you must specify avalue for the ClearUserId property.

getEventQueueSize Use this command to display the current size ofthe internal event queue.

exit/quit Use this command to close the connection.

help Use this command to display online help aboutthe CLI.

name Use this command to print the name of theprobe.

resyncAll Use this command to perform a fullresynchronization with the 3GPP interface.


Table 4. CLI commands (continued)

Command Description

resyncFilter <filter> Use this command to perform partialresynchronization with the 3GPP interface.

This command uses the filter specified by theAlarmFilter property as a parameter.

shutdown Use this command to shut down the probe.

unacknowledgeAlarm <alarm ID> <userID>

Use this command to unacknowledge an alarm inthe 3GPP interface by specifying the NV_ALARM_IDidentifier of the alarm and the user identifier ofthe user acknowledging the alarm.

Before using this command, you must specify avalue for the AckSystemId property.

unacknowledgeAlarmNoID <alarm ID> Use this command to unacknowledge an alarm inthe 3GPP interface by specifying the NV_ALARM_IDidentifier of the alarm.

Before using this command, you must specify avalue for the AckUserId property.

version Use this command to display the version of theprobe.

CLI scripts

Because the CLI uses Telnet connections, you can connect to the probe fromanywhere by creating a desktop tool to open a Telnet connection, send a command,and then close the connection. This means that simple scripts can be set up toallow users to acknowledge selected events from the IBM Tivoli Netcool/OMNIbusevent list.

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

While the slave probe receives heartbeats from the master probe, it does notforward events to the ObjectServer. If the master shuts down, the slave probe stopsreceiving heartbeats from the master and any events it receives thereafter areforwarded to the ObjectServer on behalf of the master probe. When the master isrunning again, the slave continues to receive events, but no longer sends them tothe ObjectServer.


Example property file settings for peer-to-peer failover

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

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"

Running multiple probesYou can run multiple instances of the probe.

For each running instance, specify a different port to which the server listens usingthe ORBLocalPort property.

Running multiple probes in a failover configuration

If you have implemented a peer-to-peer failover configuration, both the masterprobe and the slave probe have their own Object Request Broker (ORB) local port.

Where you are running this configuration in conjunction with a firewall, add thereceiving port of each probe to the firewall rules. The direction of the connection isfrom the target system to the master or slave probe.

You set the peer-to-peer failover mode in the properties files of the master andslave probes.

Include the following peer-to-peer settings in the master's probe properties file:PeerHost : "slave_hostname"PeerPort : 5555 # [communication port between master and slave probes]

Include the following peer-to-peer settings in the slave's probe properties file:PeerHost : "master_hostname"PeerPort : 5555 # [communication port between master and slave probes]


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

The following table describes the properties and command line options specific tothis probe. For information about default properties and command line options, seethe IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide (SC14-7608).

Table 5. Properties and command line options

Property name Command line option Description

AckSystemId string -acksystemid string Use this property to specifythe system identifier to usewhen acknowledging alarmsusing the CLI.

The default is netcool.

AckUserId string -ackuserid string Use this property to specifythe user identifier to use whenacknowledging alarms usingthe CLI.

The default is "".

AlarmFilter string -alarmfilter string Use this property to specifythe filter that the alarm IRPuses to limit the alarms sentto the probe.

The default is "".

AlarmIrpFile string -alarmirpfile string Use this property to specifythe name of the file thatcontains the IOR for theAlarm IRP.

The default is "".

AlarmIrpName string -alarmirpname string Use this property to specifythe name of the Alarm IRPagent that the probe uses toresolve the AlarmIRP point inthe Naming Service.

The default is ALARM IRP V2.0.

ClearSystemId string -clearsystemid string Use this property to specifythe system identifier to usewhen clearing alarms usingthe CLI.

The default is netcool.

ClearUserId string -clearuserid string Use this property to specifythe user identifier to use whenclearing alarms using the CLI.

The default is "".


Table 5. Properties and command line options (continued)


CommandPort integer -commandport integer Use this property to specifythe port through which youcan use Telnet to sendcommands using the CLI.

The default is 6970.

For information about usingthe CLI, see “Command lineinterface” on page 6.

CommandPortLimit integer -commandportlimit integer Use this property to specifythe maximum number ofTelnet connections that theprobe can make.

The default is 10.

EncodingStandard integer -encodingstandard integer Use this property to specifythe Encoding StandardDefault ISO-8859-1 to includethe Latin alphabet 1.

The default is ISO-8859-1.

EntryPointIRPFile string -entrypointirpfile string Use this property to specifythe path of the Entry PointIRP file that the probe uses toaccess data on the ZTENetNumen M31 CDMAserver.

The default is "" .

FtpPassword string -ftppassword string Use this property to specifythe password that the probeuses to access the Entry PointIRP file over FTP.

The default is "".

Note: Encrypt the passwordusing the nco_g_crypt utilitysupplied withNetcool/OMNIbus.

Inactivity integer -inactivity integer Use this property to specifythe length of time (in seconds)that the probe waits for eventactivity before disconnectingfrom the ZTE NetNumen M31CDMA system.

The default is 0.

NotificationCategoriesstring

-notificationcategoriesstring

Use this property to specifythe notification categories thatthe probe will subscribe to.

The default is "".




NotificationFilter string -notificationfilter string Use this property to specifythe filter that the NotificationIRP uses to limit thenotifications sent to the probe.

The default is "".

NotificationIrpFile string -notificationirpfile string Use this property to specifythe name of the file thatcontains the IOR for theNotification IRP.

The default is "".

NotificationIrpName string -notificationirpname string Use this property to specifythe name of the NotificationIRP agent that the probe usesto resolve the NotificationIRPpoint in the Naming Service.

The default is NOTIFICATIONIRP V2.0.

NotificationIrpVersionstring

-notificationirpversionstring

Use this property to specifythe version of the NotificationIRP to which the probesubscribes.

The default is "".

ORBWCharDefault string -orbwchardefault string Use this property to specifywhat wide character (wchar)set the IBM ORB uses whencommunicating with otherORBs that do not publish awchar set.

The default is UTF16.

ORBCharEncoding string -orbcharencoding string Use this property to specifythe native character encodingset used by the Object RequestBroker (ORB) for characterdata.

The default is UTF8.

ORBDebug string -orbdebug string Use this property to specifywhether or not the probeincludes ORB messages in thedebug file. This property takesthe following values:

false: The probe does notinclude ORB messages in thedebug file.

true: The probe includes ORBmessages in the debug file.

The default is false.




ORBDebugFile string -orbdebugfile string Use this property to specifythe location of the ORB debugfile.

The default is$OMNIHOME/log/orb.debug.

ORBLocalPort integer -orblocalport integer Use this property to specifythe local port to which theObject Request Broker (ORB)listens.

The default is 0 (the ORBselects an available port atrandom).

Resync string -resync (This is equivalent toResync with a value of true.)

-noresync (This is equivalentto Resync with a value offalse.)

Use this property to specifywhether the probe requests allactive alarms from the ZTENetNumen M31 CDMAsystem before connecting tothe notification service fornew alarms. This propertytakes the following values:

false: The probe does notperform resynchronization.

true: The probe performsresynchronization.

The default is true.

ResyncBatchSize integer -resyncbatchsize integer Use this property to specifythe maximum number ofalarms retrieved in eachresynchronization batch ofalarms.

The default is 100.

Retry string -retry string Use this property to specifywhether the probe attempts toreconnect to the systemfollowing a timeout. Thisproperty takes the followingvalues:

false: The probe does notattempt to reconnect to thesystem.

true: The probe attempts toreconnect to the system.

The default is false.

SecurityIrpFtpCommandstring

-securityirpftpcommand string Use this property to specifythe FTP command for theSecurity IRP IOR file.

The default is ""




TimeTick integer -timetick integer Use this property to specifythe period (in minutes) of theNotification IRP sessionlifetime on the 3GPP server.

The default is 10.

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

The following table describes the elements that the ZTE NetNumen M31 CDMAgenerates. Not all the elements described are generated for each event; theelements that the probe generates depends upon the event type.

Table 6. Elements

Element name Element description

CLEAR_SYSTEM_ID This element identifies the system that cleared thealarm.

CLEAR_USER_ID This element identifies the user that cleared thealarm.

NV_ACK_STATE This element shows the acknowledgement stateof the alarm.

NV_ACK_SYSTEM_ID This element specifies the system ID of the IRPManager processing the notification.

NV_ACK_USER_ID This element specifies the last user who haschanged the acknowledgement state.

NV_ALARM_CLEARED_TIME This element shows the identification informationof the alarm as it appears in the alarm list.

NV_ALARM_ID This element contains the time when the alarm iscleared.

NV_ALARM_LIST_ALIGNMENT_REQUIREMENT This element indicates whether the alarm listrequires alignment.

NV_ALARM_RAISED_TIME This element indicates the time when the alarm israised.

NV_BACKED_UP_STATUS This element identifies whether the object hasbeen backed up.

NV_BACK_UP_OBJECT This element shows the Distinguished Name(DN) of the backup object.

NV_COMMENTS This element contains comments about thealarms.

NV_CORRELATED_NOTIFICATIONS This element specifies the set of notifications towhich this notification is considered to becorrelated.

NV_EVENT_TIME This element shows the time at which the eventoccurred.


Table 6. Elements (continued)

Element name Element description

NV_MANAGED_OBJECT_CLASS This element shows the managed object class ofthe network resource.

NV_MANAGED_OBJECT_INSTANCE This element shows the managed object instanceof the network resource.

NV_MONITORED_ATTRIBUTES This element contains the managed objectattributes of the network resource.

NV_NOTIFICATION_ID This element shows the identification informationof the notification.

NV_PERCEIVED_SEVERITY This element shows the relative level of urgencyfor operator attention.

NV_PROBABLE_CAUSE This element provides further information aboutthe probable cause of the alarm.

NV_PROPOSED_REPAIR_ACTIONS This element shows the proposed repair actionsassociated with the notification.

NV_REASON This element contains the reason that triggeredthe proposed repair action.

NV_SECURITY_ALARM_DETECTOR This element contains the security alarm detectorfor the device.

NV_SERVICE_PROVIDER This element contains the name of the serviceprovider.

NV_SERVICE_USER This element contains the name of the user whouses the service.

NV_SPECIFIC_PROBLEM This element provides further information aboutthe problem to which the notification relates.

NV_STATE_CHANGE_DEFINITION This element contains information about the statechange.

NV_THRESHOLD_INFO This element specifies information about athreshold that has been crossed.

NV_TREND_INDICATION This element indicates how an observedcondition has changed.

NV_VENDOR_SPECIFIC_ALARM_TYPE This element shows the alarm type specific to thevendor.

Running the probeYou run the probe from the command line.

To start the probe, use the following command:

$OMNIHOME/probes/nco_p_zte_m31


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 7. Error messages

Error Description Action

Cannot initialize the Orb The probe found a problemduring initialization of theORB.

Check that your CLASSPATHcontains the path to theVisibroker jar files.

FtpPassword is incorrectlength (ensure it hasbeen encrypted usingnco_g_crypt)

The probe found that there isa problem with the encryptedpassword.

Check the value of theFtpPassword property in theproperties file.

Failed to find IOR file The probe failed to get theIOR file from the FTP locationspecified.

Check that the IRP Managerhas been set up correctly.

Failed to narrow EntryPoint IRP interface

The probe failed to narrowthe object reference to theEntry Point IRPAgent object.

Check that theEntryPointIrpFile property iscorrectly set in the propertiesfile.

Failed to retrieveAlarmIRP object fromentry point interface

The probe failed to get theAlarm IRP object matchingthe AlarmIRP property value.

Refer to your CORBAdocumentation.

Failed to retrieveNotificationIRP objectfrom entry pointinterface

The probe failed to get theNotification IRP objectmatching theAlarmNotification propertyvalue.

Refer to your CORBAdocumentation.

Failed to perform resynch

Could not perform resynch

The probe failed to get thealarm list, or failed to iteratethrough resynch alarms.

Check that the connection tothe host is still active.

Disconnect Error The probe failed to detach thesubscription from thenotification service.

Check that you have set the$classpath environmentvariable correctly.

Failed to getsubscription status

The probe cannot get thesubscription status from thenotification service.

Check that the ZTE server isrunning correctly. Check theconnection to the ZTE server.


Table 7. Error messages (continued)


Communication failure -lost connection toNotificationIRP

CORBA.TRANSIENT exceptionraised. NotificationIRPis down!

CORBA.OBJECT_NOT_EXISTexception raised.NotificationIRP is down!

BAD_PARAM Exception i.eone or more of the in/outparameter is null

CORBA Exception stacktrace to stderr

Failed to Connect tonotification service

Failed to Connect

Either, the server is notrunning, the IOR is outof date, or probe cannotreach remote Server!

Cannot proceed. Shuttingdown!

The probe found that theNotificationIRP point from theZTE System is no longerresponding. The Notificationservice is not available.

Check that the ZTE server isrunning correctly.

Error while trying toattach theNetcoolIRPManager

The probe is not able to get asubscription to thenotification service.

Check that the ZTE server isstill running.

Failed to iterate throughresynch alarms

The probe encountered aproblem while parsing thealarms retrieved during theresynchronization.

Check that the ZTE server isrunning correctly. Check thatthe Resync property is setcorrectly.

Failed toacknowledge_alarms()

Failed toUnacknowledge_alarms()

Failed to clear_alarms

Failed to comment_alarms

The probe could notacknowledge the alarm.

Check the alarmId providedto the CLI is correct. Checkthat you have specified thecommand port correctly.Check the connection betweenthe probe and the commandport.

ERROR when parsing anotification event

The probe encountered aproblem while parsing areceived alarm. The probemay not have parsed theevent completely.

Check the value specified forthe FtpPassword property inthe properties file.

Failed to parse eventcompletely

The probe encountered aproblem while parsing theevent

Check that the ZTE server isrunning correctly.

Failed to send event The probe could not forwardthe event to the ObjectServer.

Check that the ObjectServer isrunning.


Table 7. Error messages (continued)


Name is null, cannotcreate Element

The probe could not forwardthe event to the ObjectServer.

Check that the ObjectServer isrunning.

[Command Port] Failed toget CommandPortLimitproperty - using 10");

[Command Port] Failed toget property'CommandPort'"); [CommandPort] Thread shuttingdown due to error!");

[Command Port] Failed toopen listening socket,shutting down Thread!");

[Command Port] Erroroccurred : "+e);

[Command Port] <"+host+">Failed to get socket IO :"+io);

[Command Port] <"+host+">Failed to read command :"+e);

[Command Port] <"+host+">Failed to close commandsocket : "+se);

The probe could not retrievethe value of theCommandPortLimit property.

Check that you have specifiedthe command port correctly.Check the connection betweenthe probe and the commandport.

Resynch Failed - Probecannot handleasynchronous resynch modeat this point in time.This will be handled inlater release of theprobe

The probe has failed toperform an asynchronousresynchronization.

As this function is notcurrently supported, there isno action required.

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

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

Table 8. ProbeWatch messages

ProbeWatch message Description Triggers or causes

END SYNCHRONIZATION The probe is closing thesynchronization process.

The probe has finishedreceiving alarms from thealarm list.


Table 8. ProbeWatch messages (continued)


Failed to Connect:

Unexpected fatal error,failed to connect

The probe could not connectto the host.

Either the server is notrunning, the IOR is out ofdate, or the probe cannotreach remote server.

Failed to find IOR file

Failed to get IRP Outline

Unexpected fatal errorwhile getting IRP Outline

The probe could not locatethe IRP Manager as the filespecified does not exist.

The IRP Manager has beenset up incorrectly.

Failed to get subscriptonstatus

Communication failure -lost connection toNotificationIRP

CORBA.TRANSIENT Exception:Lost connection toNotificationIRP

CORBA.OBJECT_NOT_EXISTException: Lost connectionto NotificationIRP

CORBA.OBJECT_NOT_EXISTException: Lost connectionto NotificationIRP

Failed to connect toNotificationIRP:'"+ae.reason+"'.

The probe has failed to getthe subscription status fromthe Notification IRP.

The Notification service isnot available.

Will listen for commandson port number

The probe is listening forcommands on the specifiedport.

The specified port is ready toreceive commands.

Failed to listen forcommands on port number

The probe could not openthe socket specified by theport to listen for commands.

The specified port is in usefor another process.

Failed to get IRPreference

Failed to get IRPreferences - invalidparameter

Unexpected fatal errorwhen getting IRP referencefrom Entry Point IRP

The probe could not receivethe IRP reference point.

The EntryPointIrpFileproperty is incorrectlyspecified in the propertiesfile.

Invalid IRPVersion The probe found that the IRPversion is mismatching.

An invalid IRP version issent to the probe.

RESYNCH FAILED - PROBECANNOT HANDLEASYNCHRONOUSRESYNCH MODE AT THISPOINT IN TIME

The probe has failed toperform an asynchronousresynchronization.

This function is not currentlysupported.


Table 8. ProbeWatch messages (continued)


Shutting down. The probe is shutting down. The probe is shutting downafter performing theshutdown routine.

START SYNCHRONIZATION The probe is synchronizingthe events.

The probe has startedreceiving alarms from thealarm list.



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. 2010, 2011 21

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

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

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

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

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

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

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

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

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

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

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

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


COPYRIGHT LICENSE:

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

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

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

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

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

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

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

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

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

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

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

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

Appendix. Notices and Trademarks 23


��

Printed in USA

SC27-2723-03

Documents

IBM Tivoli Netcool/OMNIbus Probe for ZTE M31 NetNumen …€¦ · IBM ®Tivoli Netcool/OMNIbus Probe for ZTE M31 NetNumen CDMA (CORBA) Version 5.0 Reference Guide November 4,2011