IBM Tivoli Netcool/OMNIbus Probe for Nokia NetAct for ... · PDF fileNetcool/OMNIbus Probe for Nokia NetAct for Broadband Version 4.0 Reference Guide January 31,2011 SC23-7890-02

Netcool/OMNIbus Probe for Nokia NetAct for BroadbandVersion 4.0

Reference GuideJanuary 31, 2011

SC23-7890-02

��

Netcool/OMNIbus Probe for Nokia NetAct for BroadbandVersion 4.0

Reference GuideJanuary 31, 2011

SC23-7890-02

��

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

Edition notice

This edition applies to version 4.0.5897 of IBM Tivoli Netcool/OMNIbus Nokia NetAct for Broadband(SC23-7890-02) and to all subsequent releases and modifications until otherwise indicated in new editions.

This edition replaces SC23-7890-01.

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

Contents

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

IBM Tivoli Netcool/OMNIbus NokiaNetAct for Broadband. . . . . . . . . 1Summary . . . . . . . . . . . . . . . 1Installing probes . . . . . . . . . . . . . 2Internationalization support . . . . . . . . . 3

Example multi-byte character set on Solaris . . . 4Data acquisition . . . . . . . . . . . . . 4

Peer-to-peer failover functionality . . . . . . 5Receiving alarms . . . . . . . . . . . . 6Alarm format . . . . . . . . . . . . . 6Non-standard format alarms . . . . . . . . 7

Heartbeat alarms . . . . . . . . . . . . 7Data stream capture . . . . . . . . . . . 8Timeout . . . . . . . . . . . . . . . 8

Properties and command line options . . . . . . 8Elements . . . . . . . . . . . . . . . 12

Elements generated for alarms in XML format . . 12Elements generated for alarms in ASCII format 13

Error messages . . . . . . . . . . . . . 14ProbeWatch messages . . . . . . . . . . . 15

Appendix. Notices and Trademarks . . 19Notices . . . . . . . . . . . . . . . . 19Trademarks . . . . . . . . . . . . . . 21

© Copyright IBM Corp. 2006, 2011 iii

iv IBM Tivoli Netcool/OMNIbus Probe for Nokia NetAct for Broadband: Reference Guide

Document control page

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

The IBM Tivoli Netcool/OMNIbus Nokia NetAct for Broadband documentation isprovided in softcopy format only. To obtain the most recent 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

01 December 31,2008

First IBM publication.

02 January 31,2011

Installation section replaced by “Installing probes” onpage 2.

© Copyright IBM Corp. 2006, 2011 v



vi IBM Tivoli Netcool/OMNIbus Probe for Nokia NetAct for Broadband: Reference Guide

IBM Tivoli Netcool/OMNIbus Nokia NetAct for Broadband

Nokia NetAct for Broadband is a Simple Network Management Protocol (SNMP)Fault and Provisioning Management tool for its Digital Subscriber Line (DSL) andAsynchronous Transfer Mode (ATM) broadband networks. Nokia NetAct forBroadband covers all the main operator processes such as network monitoring,development, optimization, service management, reporting, and systemmanagement.

The Probe for Nokia NetAct for Broadband reads alarms produced by NokiaNetAct for Broadband. The ASCII Alarm Interface can be used by a third partymanagement system to receive alarm event information from the networkmanaged by Nokia NetAct for Broadband. The probe supports versions 3.2, 3.3,and 3.4 of Nokia NetAct for Broadband.

This guide contains the following sections:v “Summary”v “Installing probes” on page 2v “Data acquisition” on page 4v “Properties and command line options” on page 8v “Elements” on page 12v “Error messages” on page 14v “ProbeWatch messages” on page 15

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 Nokia NetAct forBroadband.

Table 2. Summary

Probe target Nokia NetAct for Broadband versions 3.2, 3.3, and 3.4

Probe executable name nco_p_nokianetact

Package version 4.0

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

%OMNIHOME%\probes\arch\nokianetact.props

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

