Netcool/OMNIbus Probe for Siemens SMN-OS: Reference Guide - ibm.com€¦ · IBM ®Tivoli Netcool/OMNIbus Probe for Siemens SMN-OS ... LANG environment variables to the name of your

IBM® Tivoli® Netcool/OMNIbus Probe for Siemens SMN-OSVersion 4.0

Reference GuideMarch 31, 2011

SC23-7806-02

��

IBM® Tivoli® Netcool/OMNIbus Probe for Siemens SMN-OSVersion 4.0

Reference GuideMarch 31, 2011

SC23-7806-02

��

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

Edition notice

This edition applies to version 4.0 of IBM Tivoli Netcool/OMNIbus Probe for Siemens SMN-OS (SC23-7806-02) andto all subsequent releases and modifications until otherwise indicated in new editions.

This edition replaces SC23-7806-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 Probe forSiemens SMN-OS . . . . . . . . . . 1Summary . . . . . . . . . . . . . . . 1Installing probes . . . . . . . . . . . . . 2Internationalization support . . . . . . . . . 3

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

Connecting to the GIF/FM socket . . . . . . 4Operation of the probe . . . . . . . . . . 4Sending PING commands between blocks of data 5Process failure . . . . . . . . . . . . . 5Reconnection attempts . . . . . . . . . . 5Backtracking . . . . . . . . . . . . . 5

Processing messages . . . . . . . . . . . 5Inactivity . . . . . . . . . . . . . . 6Chat in and chat out scripts . . . . . . . . 6Raw stream capture . . . . . . . . . . . 6Peer-to-peer failover functionality . . . . . . 7

Properties and command line options . . . . . . 8Escape codes . . . . . . . . . . . . . 13

Elements . . . . . . . . . . . . . . . 14Error messages . . . . . . . . . . . . . 16ProbeWatch messages . . . . . . . . . . . 19

Appendix. Notices and Trademarks . . 23Notices . . . . . . . . . . . . . . . . 23Trademarks . . . . . . . . . . . . . . 25

© Copyright IBM Corp. 2006, 2011 iii

iv Netcool/OMNIbus Probe for Siemens SMN-OS: Reference Guide

Document control page

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

The IBM Tivoli Netcool/OMNIbus Probe for Siemens SMN-OS documentation isprovided in softcopy format only. To obtain the most recent version, visit the IBM®

Tivoli® Information Center:

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

Table 1. Document modification history

Documentversion

Publicationdate

Comments

01 December 31,2008

Summary table updated.

IPv6 support information added.

FIPS information added.

Installation section added.

02 March 31,2011

Installation section replaced by “Installing probes” onpage 2.

© Copyright IBM Corp. 2006, 2011 v



vi Netcool/OMNIbus Probe for Siemens SMN-OS: Reference Guide

IBM Tivoli Netcool/OMNIbus Probe for Siemens SMN-OS

Siemens Synchronous Digital Hierarchy Management Network Operations System(SMN-OS) is a network element management system. The Generic Interface FaultManagement (GIF/FM) process provides an interface between Siemens SMN-OSand IBM Tivoli Netcool OMNIbus. The Probe for Siemens SMN-OS connects to theGIF/FM interface to retrieve the Siemens SMNOS events.

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 14v “Error messages” on page 16v “ProbeWatch messages” on page 19

SummaryEach probe works in a different way to acquire event data from its source, andtherefore has specific features, default values, and changeable properties. Use thissummary information to learn about this probe.

The following table provides a summary of the Probe for Siemens SMN-OS.

Table 2. Summary

Probe target Siemens SMN-OS

Probe executable name nco_p_siemens_smnos

Package version 4.0

Probe supported on Solaris

For details of the operating system versions on whichthis probe is supported, see the following page on theIBM Tivoli Netcool Information Center:

http://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/Supported_Platforms.htm

Note: This probe is supported on HP-UX version 11.11,but not version 11.0.

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

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

Requirements A currently supported version of IBM TivoliNetcool/OMNIbus

