version 4.0.6025 nm2100 netcool/omnibus probe for ......example multi-byte character set on solaris...

Netcool/OMNIbus Probe for Tellabs FOCUSNM2100Version 4.0.6025

Reference GuideFebruary 28, 2009

IBM

SC23-7938-01

Note

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

Edition notice

This edition applies to version 4.0.6025 of IBM Tivoli Netcool/OMNIbus Probe for Tellabs FOCUS NM2100(SC23-7938-01) and to all subsequent releases and modifications until otherwise indicated in new editions.

This edition replaces SC23-7938-00.© Copyright International Business Machines Corporation 2006, 2009.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract withIBM Corp.

Contents

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

Chapter 1. Probe for Tellabs FOCUS NM2100.......................................................... 1Summary...................................................................................................................................................... 1Data acquisition........................................................................................................................................... 2

Heartbeating........................................................................................................................................... 2Data stream capture...............................................................................................................................2Event buffering....................................................................................................................................... 3Read timeout.......................................................................................................................................... 3

Managed devices..........................................................................................................................................3Internationalization support........................................................................................................................3

Example multi-byte character set on Solaris.........................................................................................4Peer-to-peer failover functionality.............................................................................................................. 5

Example property file settings............................................................................................................... 5Properties and command line options........................................................................................................ 5Elements...................................................................................................................................................... 7Error messages............................................................................................................................................ 7ProbeWatch messages.................................................................................................................................9

Appendix A. Notices and Trademarks................................................................... 11Notices....................................................................................................................................................... 11Trademarks................................................................................................................................................ 12

iii

Document control page

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

The IBM Tivoli Netcool/OMNIbus Probe for Tellabs FOCUS NM2100 documentation is provided insoftcopy format only. To obtain the most recent version, please visit the IBM Tivoli Netcool KnowledgeCenter:

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

Table 1. Document modification history

Document version Publication date Comments

01 February 20, 2009 First IBM publication.

© Copyright IBM Corp. 2006, 2009 v



vi Netcool/OMNIbus Probe for Tellabs FOCUS NM2100: Reference Guide

Chapter 1. Probe for Tellabs FOCUS NM2100

The Tellabs FOCUS NM2100 network manager is a telecommunications management system for element-level and network-level management of the Tellabs FOCUS product line. It combines wavelength-divisionmultiplexing (WDM) and synchronous digital hierarchy (SDH) equipments into an integrated managedtransmission solution for managing network traffic. The alarm management in the FOCUS NM2100system is based on TeMIP's handling of the Open Systems Interconnection (OSI) formatted alarminformation generated by network elements.

The IBM Tivoli Netcool/OMNIbus Probe for Tellabs FOCUS NM2100 builds a connection to the NM2100device and sends new data records as events to the ObjectServer via a TCP/IP connection.

This guide contains the following sections:

• “Summary” on page 1• “Data acquisition” on page 2• “Properties and command line options” on page 5• “Elements” on page 7• “Error messages” on page 7• “ProbeWatch messages” on page 9

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

The following table summarizes the probe.

Table 2. Summary

Probe target Tellabs Focus NM2100 Network Manager

Probe executable name nco_p_nm2100

Patch number 4.0

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

https://www-304.ibm.com/support/docview.wss?uid=swg21412068

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

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

Requirements A currently supported version of IBM Tivoli Netcool/OMNIbus.

probe-compatibility-3.x (for Netcool/OMNIbus 3.6 only)

Connection method The probe telnet to TCP/IP socket.

© Copyright IBM Corp. 2006, 2009 1



Table 2. Summary (continued)

Remote connectivity The Probe for Tellabs FOCUS NM2100 can connect to a deviceon a remote host. Details of the remote host are specified usingthe Host and Port properties.

Peer-to-peer failover functionality Available

Multicultural support Available

IP environment IPv4 and IPv6

Note: The probe is supported on IPv6 when running on IBMTivoli Netcool/OMNIbus V7.3.0, 7.3.1 and 7.4.0 on all UNIX andLinux operating systems.

Federal Information ProtocolStandards (FIPS)

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

Data acquisitionEach probe uses a different method to acquire data. The method that a probe uses is based on the targetsystem from which the probe receives data.

The Probe for Tellabs FOCUS NM2100 is a socket probe that connects to the Tellabs Focus NM2100Network Manager. On startup, the probe opens a telnet session to the socket on the NM2100 machineand receives all outstanding events. The probe then waits to receive new events as they occur.

• “Heartbeating” on page 2• “Data stream capture” on page 2• “Event buffering” on page 3• “Read timeout” on page 3

HeartbeatingWhen the connection is lost between the fault adapter and the device, heartbeating allows the probe todetermine whether the device is still alive. If the heartbeating feature is enabled and the target systemfails, the probe tries to ping the fault adapter module until it is active again. The probe then reestablishesa connection and starts to acquire alert data again. If the system fails to respond to the heartbeats, theprobe disconnects from the device.