%OMNIHOME%\probes\arch\nokianetact.rules

Requirements A currently supported version of IBM TivoliNetcool/OMNIbus

Connection method TCP/IP Socket

© Copyright IBM Corp. 2006, 2011 1

Table 2. Summary (continued)

Remote connectivity The Probe for Nokia NetAct for Broadband can connectto a device on a remote host. Details of the remote hostare specified using the Host, XMLPortCurrent, andXMLPortUpload properties (for events in XML format), orASCIIPortCurrent, and ASCIIPortUpload (for events inASCII format) properties in the properties file.

Internationalization AvailableNote: The probe supports internationalization on IBMTivoli Netcool/OMNIbus V7.3.0, 7.3.1 or 7.4.0.

Peer-to-peer failover functionality Available

IP environment IPv4 and IPv6Note: The probe is supported on IPv6 when running onIBM Tivoli Netcool/OMNIbus V7.3.0, 7.3.1 and 7.4.0 onall UNIX and Linux operating systems.

Federal Information ProcessingStandards (FIPS)

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

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

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

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

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

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

2 IBM Tivoli Netcool/OMNIbus Probe for Nokia NetAct for Broadband: 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

Internationalization supportThe probe supports multibyte character sets (for example, Japanese) and charactersets that contain individual multibyte characters (for example German, French, andSpanish). To view the character sets correctly, you must configure the localesettings on the host machine correctly.

If you are using a language that contains multibyte characters, you must set theLANG environment variables to the name of your character set, and export theLC_ALL environment variable. For example, if you are using Japanese, set theseenvironment variables to ja_JP.UTF-8; if you are using German, set theseenvironment variables to de_DE.UTF-8. This will enable the probe to recognise themultibyte characters used by your character set when they occur in any networkevents.

The probe supports the following language locales:

Table 3. Supported language locales

Languages AIX HP-UX Solaris Linux

English (US) en_US en_US en_US en_US

SimplifiedChinese

zh_CN zh_CN zh_CN zh_CN

TraditionalChinese

zh_TW zh_TW.eucTW Zh_TW.big5 zh_TW.big5

Czech cs_CZ cs_CZ cs cs_CZ

French(standard)

fr_FR fr_FR fr fr_FR

German(standard)

de_DE de_DE de de_DE

Hungarian hu_HU hu_HU hu hu_HU

Italian (standard) it_IT it_IT it it_IT

Japanese ja_JP ja_JP ja ja_JP

Korean ko_KR ko_KR ko ko_KR

Polish pl_PL pl_PL pl pl_PL

Portuguese(Brazilian)

pt_BR pt_BR pt pt_BR

Russian ru_RU ru_RU ru ru_RU

Spanish es_ES es_ES es es_ES

IBM Tivoli Netcool/OMNIbus Nokia NetAct for Broadband 3

Example multi-byte character set on Solaris

The following steps describe how to configure Solaris to use the Japanese characterset:1. Install the necessary components for Japanese on to the host machine using the

Solaris CD.2. Set the LANG and LC_ALL environment variables to ja_JP PCK. This uses SJIS

encoding.

Note: You may have to set the LANG in the host machine's default settings fileand reboot it to make the changes take effect.

3. Make sure that the file $OMNIHOME/platform/arch/locales/locales.dat has thefollowing entry:locale = ja_JP PCK, japanese, sjis

Where ja_JP PCK is the vendor locale, japanese is the Sybase language, andsjis is the Sybase character set.

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

The Probe for Nokia NetAct for Broadband processes events that are in either XMLor ASCII format. Nokia NetAct for Broadband acquires data by connecting to aTCP/IP socket.

The following table shows the default ports that the probe uses and the propertiesthat you can use to specify alternative ports.

Table 4. Default ports

Default port Description Associated property

7331 XML Alarm Uploader port XmlPortUpload

7332 XML Alarm Forwarder port XmlPortCurrent

7221 ASCII Alarm Uploader port AsciiPortUpload

7222 ASCII Alarm Forwarder port AsciiPortCurrent