Connection method Telnet/TCP-IP

Remote connectivity The Probe for Siemens SMN-OS can connect to a deviceon a remote host. Details of the remote device arespecified using the Host, HostsFile and Port propertiesin the properties file.

© Copyright IBM Corp. 2006, 2011 1




Table 2. Summary (continued)

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

Internationalization AvailableNote: The probe supports internationalization on IBMTivoli Netcool/OMNIbus V7.2.0, 7.2.1, 7.3.0, and 7.3.1.

Peer-to-peer failover functionality Available

IP environment IPv4 and IPv6Note: The probe is supported on IPv6 when running onIBM Tivoli Netcool/OMNIbus 7.2.0, 7.2.1, 7.3.0, and7.3.1.

Federal Information ProcessingStandards (FIPS)

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

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 TivoliInformation Center:http://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/probes/install/wip/out-html/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 Information Center:http://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/probes/install/wip/out-html/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 are

2 Netcool/OMNIbus Probe for Siemens SMN-OS: 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://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/probes/install/wip/out-html/reference/install_download_intro.html



http://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/probes/install/wip/out-html/reference/install_install_intro.html



peculiar to this probe. For details about additional configuration that iscommon to all probes, see the IBM Tivoli Netcool/OMNIbus Probe and GatewayGuide (SC23-9684).

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

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.

IBM Tivoli Netcool/OMNIbus Probe for Siemens SMN-OS 3

2. Set the LANG and LC_ALL environment variables to ja_JP PCK. This uses SJISencoding.

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. If you are running the probe on Netcool/OMNIbus V7.2.0, make sure that thefile $OMNIHOME/platform/arch/locales/locales.dat has the following 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 Siemens SMN-OS acquires data by connecting to the GIF/FMprocess socket. This socket forwards events from the Siemens SMN-OS system.

Data acquisition is described in the following topics:v “Connecting to the GIF/FM socket”v “Operation of the probe”v “Sending PING commands between blocks of data” on page 5v “Process failure” on page 5v “Reconnection attempts” on page 5v “Backtracking” on page 5v “Processing messages” on page 5v “Inactivity” on page 6v “Chat in and chat out scripts” on page 6v “Raw stream capture” on page 6v “Peer-to-peer failover functionality” on page 7

Connecting to the GIF/FM socket

TheProbe for Siemens SMN-OS is a single-headed probe that can connect to theGIF/FM socket either by referencing a hosts file specified by the HostsFileproperty or by using the Host and Port properties defined in the properties file.

The hosts file contains details of the device to which the probe connects formultiple connections, and the connection properties to use. You can use this file tospecify both a primary host and a backup. If the HostsFile property has not beendefined, then the probe uses the Host and Port properties to make a singleconnection. However if, either of these properties is undefined, the probe exits.

For information about the hosts file, see “Hosts file format” on page 7.

Operation of the probe

In normal operation the probe obtains and processes data as follows:1. Connects to the GIF/FM process sockets defined in the hosts file.2. Expects a PROCESS READY message.


3. Sends the following login commands: PING, ASYNC MSG TRANSFER:ON, CANCEL GETALARM DATA, GET ALARM DATA:OPTIONS= (PENDING or ALL)

4. Reads from the socket until receiving the END OF BLOCK message or *****.5. Processes the alarms in the block.6. Sends the GET NEXT ALARM DATA message.

Sending PING commands between blocks of data

You can specify that the probe sends a PING command to the GIF/FM processbetween each block of data that it receives to check that the process is alive. To dothis, set the PingGifFm property to 1.

Process failure

If the GIF/FM process fails, it is automatically restarted by the Siemens SMN-OSProcess Monitor according to the settings in the Pm.conf configuration file.

Reconnection attempts

If the GIF/FM process becomes unavailable or shuts down the socket connection,the probe attempts to reconnect for the number of reconnection attempts specifiedin the hosts file. If it cannot reconnect and a backup host has been specified, theprobe sets the backup host active flag to TRUE and connects in the same manneras to the main host.