If the probe fails to receive any data for the number of seconds specified by the HeartbeatIntervalproperty, it pings the fault adapter. If the probe does not receive the ping within the time specified by theHearbeatTimeout property, the probe disconnects and switches to reconnection mode. TheHeatbeatRetry property allows you to specify how many times the probe sends heartbeats to the devicebefore disconnecting.

Data stream captureThe probe can capture the data stream sent from a device. This data is stored in a log file and can be usedfor debugging purposes, to develop new features for the probe, or to pass to other management systemsthat require the same data. To enable stream capture, set the StreamCapture property to 1 and specify alog file to store the data using the StreamCaptureFilename property.

2 Netcool/OMNIbus Probe for Tellabs FOCUS NM2100: 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

The probe creates a stream capture file with the following naming convention:

streamcapturefile name_date_time

By appending the filename with a timestamp, the probe avoids overwriting the old stream capture file.

Note: The data stream capture function generates a lot of data and should be used with caution. Whenyou no longer require data for debugging, set the StreamCapture property to 0 to disable the streamcapture function.

Event bufferingBuffering is a standard feature in all probes. The probe buffers events and sends them to the ObjectServerin a batch when the buffer reaches a predetermined size. To specify that the probe uses buffering, set theBuffering property to 1. To specify the size of the buffer, use the BufferSize property.

Read timeoutThe ReadTimeOut property specifies how long the probe waits to read alarm data before timing out. Eachtime the probe attempts to read an alarm, this is the allotted time that it waits to receive data; if nothing isreceived, it moves on to the next alarm.

Managed devicesThe following devices are managed by the EMS system with which this probe integrates:

Telco/Enterprise element management systems

• Tellabs FOCUS NM2100

Telco and Voice Devices

• Fibcom 7200 Optical Transport System• Fibcom FOCUS 6200 (DWDM)• Fibcom FOCUS AC0• Fibcom FOCUS AC 1 (STM 1/4)• Fibcom FOCUS AC4 (STM 4/16)• Fibcom FOCUS LX• Tellabs 6350 transport switch• Tellabs FOCUS 6200• Tellabs FOCUS AC4• Tellabs FOCUS Atex

Note: This list is not comprehensive and it is likely that additional devices are managed by the EMS. Theinformation provided is intended as a guide for reference purposes only. Refer to the vendor of your EMSfor confirmation of the devices that are managed by your system.

Internationalization supportThe probe supports multibyte character sets (for example, Japanese) and character sets that containindividual multibyte characters (for example German, French, and Spanish). To view the character setscorrectly, you must configure the locale settings on the host machine correctly.

If you are using a language that contains multibyte characters, you must set the LANG environmentvariables to the name of your character set, and export the LC_ALL environment variable. For example, ifyou are using Japanese, set these environment variables to ja_JP.UTF-8; if you are using German, set

Probe for Tellabs FOCUS NM2100 3

these environment variables to de_DE.UTF-8. This will enable the probe to recognise the multibytecharacters used by your character set when they occur in any network events.

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

Simplified Chinese zh_CN zh_CN zh_CN zh_CN

Traditional Chinese 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 character set:

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 file and reboot it to makethe changes take effect.

3. Make sure that the file $OMNIHOME/platform/arch/locales/locales.dat has the followingentry:

locale = ja_JP PCK, japanese, sjis

Where ja_JP PCK is the vendor locale, japanese is the Sybase language, and sjis is the Sybasecharacter set.


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

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

Example property file settings for peer-to-peer failoverYou set the peer-to-peer failover mode in the properties files of the master and slave probes. The settingsdiffer for a master probe and slave probe.

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

The following example shows the peer-to-peer settings from the properties file of a master probe:

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

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

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

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

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


Table 4. Properties and command line options

Property name Command line option Description

HeartbeatInterval integer -heartbeatinterval integer Use this property to specify the time (inseconds) that the probe waits betweensending successive heartbeats.

The default is 180.

Note: A value of 0 makes the probe waitindefinitely.

HeartbeatRetry integer -heartbeatretry integer Use this property to specify the number oftimes the probe sends a heartbeat requestbefore disconnecting from the device.

The default is 3.

HeartbeatTimeout integer -heartbeattimeout integer Use this property to specify the time (inseconds) in which the probe expects toreceive a response from the device.

The default is 30.

Note: A value of 0 makes the probe disablethe heartbeating feature.

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

The default is localhost.

Port integer -port integer Use this property to specify the active port towhich the probe listens for connections.

The default is 0.

ReadTimeOut integer -readtimeout integer Use this property to specify the time (inseconds) that the probe waits for data whenreading from the port.

The default is 1.

Note: If you set this property to 0, the probewaits indefinitely.