To specify that the events are in ASCII format, set the AlarmsAreXML property to 0.Otherwise, set the AlarmsAreXML property to 1 (the default value for this property).

Data acquisition is described in the following topics:v “Peer-to-peer failover functionality” on page 5v “Receiving alarms” on page 6v “Alarm format” on page 6v “Non-standard format alarms” on page 7v “Heartbeat alarms” on page 7v “Data stream capture” on page 8v “Timeout” on page 8


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

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

Example property file settings for peer-to-peer failover

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

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"


Receiving alarmsIf the Upload property is set to 1 (the default value for this property), the proberetrieves alarms from both the Alarm Uploader and Alarm Forwarder ports. Theprobe connects to the Alarm Uploader socket and receives an upload of all eventsthat are currently active. Once the probe has received all the upload events itdisconnects from the Alarm Uploader socket and connects to the Alarm Forwarderport. It then receives all new alarms as they are generated.

If the Upload property is set to 0, the probe only connects to the Alarm Forwarderport. If the Alarm Uploader port closes, the probe sends a ProbeWatch messageindicating the port has closed.

If the Alarm Uploader port times out, the probe opens the Forwarder Port. Thelength of the timeout period is specified by the UploadReadTimeOut property.

If the current port times out, the probe closes the current port and retries theconnection. The length of the timeout period is specified by the FlowReadTimeOutproperty and the number of times the probe retries the connection is specified bythe RetryTimeOut property.

Note:If the FlowReadTimeOut or UploadReadTimeOut properties are set to 0, the probewaits indefinitely for data.

Alarm formatThis section describes the formats of alarms received by the probe.

XML

The basic format for alarms in XML format is as follows:<event_uuid>D50e:D50:11.0.1-f91229540d</event_uuid><neid>1002</neid><event_status>0</event_status><event_severity>2</event_severity><event_type>0</event_type><event_oid>.1.3.6.1.6.3.1.1.5.3</event_oid><element_type>D50e:D50:11.0.1</element_type><ip_address>10.30.12.2</ip_address><agent_address>10.30.12.2</agent_address><ne_name>dslamY</ne_name><event_source port="3" card="7" shelf="0" /><event_time>1.069751555094E12</event_time><event_message>Link Down</event_message><varbinds><var oid="NEID">1002</var><var oid=".1.3.6.1.4.1.1713.1.1.2.1.1.3.0">25< /var><var oid=".1.3.6.1.4.1.1713.1.1.2.1.1.2.0">1< /var><var oid=".1.3.6.1.4.1.1713.1.1.2.1.1.1.0">3< /var><var oid=".1.3.6.1.4.1.1713.1.1.2.1.1.5.0">link down</var><var oid=".1.3.6.1.4.1.1713.1.1.1.4.1.1.1.1.103">103</var><var oid=".1.2">10.30.12.2</var></varbinds></netact4bb_event>

ASCII

The basic format for alarms in ASCII format is as follows:


COMM-ALARM-EVENT-INDIndicates beginning delimiter of alarmSYSTEM"systemname"ASSOC""CLASS"classname"INST "local distinguished name"AMO "affected managed object"TIME "current time"MODE "value"P-CAUSE"trapname:Oid"S-PROBLEMS"value"P-SEVERITY"value"BU-STATUS""TREND-IND""THRES-INF""N-ID "Nid value"COR-N"Cor-N value"Text Information"Text message"P-REPAIR""IND-ID"Ind-id value"IND Indicates end of alarmCOMM-ALARM-EVENT-IND indicates the start of each alarm.

Possible values include:P-ERROR-ALARM-EVENT-INDQOS-ALARM-EVENT-INDENV-ALARM-EVENT-INDEQUIP-ALARM-EVENT-IND

Non-standard format alarmsIf the Probe for Nokia NetAct for Broadband receives an alarm in a non-standardformat or an alarm that is not in a pre-defined format, it logs the full alarm detailsin the file $OMNIHOME/var/ nokianetact.NonStandardAlarmFile. The probe thensends a ProbeWatch message to the ObjectServer to indicate that an alarm has beenreceived in an unrecognized format.