Backtracking

Backtracking feature is enforced at the time of a buffer overflow or after the probeis restarted. Using this feature the probe traces back and retrieves the alarmsgenerated in the past since a particular point of time.

After a buffer overflow the probe automatically backtracks alarms generated for aperiod specified by the BacktrackAsynchPeriod property till the start time ofbacktracking.

When restarted, the probe backtracks from the time found in the recovery file to aperiod specified by the BacktrackRestartPeriod property.

Processing messages

The probe can receive a number of fatal and non fatal messages while processingevent data. If the probe receives any of the following messages, it sends aProbeWatch message to the ObjectServer and shuts down:v ILLEGAL OPERATION

v SYNTAX ERROR

v NO SUCH OPTION

v INVALID OPTION

v INVALID ATTRIBUTE VALUE

v MISSING ATTRIBUTE VALUE

v NO SUCH ATTRIBUTE

v MESSAGE CORRUPTED


If the probe receives any of the following messages, it sends a ProbeWatch messageto the ObjectServer and continues to process alarms:v TEMPORARY FAILURE

v PROTOCOL VIOLATION

v BUFFER OVERFLOW

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 of consecutiveinactivity intervals that the probe allows before disconnecting. If this property isset to 0, the probe disconnects after a single period of inactivity.

Chat in and chat out scriptsChat in and chat out scripts control probe login and logout. These scripts are on asingle line in the expect-send format (for chat in scripts) or send-expect format (forchat out scripts). You can specify chat in and chat out strings using theChatinString and ChatoutString properties or the -chatinstring and -chatoutstringcommand line options.

The format is:ChatinString : expect send expect send....

ChatoutString : send expect send expect....

Note: Each element in the chat strings is separated by white space. In order tosend or expect a sequence that includes white space, surround the sequence withsingle quotes.

A typical chat in script might be:.*login.*:.*anu\r\n.*assword.*:.*anu\r\n

The expect text can use any regular expression, while the send text can send anycharacters, including control characters using the standard UNIX/C escapesequences described in “Escape codes” on page 13.

Note: In a typical setup this facility is not required.

Raw stream captureThe probe can capture all the raw data stream sent from a device. This raw data isstored in a log file and can be used for debugging, to develop new features for theprobe, or to pass to other management systems that require the same data. Toenable stream capture, set the StreamCaptureFile property to 1 and specify a logfile to store the data using the StreamCaptureFile property.

Note: The data stream capture function generates a lot of data. When you nolonger require data for debugging, set the StreamCaptureFile property to 0 todisable the stream capture function.


Hosts file formatThe probe needs a hosts file to connect to multiple hosts. The HostsFile propertyspecifies from which file the probe gets host information. The probe reads the hostsfile and attempts to connect and log in to each host.

If the HostsFile property is defined, the probe attempts to open the specified file.This file must contain the required connection information for the probe in thefollowing format:host port : chi, cho, ft, ia, ri, ra, af;

The following table describes the hosts file format.

Table 4. Hosts file format

Item Description

host This item specifies the host to which theprobe connects.

port This item specifies the port to which theprobe connects.

chi This item specifies the chat in string for thehost/port.

cho This item specifies the chat out string for thehost/port.

ft This item specifies the flush time value forthe host/port.

ia This item specifies the inactivity alarm forthe host/port.

ri This item specifies the reconnection interval.

ra This item specifies the reconnectionattempts.

af This item specifies the active flag. You mustset this to True. Setting this to Falsedeactivates the connection.

When you create a hosts file, note the following information:v In the hosts file, the end of each entry is indicated by a semicolon.v Whitespace and commas separate individual elements within a line.v Whitespace characters are sp and tab.v Comment lines are preceded #.v Blank lines are ignored.v You can force the probe reread the hosts file without restarting the probe by

issuing a USR1 signal. To do this, enter the command kill -USR1 pid, wherepid is the process identifier of the probe.

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 stops