StreamCapture integer -streamcapture integer Use this property to specify whether thestream capture feature is enabled fordebugging purposes. The possible values are:

1: The probe uses the stream capture feature.

0: The probe does not use the stream capturefeature.

The default is 0.


Table 4. Properties and command line options (continued)

Property name Command line option Description

StreamCapture Filenamestring

-streamcapturefilenamestring

Use this property to specify the file the probeuses to store the input data stream.

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

Note: This property is required if you set theStreamCapture property to 1.

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

The following table describes the elements that the probe generates. Not all the elements described aregenerated for each event; the elements that the probe generates depend on the event type.

Table 5. Elements

Element name Element description

$Additional_Text This element contains additional information about thealarm.

$Alarm_Object This element identifies the object for which the alarm hasbeen generated. This identification brings more clarity aboutthe operation context.

$Event_Time This element shows the date and time when the alarm hasoccurred.

$Event_Type This element identifies the event type of the alarm.

$Managed_Object This element identifies the managed object for which thealarm was generated.

$OSI_Alarm This element contains the Open Systems Interconnection(OSI) categorization of the alarm.

$Perceived_Severity This element shows the severity of the alarm as CLEAR,CRITICAL, MINOR, MAJOR or INDETERMINATE.

$Probable_Cause This element indicates the probable cause of the alarm.

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

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


Table 6. Error messages

Error Description Action

Disconnecting after %dunsuccessful retries

The probe could not connect tothe device.

Check the network connectionbetween device and the probe. Ifthis error recurs, contact IBMSoftware Support.

Error while readingalarm

There is a problem with yournetwork or NM2100 machine.

Check the network connectivitybetween the probe and theNM2100 machine.

HeartbeatInterval valuemay not be negative

HeartbeatInterval mustbe greater than zero

HeartbeatTimeout valuemay not be negative

The property specified has beenset to a negative value.

Change the property to a positivevalue.

Host property may notbe blank

The Host property has not beenset.

You must specify a host nameusing the properties file orcommand line options.

Invalid port number The Port property has not beenset to a valid value.

Check that you have specified avalid port number using theproperties file or command lineoptions.

SendAlert failed The probe was unable to send anevent to the ObjectServer.

Check that the ObjectServer isavailable.

SendCommand: Errorallocating memory forcommand

Error allocating memoryfor properties

Expect: Errorallocating memory forbuffer

ConvertEscapes:Errorallocating memory fortemp buffer.

There is not enough memoryavailable.

Make more memory available onyour disk and restart the probe.

Timed out while readingsocket

Unable to connect tohostname and portnumber

There is a problem with the targetserver, the target port, thenetwork, or the properties.

Check that you configured theproperties to access the correctsystem. Check that the NM2100machine is working correctly.Check that your network isworking correctly.


Table 6. Error messages (continued)

Error Description Action

Unable to sendHeartbeat

The NM2100 machine has closedthe connection with the probe.

Check that the NM2100 machineis working correctly.

Unable to get propertyvalues

The probe could not get the valuesspecified either using thecommand line options or from theproperties file.

Contact IBM Software Support.

Unable to write to file The probe could not write theevents in the stream capture file.

Check that the file is available.

Check the permissions set in thefile.

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

The following table describes the raw ProbeWatch error messages that the probe generates. Forinformation about generic ProbeWatch messages, see the IBM Tivoli Netcool/OMNIbus Probe andGateway Guide, (SC23-6373).

Table 7. ProbeWatch messages

ProbeWatch message Description Triggers/causes

Running... The probe is running normally. The probe has just been started.

Going Down ... The probe is shutting down. The probe is shutting down afterperforming the shutdown routine.


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

• Notices• Trademarks

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

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

IBM may have patents or pending patent applications covering subject matter described in this document.The furnishing of this document does not grant you any license to these patents. You can send licenseinquiries, 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 IBM Intellectual PropertyDepartment 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 other country where suchprovisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATIONPROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer ofexpress or implied warranties in certain transactions, therefore, this statement may not apply to you.

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

Any references in this information to non-IBM Web sites are provided for convenience only and do not inany manner serve as an endorsement of those Web sites. The materials at those Web sites are not part ofthe materials for this IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes appropriate withoutincurring any obligation to you.

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

© Copyright IBM Corp. 2006, 2009 11

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 material available for it are providedby IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, orany equivalent agreement between us.

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

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

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

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

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

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

COPYRIGHT LICENSE:

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

Each copy or any portion of these sample programs or any derivative work, must include a copyrightnotice as follows:© (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. ©Copyright IBM Corp. _enter the year or years_. All rights reserved.

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

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


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

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

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

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

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

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

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

Notices and Trademarks 13

IBM®

SC23-7938-01

version 4.0.6025 nm2100 netcool/omnibus probe for ......example multi-byte character set on solaris...

Documents