Heartbeat alarmsNokia NetAct sends regular heartbeat messages to the probe to confirm that thedevice is still active. The heartbeat messages are in either XML or ASCII format,depending on the setting of the AlarmsAreXML property. The probe uses the valuesspecified by XmlHeartbeatAlarmHeader and AsciiHeartbeatAlarmHeader propertiesto identify heartbeat messages. If the probe does not receive either an event or aheartbeat message from Nokia NetAct for a period greater than that specified bythe HeartbeatInterval property, the probe sends a ProbeWatch message to theObjectServer.


Data stream captureThe probe can capture the data stream sent from a device in a stream capture file.For each connection, the full data stream is stored in a stream capture file.

The data stream is stored using the following naming convention:

streamcapturefile_host_port

To enable stream capture, set the StreamCaptureFile property or-streamcapturefile command line option.

TimeoutThe Timeout property specifies how long the probe waits to receive events from thedevice before it disconnects and shuts down.

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

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

Table 5. Properties and command line options

Property name Command line option Description

AlarmsAreXML integer -noalarmsarexml(equivalent toAlarmsAreXML with a valueof 0)

-alarmsarexml (equivalentto AlarmsAreXML with avalue of 1)

Use this property to specifywhether the alarms received are inXML format:

0: Alarms are in ASCII format.

1: Alarms are in XML format.

The default is 1.

AsciiAlarmHeader string -asciialarmheader string Use this property to specify theregular expression match theprobe uses to find the start ofASCII events.

The default is .*ALARM-EVENT.*.

AsciiEvent Terminatorstring

-asciievent terminatorstring

Use this property to specify thestring that indicates the end of anASCII event.

The default is IND \n.

AsciiHeartbeatAlarmHeader string

-asciiheartbeat alarmheader string

Use this property to specify thestring that indicates the start of aheartbeat alarm.

The default is EVENT-IND\n.


Table 5. Properties and command line options (continued)


AsciiPortCurrent integer -asciiportcurrent integer Use this property to specify theport on which to listen for currentASCII events as they aregenerated.

The default is 7722.

AsciiPortUpload integer -asciiportupload integer Use this property to specify theport from which to upload allexisting ASCII events.


FlowReadTimeOut integer -flowreadtimeout integer Use this property to specify thetime (in seconds) the probe waitswhile reading from the flowsocket.

The default is 60.

Note: If this property is set to 0,the probe waits indefinitely.

HeartbeatInterval integer -heartbeatintervalinteger

Use this property to specify thetime (in seconds) within which theprobe expects to receive either anevent or a heartbeat message fromNokia NetAct; if neither isreceived for a period that exceedsthis interval, the probe sends aProbeWatch message to theObjectServer.

The default is 300.

Host string -host string Use this property to specify thehost to which the probe connects.

The default is localhost.

NonStandardAlarm Filestring

-nonstandardalarm string Use this property to specify thelocation of the file in which tostore nonstandard alarms.

The default is$OMNIHOME/Omnibus/var/nokianetact.NonStandardAlarmFile.

NonStandardCaptureinteger

-nononstandard

(equivalent toNonStandardCapture witha value of 0)

-nononstandard

(equivalent toNonStandardCapture witha value of 1)

Use this property to specifywhether the probe writesnonstandard alarms to a file:

0: The probe does not writenonstandard alarms to a file.

1: The probe writes nonstandardalarms to a file.

The default is 1.




OutputXMLParse Errorsinteger

-nooutputxmlparse errors

(equivalent to ParseErrorswith a value of 0)

-outputxmlparse errors

(equivalent toOutputXMLParseErrorswith a value of 1)

Use this property to specifywhether the probe outputs anyXML parsing errors that occur:

0: The probe does not output XMLparsing errors.

1: The probe outputs XML parsingerrors.

The default is 1.