receiving heartbeats from the master and any events it receives thereafter areforwarded to the ObjectServer on behalf of the master probe. When the master isrunning again, the slave continues to receive events, but no longer sends them tothe ObjectServer.

Example property file settings for peer-to-peer failover

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

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

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

Note: The properties file also contains all other properties required to configurethe probe.

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, (SC23-9684).

Table 5. Properties and command line options

Property name Command line option Description

AlarmRequestFormat integer -alarmrequestformat integer Use this property tospecify which alarms theprobe requests whenusing the GET ALARMrequest:

0: This setting indicatesthat all alarms arerequested

1: This setting indicatesthat pending alarms arerequested

The default is 0.


Table 5. Properties and command line options (continued)


AlarmStartTime string -alarmstarttime string Use this property tospecify the time format tobe used when ALL isspecified with theAlarmRequestFormatproperty.

The default is "".

BacktrackAsyncPeriod integer -backtrackasyncperiodinteger

Use this property tospecify the time (in hours)that the probe backtracksthe Asynch time call whena GIF-FM buffer overflowoccurs.

The default is 24.

BacktrackRestartPeriod integer -backtrackrestartperiodinteger

Use this property tospecify the time (in hours)that the probe backtracksif the probe requires torestart using the recoveryfile and a call for ALLalarms.

The default is 24.

BlockResponseTime integer -blockresponsetime integer Use this property tospecify the time (inseconds) the probe waitsbefore time out, for aresponse from the deviceafter sending a GET NEXTALARM DATA message.

The default is 1.

ChatinString string -chatinstring string Use this property tospecify the chat in scriptfor connection to the hostsystem.

The default is "".

ChatoutString string -chatoutstring string Use this property tospecify the chat out scriptfor disconnection from thehost system.

The default is "".

ExpectTimeout integer -expecttimeout integer Use this property tospecify the time (inseconds) the probe allowsfor a response to theexpect part of the chatin/out script.

The default is 20.




Host string -host string Use this property tospecify the name of thehost to which theprobeconnects.

The default is localhost.

HostsFile string -hostsfile string Use this property tospecify the file that theprobe uses to connect tomultiple hosts.

The default is "".

Inactivity integer -inactivity integer Use this property tospecify the time (inseconds) the probe allowsa port to be inactivebefore disconnecting.

The default is 0 (probedoes not disconnect if thehost becomes inactive).

InvalidAlarmLogfile string -invalidalarmlogfile string Use this property tospecify the tile to whichinvalid alarms are logged.The current date will beappended to this filename.

The default is$OMNIHOME/var/siemens_smnos.invalid.

InvalidAlarmLogging integer -invalidalarmlogginginteger

Use this property tospecify whether the probeuses invalid alarmlogging:

0: Probe does not useinvalid alarm logging

1: Probe uses invalidalarm logging

The default is 0.

MaxInvalidAlarmLogFileSizeinteger

-maxinvalidalarmlogfilesizeinteger

Use this property tospecify the maximum sizeof the invalid alarm file.After this limit a new fileis created.

Default is 1048576.




PingGifFm integer -pinggiffm integer Use this property tospecify whether the probesends a PING command inbetween data blocksreceived from the GIF/FMprocess:

0: Probe does not sendPING commands

1: Probe sends PINGcommands in betweenblocks

The default is 0.

PingCount integer -pingcount integer Use this property tospecify the number ofping commands to sendwhen there is no outputfrom GIF/FM.

The default is 0.

PingResponseTime integer -pingresponsetime integer Use this property tospecify the time (inseconds) the probe waitsfor a response after a pingcommand.

Port integer -port integer Use this property tospecify the port to whichthe probe connects.

The default is 23.

ProcessFailureThreshold integer -processfailurethresholdinteger

Use this property tospecify the number ofprocess failure messagesto accept before aborting.

The default is 3.

ReadTimeout integer -readtimeout integer Use this property tospecify the time (inmilliseconds) the probewaits to read alarm databefore timing out.

The default is 100.