ParseXmlOids integer -noparsexmloids

(equivalent toParseXmlOids with a valueof 0)

-parsexmloids

(equivalent toParseXmlOids with a valueof 1)

Use this property to specifywhether the probe parses the XMLobject identifier (OID) tags:

0: The probe does not parse XMLOID tags.

1: The probe parses XML OIDtags.

The default is 0.

Retry integer -retry integer Use this property to specify thenumber of times the probe retriesconnecting to the host systembefore shutting down.

The default is 3.

RetryTimeOut integer -retrytimeout integer Use this property to specify thetime (in seconds) the probe waitsbefore attempting to reconnect tothe host system.

The default is 30.

StreamCapture integer -nostreamcapture

(equivalent toStreamCapture with avalue of 0)

-streamcapture

(equivalent toStreamCapture with avalue of 1)

Use this property to specifywhether the stream capturefeature is enabled for debuggingpurposes:

0: Disable the stream capturefeature.

1: Enable the stream capturefeature.

The default is 0.

Note: If you set this property to 1,you must specify the file in whichto store the data using theStreamCaptureFilename property.When you no longer require datafor debugging, set theStreamCapture property to 0 todisable the stream capturefunction.




StreamCapture Filenamestring

-streamcapture filenamestring

Use this property to specify whichfile the probe uses to store theinput stream log.

The default is$OMNIHOME/var/nokianetact.stream.

Note: This property is required ifyou set the StreamCaptureproperty to 1.

Timeout integer -timeout integer Use this property to specify thetime (in seconds) the probe waitsto receive events from the devicebefore it disconnects and shutsdown.

The default is 180.

Upload integer -noupload

(equivalent to Upload witha value of 0)

-upload

(equivalent to Upload witha value of 1)

Use this property to specifywhether the probe reads allexisting events before listening fornew events as they are generated:

0: The probe does not uploadexisting events.

1: The probe uploads existingevents.

The default is 1.

UploadReadTimeOut integer -uploadreadtimeoutinteger

Use this property to specify thetime (in seconds) to wait whilereading from the upload socket.

The default is 0 (probe waitsindefinitely).

XmlAlarmHeader string -xmlalarmheader string Use this property to specify theregular expression match theprobe uses to find the start of anXML event.

The default is <?xml version=.*.

XmlHeartbeatAlarm Headerstring

-xmlheartbeatalarm string Use this property to specify theregular expression match to findthe start of an XML heartbeatalarm.

The default is".*<netact4bb_heartbeat_event..*".

XmlPortCurrent integer -xmlportcurrent integer Use this property to specify theport on which to listen for currentXML events as they are generated.





XmlPortUpload integer -xmlportupload integer Use this property to specify theport from which to upload allexisting XML events.


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 elements that the probe generates depends on whether the alarms received arein XML or ASCII format.

XML and ASCII elements are described in the following topics:v “Elements generated for alarms in XML format”v “Elements generated for alarms in ASCII format” on page 13

Elements generated for alarms in XML formatThe following table describes the elements that Nokia NetAct for Broadbandgenerates for XML alarms.

Table 6. Elements for alarms in XML format

Element name Element description

$agent_address This element contains the address of the agent.

$card This element contains the card of the eventsource.

$correlation_id This element displays the correlation identifier ofthe event.

$element_type This element displays the type of networkelement affected.

$event_message This element displays information about thealarm.

$event_oid This element displays object identifier of theevent.

$event_severity This element displays the severity of the event.

$event_status This element displays the status of the event.

$event_time This element displays the time at which the eventwas generated.

$event_type This element displays the type of event.

$event_uuid This element displays the identifier of the event.

$ip_address This element displays the IP address of thenetwork element.

$ne_name This element displays the name of the networkelement affected.

$neid This element displays the identifier of thenetwork element affected.


Table 6. Elements for alarms in XML format (continued)


$port This element displays the port of the eventsource.

$shelf This element displays the shelf of the eventsource.

Elements generated for varbind variablesIf the ParseXmlOids property is set to 1, the probe also generates elements for thevarbind variables generated by the SNMP trap. These are mapped to elementscalled $var_1, $var_2, $var_3, and so on. For each varbind, the object ID is placedin a corresponding element called $var_1:oid, $var_2:oid, $var_3:oid, and so onup to the number of varbind elements.

Elements generated for alarms in ASCII formatThe following table describes the elements that Nokia NetAct for Broadbandgenerates for ASCII alarms.

Table 7. Elements for alarms in ASCII format


$ADD_TEXT This element indicates contains additionalinformation about the alarm.

$AMO This element contains the Affected ManagementObject (AMO) name.

$ASSOC This element displays the type of AMO.

$CLASS This element displays the type of equipmentgenerating the alarms.

$COR_N This element indicates the notification ID forcancelled alarms. This ID corresponds to therespective N-ID which was cancelled.

$EVENT_TYPE This element displays the type of event.

$IND This element indicates the end of the alarm.

$IND_ID This element displays a sequence number foridentifying missed alarms.

$INST This element displays the local distinguishedname of the AMO in Nokia NetAct.

$MODE This element displays the mode of the event.

$N_ID This element indicates a unique alert notification.

$P_CAUSE This element displays the name of the trap andits object identifier.

$P_SEVERITY This element displays the severity of alarm.

$S_PROBLEMS This element indicates that the alert originated inNokia NetAct.

$SYSTEM This element displays the name of the systemforwarding the alarms.

$TIME This element displays the time at which the eventwas generated.


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

The following table describes the error messages specific to this probe. Forinformation about generic error messages, see the IBM Tivoli Netcool/OMNIbusProbe and Gateway Guide, (SC14-7530).

Table 8. Error messages

Error Description Action

alarms are not XML -check AlarmsAreXMLproperty

The probe received events inASCII format instead of theexpected XML format.

Change the value set for theAlarmsAreXML property to 0.

alarms are XML -AlarmsAreXML propertyshould be 1

The probe received events inXML format instead of theexpected ASCII format.

Change the value set for theAlarmsAreXML property to 1.

Connection LostConnectionUnsuccessful

The probe lost connectionwith the host.

Check that you can access thetarget port from the hostrunning the probe.

Failed to open currentsocketFailed to openupload socketConnectionto Current SocketLostFailed to opensocket. Invalid PortNumber!

The probe could not open thesocket.

Check that there are noproblems with your network,and that you configured thecorrect port number in theprobe properties.

Connection to UploadSocket Lost

The probe lost connection tothe upload socket.

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

CreateAndSet failed fortoken name token value

The probe is unable to createan element for the token.

Contact IBM TechnicalSupport.

End of Event not found End of Event not found in theASCII or XML message.

Check the correctness of thesupplied events.

Error reading from socket Error encountered whilereading from socket.

Check whether data isavailable at the socket forreading.

Failed to allocate buffermemory

Memory allocation failed. Check memory usage andmemory availability on thesystem.

Only managed to writenumber out of numbercharactersUnable to writeto file filename

The probe could not write allthe data from the buffer tothe alarm log file.

Check that there is sufficientdisk space and that thepermissions are correct.

SendAlert failed The probe was unable to sendan alert to the ObjectServer.

Check the availability of theObjectServer.


Table 8. Error messages (continued)

Error Description Action

Timed Out trying to opensocketTimed Out trying toopen upload socket

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

Check that you did not setthe Timeout property too low.Check that there are noproblems with your networkand that you have configuredthe correct port number in theprobe properties.

Unable to open file The probe was unable to openthe hosts file.

Check that the hosts file existsand that the permissions areset correctly.

Unable to open file:file The probe could not open thespecified file.

Check the existence orpermissions of the specifiedfile.

Unable to write to fileOnly managed to write nout of buffer sizecharacters

The probe could not write allthe data from the buffer tothe alarm log file.

Check that there is sufficientdisk space and that thepermissions are correct.

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

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