ReconnectionAttempts integer -reconnectionattemptsinteger

Use this property tospecify the number oftimes that the probeattempts to reconnect tothe socket.

The default is 0 (probemakes unlimited attemptsto reconnect to the socket).




ReconnectionInterval integer -reconnectionintervalinteger

Use this property tospecify the time (inseconds) betweensuccessive reconnectionattempts.

The default is 0 (probeuses standard backoffstrategy).

RecoveryFile string -recoveryfile string Use this property tospecify the file used tostore timestamp of alarmreads followingsynchronization.

The default is$OMNIHOME/var/siemens_smnos.reco.

ResponseTime integer -responsetime integer Use this property tospecify the time (inseconds) the probe waitsfor a response from thedevice after sending arequest string.

The default is 30.

SendAbortOnDisconnect integer -sendabortondisconnectinteger

Use this property tospecify whether the probesends an ABORTPROCESSING message toGIF/FM on disconnection.

The default is 1.

StreamCapture integer -streamcapture integer Use this property tospecify whether thestream capture feature isenabled:

0: Disable the streamcapture feature

1: Enable the streamcapture feature

The default is 0.

Note: If you set thisproperty to 1, you mustspecify the file in which tostore the data using theStreamCaptureFilenameproperty.




StreamCaptureFile string -streamcapturefile string Use this property tospecify the file the probeuses to store the inputstream log.

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

TimeoutSendingRequest integer -timeoutsendingrequestinteger

Use this property tospecify the time (inseconds) the probe waitsfor a command to besuccessfully sent toGIF/FM.

The default is 20.

Escape codesYou can use C-style escape codes in the ChatinString and ChatoutStringproperties. This allows you to easily define whether to send escape code sequencesafter commands.

For example, the following chatin string sends a carriage return character (\r) afterthe user name and password:ChatinString : ".*: user\r .*: passwd\r .*:"

The following table explains the character sequences that are recognized.

Table 6. ChatinString escape codes

Escape code Character

\b This escape code specifies the backspacecharacter.

\f This escape code specifies the form-feedcharacter.

\n This escape code specifies the new-linecharacter.

\r This escape code specifies the carriage returncharacter.

\t This escape code specifies the tab character.

\\ This escape code specifies the backslashcharacter.

\’ This escape code specifies the single quotecharacter.

\" This escape code specifies the double quotecharacter.

Note: Due to the way in which the above properties are parsed, the escapesequences for backslash, single quote and double quote must be double-escaped.For example, to send a backslash character (\), use \\\\.


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 tables describe the elements that the Probe for Siemens SMN-OSgenerates. Not all the elements described are generated for each event; theelements that the probe generates depends upon the event type.

Elements common to all alarms

The following table describes the common elements that the probe generates.

Table 7. Elements common to all alarms

Element name Description

$Host This element contains the host from which the alarm originated.

$Port This element contains the port from which the alarm originated.

$AlarmType This element contains the type of alarm.

$MsgNo This element contains the unique number used by SiemensSMN-OS to identify the message.

$EventType This element contains the type of alarm event.

$EventTime This element contains the time at which the alarm was generated.

$AlarmObjectClass This element contains the object class affected by the alarm.

$NEObjectInstance This element contains the instance of the object affected by thealarm.

$WorkStatus This element contains the status regarding thetreatment/acknowledgement of the alarm event.

$AcknTime This element contains the time at which the alarm wasacknowledged.

$Acknid This element contains the identifier of the operator who markedthe alarm as acknowledged.

$EndTime This element contains the time at which the alarm was cleared ortreated.

$TreatId This element contains the identifier of the operator who markedthe alarm as treated or the message number of a clear alarm thathas changed the work status of the alarm.

$PerceivedSeverity This element contains the severity of the alarm.

Elements generated for network element alarms

The following table describes the elements that the probe generates for networkelement alarms.

Table 8. Elements


$NEProbableCause This element contains the probable cause of the network elementalarm.

$SDH_NE_ID This element contains the identifier of the network element alarm.