Table 9. ProbeWatch messages

ProbeWatch message Description Triggers/causes

Alarms are not XML -check AlarmsAreXMLproperty

The probe detected that thealarms are not in XML format.

The alarms received are inASCII format, but theAlarmsAreXML property is setto 0.

Alarms are XML -AlarmsAreXML propertyshould be 1

The probe detected that thealarms are in XML format.

The alarms received are inXML format, but theAlarmsAreXML property is setto 1.

Connection successful tocurrent socket

The connection of the probeto the current socket wassuccessful.

The probe successfullyconnected to the currentsocket.

Connection successful toupload socket

The connection of the probeto the upload socket wassuccessful.

The probe successfullyconnected to the uploadsocket.

Connection to CurrentSocket Lost

The probe has lost theconnection to the currentsocket.

There is a problem with yourmachine, the network, or theprobe configuration, or thecurrent socket has gonedown.


Table 9. ProbeWatch messages (continued)


Connection to UploadSocket Lost

The probe has lost theconnection to the uploadsocket.

There is a problem with yourmachine, the network or theprobe configuration, or theupload socket has gone down.

Connection Unsuccessful The connection wasunsuccessful.

There may be a problem withthe network.

Disconnecting from uploadport in TimeOut

The connection timed outreading from the upload portafter the time specified by theUploadReadTimeOut property,and then disconnecting fromupload port.

As the time specified by theUploadReadTimeOut propertywas exceeded, the probedisconnected from the uploadport.

Heartbeat Timeout The probe has exceeded theperiod specified by theHeartbeatTimeOut property.

The probe has not received astandard alarm or a heartbeatmessage for the periodspecified by theHeartbeatTimeOut property.

NonStandard Alarmencountered.NonStandardCapture notactivated

The probe read a nonstandardalarm which will not bewritten to the file specified bythe file specified by theNonStandardAlarmFileproperty.

The probe read a nonstandardalarm and theNonStandardCapture propertyis set to 0.

NonStandard Alarmencountered. Line writtento fileNonStandardAlarmFile

The probe read a nonstandardalarm which will be writtento the NonStandardAlarmFileproperty.

The probe read a nonstandardalarm and theNonStandardCapture propertyis set to 1.

Reconnection to currentsocket unsuccessful

The reconnection to thecurrent socket wasunsuccessful.

There may be a problem withthe network.

Timed out on currentport, retrying inRetryTimeOut seconds

The connection to the currentport timed out.

The probe received no eventsfrom the current port for aperiod specified by theFlowReadTimeOut property.The probe will retry the portin the number of secondsspecified by the RetryTimeoutproperty.

Timed out on upload port The connection to the uploadport timed out.

The probe received no eventsfrom the upload port for aperiod specified by theUploadReadTimeout property.

Unable to open file: file The probe was unable to openthe specified file.

The file may not exist or mayhave the incorrectpermissions.

Unable to write to file:file, NonStandardCapturedeactivated

The probe was unable towrite to the specified file.

The probe received anon-standard event, and theNonStandardCapture propertyis set to 0.


Table 9. ProbeWatch messages (continued)


Unable to write to file:filename only managed towrite n number out oftotal number ofcharacters

The probe could not write thewhole message to the filespecified.

There was an error writing tothe specified file.

Upload socket notselected

The probe did not connect toan upload socket and so onlyread from the alarmforwarder port.

An upload socket was notspecified in the properties file.



Appendix. Notices and Trademarks

This appendix contains the following sections:v Noticesv Trademarks

NoticesThis information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia CorporationLicensing 2-31 Roppongi 3-chome, Minato-kuTokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

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

© Copyright IBM Corp. 2006, 2011 19

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 21


��

Printed in USA

SC23-7890-02

Documents

IBM Tivoli Netcool/OMNIbus Probe for Nokia NetAct for ... · PDF fileNetcool/OMNIbus Probe for Nokia NetAct for Broadband Version 4.0 Reference Guide January 31,2011 SC23-7890-02