$NEType This element contains the type of network element.


Table 8. Elements (continued)


$NEProduct This element contains the name of the network element product.

$Domain This element contains the user-defined attribute that defines themanagement domain of the object.

$NEInformation This element contains the description of the performanceparameter that failed and its threshold value.

$NEEquipementType This element contains the description of the equipment type.

$NESpecificProblem This element contains the description of the specific problemreported.

Elements generated for network alarms

The following table describes the elements that the probe generates for networkalarms.

Table 9. Elements generated for network element alarms


$NWProbableCause This element contains the probable cause of the network alarm.

$NWAlarmCategory This element specifies whether the alarm is primary or secondary.

$Domain This element contains a user-defined attribute that defines themanagement domain of the object.

$CorrelationId This element contains an identifier that correlates a network alarmwith a corresponding service alarm.

Elements generated for service alarms

The following table describes the elements that the probe generates for servicealarms.

Table 10. Elements generated for service alarms


$SVProbableCause This element contains the probable cause of the service alarm.

$Customer This element specifies the customer name of the service.

$CorrelationId This element contains the identifier that correlates a service alarmwith a corresponding network alarm.

Elements generated for telecommunications managementnetwork alarms

The following table describes the elements that the probe generates fortelecommunications management network alarms.

Table 11. Elements generated for telecommunications management network alarms


$TMNProbableCause This element contains the probable cause of thetelecommunications network alarm.

$ConcernedObjectClass This element specifies the class of the object affected.


Table 11. Elements generated for telecommunications management networkalarms (continued)


$TMNInformation This element contains a description of the alarm.

Elements generated for state change alarms

The following table describes the elements that the probe generates for statechange alarms.

Table 12. Elements generated for state change alarms


$AlarmType This element contains the type of alarm.

$AlarmObjectClass This element contains the object causing the alarm.

$ObjectInstance This element contains the instance of the object causing the alarm.

$ConcernedMsgNumber This element contains the message number of the original alarm.

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, (SC23-9684).

Table 13. Error messages

Error Description Action

Connection closed duringlogin

The probe was unable toconnect to the GIF/FMprocess.

Check that the chat in and chatout scripts are set correctly.

ConvertEscapes: Errorallocating memory foroctal code

The probe was unable toallocate memory for bufferthat contains the eventbeing read. This causedthe probe to terminate.

Make more memory available.

CreateAndSet failed forelement

The probe is unable tocreate the specifiedelement.

Contact IBM Support.

Encountered GIF/FM error- disconnecting

The probe is about todisconnect due to GIF/FMerror.

Check that the device is runningcorrectly.

Error initialising list This is an internal probeerror.

Rerun the probe. If that does notsolve the problem, contact IBMSupport.

Error reading host filefilename

The probe could not openthe hosts file for reading.

Check the permissions for thehosts file and directories, andamend if necessary.


Table 13. Error messages (continued)


Expect timed out afternumber seconds

When the probe tried tolog in to or out of thehost, the expect part of thechat timed out.

Check that the host you areconnecting to is running correctly.Check that the login name andpassword are valid for the targethost.

Expect: Error allocatingmemory for buffer

The probe failed toallocate sufficient memory.


Failed to allocatememory

The probe failed toallocate sufficient memory.


Failed to compileregular expression

A regular expression isincorrectly formed in therules file.

Check the rules file for the regularexpression and correct the entry.

Failed to create andset: element

The probe is unable tocreate an element.


Failed to disconnectfrom host: stringinteger

The probe failed todisconnect properly fromthe device.

Check that the device and theObjectServer are running correctly.

Failed to install signalhandler

The probe was unable toinstall a signal handler forthe signal type specified.The probe will try tocontinue; however, anyfurther signal handlingwill result in an error onexit.


Failed to read fromsocket - disconnecting

The probe hadsuccessfully logged intothe target host, butsomething interrupted theconnection.

Check that the target host isworking correctly.

Failed to retrieve valuefor property: property

The probe failed toretrieve a value for thespecified property.

Check that the properties filecontains the required property andthat it has been specified in theappropriate format.

Failed to rolloverInvalidAlarmLogFile

The probe was unable toroll over to the nextInvalidAlarmLogFile.

Check that there is sufficient diskspace and that the permissions arecorrect.

Failed to send commandcommand

When the probe tried tolog in to or out of thehost, one command in thechat failed.

Check that the host you areconnecting to is running correctly.

Failed to sendProbeWatch message:message

The probe was unable tosend the alert, command,or ProbeWatch messagespecified to theObjectServer.

Check that the ObjectServer isavailable.

Failed to Set value forLastOccurrence

The probe could not setvalue for theLastOccurence field.


File error: filename notfound

The probe could not findthe file specified.

Check that the file exists and thatthe permissions are set correctly.




Have lost allconnections - going down

The probe has lost itsconnection to the socketand is stopping.


Invalid port number forhost: port

The port number specifieddoes not exist on the host.

Check the value specified for Portin the properties file.

Message Received fromGIF/FM

The probe has received afatal message from theGIF/FM process.

Action should be taken as per thedescription included in the errormessage.

No backup host specified There is no backup hostspecified in the host file.

If appropriate, add backup host inthe host file.

No recovery timestampavailable.

The recovery timestamp isnot available from therecovery file.

No action required.

OplPropGetValue() failedfor: property

The probe was unable toconnect to the SiemensSMN-OS system, becausethe property specifiedcontains an incorrectvalue.


Process FailureThreshold reached

The number of processfailures has reached thespecified maximum limit.


PropGetValue failed:RecoveryFile

The probe failed toretrieve a value for thespecified property.


Message Received fromGIF/FM PROTOCOLVIOLATION Received fromGIF/FM, Previous requestdiscarded TEMPORARYFAILURE Received fromGIF/FM - Resendingrequest

The probe has received anon-fatal message fromthe GIF/FM process.

No action is required.

PsockTimeout A socket timeout erroroccured while trying toread event.

Check that the host you areconnecting to is running correctly.

Read error during expect The probe could notprocess the response fromthe host during an expect.This could be caused by aproblem with the targetthat caused the connectionto time out, or theresponse from the targetcould have beencorrupted.

If the probe is configured toreconnect, it will try again toestablish the connection.

Read failure A socket error occuredwhile trying to readevents.

Check that the connection to thedevice is still up.

REGEXP: sub number doesnot exist

A regular expression hasnot been specified.

Check the rules file and correctthe problem.




SendCommand: Errorallocating memory forcommand

There is not enoughmemory available.

Make more memory available andrestart the probe.

SessionProcess failedsession

The probe was unable toprocess the alert againstthe rules file.


Hostfile entry is notvalid linenumber

Too many tokens inhostfile entry

A line in the hosts file wasformatted incorrectly. Check thehosts file.

Unable to compile regexpfor expect_str

A regular expression isincorrectly formed in therules file.

Check the rules file for the regularexpression and correct the entry.

Unable to get events The probe was unable toget any events from thedevice.


Unable to open file:filename - errorstring

The specified file couldnot be created.

Check that there is enough diskspace to save the file. Exact reasonis indicated in the error stringmessage.

Unable to open streamcapture file file

The probe could not openthe file specified.

Check that the permissions are setcorrectly on the file specified.

Unable to write recordfile: Recovery_file

The probe was unable towrite to the recovery file.

Check that the permissions of therecovery file are set correctly.Unable to write to file filename

Only managed to writenumber out of numbercharacters

The probe could not writeto the file specified.

Check that there is sufficient diskspace and that the writepermissions 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, (SC23-9684).

Table 14. ProbeWatch messages

ProbeWatch message Description Triggers/causes

Connection attempted ...(host, port no.)

The probe is trying toestablish a connection tothe host.

The probe tried to establish aconnection to the host.

Connection failed ...(host, port no.)

The probe has failed toestablish a connection tothe host.

General connection failure dueeither to an incorrect setting of theHost or Port property, or the hostrefusing a connection request fromthe probe.

Connection lost ...(host, port no.)

The probe has lost theconnection to the host.

The device dropped theconnection to the probe.


Table 14. ProbeWatch messages (continued)


Connection succeeded ...(host, port no.)

The probe has successfullyestablished a connection tothe host.

The probe successfully establisheda connection to the host.

Disconnected from systemdue to shutdown signal

The probe hasdisconnected from thehost.

A shutdown signal was sent to theprobe.

Disconnecting fromsystem due to Inactivityalarm ...(host, portno.)

The probe hasdisconnected from thedevice.

The device was silent for theperiod specified by the Inactivityproperty. If you want the probe totime out less frequently, increasethis value.

Disconnection attempted... (host, port no.)

The probe is attempting todisconnect from the host.

The probe is shutting down or haslost the connection.

Disconnection failed ...(host, port no.)

The probe has failed todisconnect cleanly fromthe host.

There has been a corruption of thememory location storing theconnection details.

Disconnection succeeded... (host, port no.)

The probe hasdisconnected from thehost.

The probe shut down or lost theconnection.

Failed to get events A problem occurred whilereceiving events.

Either there was a probleminitializing the connection due toinsufficient memory or (if thismessage was sent after someevents had been parsed) there wasa license or a connection failure.

Failed to get license... (host, port no.)

The probe is unable toobtain a license for theconnection to the host.

Either the license server is downor there are insufficient licenses inthe server.

Have lost allconnections - going down

The probe is shuttingdown because all of itsconnections have beendeactivated.

The number of times that theprobe has attempted reconnectionfor each of its connections hasexceeded that specified by theReconnectionAttempts property.

Heartbeat responsereceived ... (host, portno.)

A heartbeat response hasbeen received within theperiod specified by theResponseTime property.

A response matching theResponseTime property in theprops or hosts file has beenreceived.

Heartbeat response timedout ... (host, port no.)

A response to theheartbeat string has notbeen received for theperiod specified by theResponseTime property.

The probe has not received theexpected response or an event andso is disconnecting from andreconnecting to the host.

Heartbeat sent ...(host, port no.)

A heartbeat string hasbeen sent from the probeto the host.

The probe has not received anevent from the device for theperiod specified byTimeoutSendingRequest property.

License failure - goingdown

The license server couldnot be reached.

Either the license has expired, thelicense server has gone down, orthe connection to the licenseserver has been lost.

Login attempted ...(host, port no.)

The probe is trying to login to the host.

The probe is trying to log in to thehost.


Table 14. ProbeWatch messages (continued)


Login failed ... (host,port no.)

The probe has failed tolog in to the host.

The probe has encountered aproblem while logging in usingChatinString property.

Login succeeded ...(host, port no.)

The probe has logged into the host.

The probe has logged in to thehost.

Logout attempted ...(host, port no.)

The probe is trying to logout from the host.

The probe has received acommand to shut down or hasreceived the bounce commandfrom the command port.

Logout failed ... (host,port no.)

The probe has failed tolog out from the host.

The probe has encountered aproblem while logging out usingChatoutString property.

Logout succeeded ...(host, port no.)

The probe has logged outfrom the host.

The probe has logged out from thehost.

Message Received fromGIF/FM

The probe has received afatal message from theGIF/FM process.

Details of the problem that causedthe fatal message are included inthe message.

Synchronisation complete The probe has completedsynchronisation.

The probe received a completeevent, but not the END OF BLOCKstring.

Unable to write recoverytime to file

The probe was unable towrite to the recovery file.

Permissions for the recovery flagmay not be set correctly.



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 23

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 25


��

Printed in USA

SC23-7806-02

Documents

Netcool/OMNIbus Probe for Siemens SMN-OS: Reference Guide - ibm.com€¦ · IBM ®Tivoli Netcool/OMNIbus Probe for Siemens SMN-OS ... LANG environment variables to the name of your