Embed Size (px)
Citation preview
Tivoli® Netcool/OMNIbus Probe for Alcatel OCB-283Version 5.0.5848
Reference GuideJanuary 31, 2011
SC23-7841-02
���
Tivoli® Netcool/OMNIbus Probe for Alcatel OCB-283Version 5.0.5848
Reference GuideJanuary 31, 2011
SC23-7841-02
���
NoteBefore using this information and the product it supports, read the information in “Notices and Trademarks,” on page 11.
Edition notice
This edition applies to version 5.0.5848 of IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent OCB-283(SC23-7841-02) and to all subsequent releases and modifications until otherwise indicated in new editions.
This edition replaces SC23-7841-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 forAlcatel-Lucent OCB-283 . . . . . . . . 1Summary . . . . . . . . . . . . . . . 1Installing probes . . . . . . . . . . . . . 2Internationalization support . . . . . . . . . 3
Example multi-byte character set on Solaris . . . 4Data acquisition . . . . . . . . . . . . . 4Peer-to-peer failover functionality . . . . . . . 5
Example property file settings for peer-to-peerfailover . . . . . . . . . . . . . . . 5
Properties and command line options . . . . . . 5Elements. . . . . . . . . . . . . . . . 7Error messages . . . . . . . . . . . . . 8
Appendix. Notices and Trademarks . . 11Notices . . . . . . . . . . . . . . . . 11Trademarks . . . . . . . . . . . . . . 13
© Copyright IBM Corp. 2006, 2011 iii
iv IBM Tivoli Netcool/OMNIbus Probe for Alcatel OCB-283: Reference Guide
Document control page
Use this information to track changes between versions of this guide.
The IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent OCB-283documentation is provided in softcopy format only. To obtain the most recentversion, 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
00 September 26,2008
First IBM publication.
01 December 31,2008
Summary table updated.
IPv6 support information added.
FIPS information added.
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 Alcatel OCB-283: Reference Guide
IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent OCB-283
The Alcatel OCB-283 is a network element manager that operates real-time serversand Alcatel switches. It collects data from network elements and forwards it toapplications, enables basic remote access to network elements, and manages datasecurity and integrity.
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 5v “Elements” on page 7v “Error messages” on page 8
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 IBM Tivoli Netcool/OMNIbusProbe for Alcatel-Lucent OCB-283.
Table 2. Summary
Probe target Alcatel 1000 E10/OCB-283
Probe executable name nco_p_alcatel_ocb283
Package version 5.0
Probe supported on Solaris, HP-UX, AIX®, Linux
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/alcatel_ocb283.props
Rules file $OMNIHOME/probes/arch/alcatel_ocb283.rules
© Copyright IBM Corp. 2006, 2011 1
Table 2. Summary (continued)
Requirements A currently supported version of IBM TivoliNetcool/OMNIbus.
probe-compatibility-3.x (for IBM TivoliNetcool/OMNIbus version 3.6)
common-libnetcool-3_1 (for IBM TivoliNetcool/OMNIbus version 3.6)
common-libOpl-7_6 (for IBM Tivoli Netcool/OMNIbusversion 3.6)
Connection method Telnet
Remote connectivity The Probe for Alcatel OCB-283 can connect to a remotedevice. Details of the remote device are specified usingthe Host and Port properties.
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, and 7.3.0.
Peer-to-peer failover functionality Available
IP environment IPv4 and IPv6Note: The probe is supported on IPv6 when runningon IBM Tivoli Netcool/OMNIbus V7.2.0, 7.2.1, and 7.3.0on all UNIX and Linux operating systems.
Federal Information ProcessingStandards (FIPS)
IBM Tivoli Netcool/OMNIbus V7.2.1 and 7.3.0 use theFIPS 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:
2 IBM Tivoli Netcool/OMNIbus Probe for Alcatel OCB-283: Reference Guide
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 arepeculiar 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
IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent OCB-283 3
Table 3. Supported language locales (continued)
Languages AIX HP-UX Solaris Linux
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.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 Alcatel OCB-283 is a single headed socket-based client. It connects toa specified host and port. The probe performs a configurable chat in sequencebefore reading alarms.
Login Sequence
The login sequence is as follows:1. The probe sends a ^A character to the device2. The probe waits for the interface to send the @ shell prompt3. After the shell prompt is received, the probe sends a ^D character to inform the
switch that it has the right of way on the interface4. The interface then sends a LIBERATION DU TERMINAL message, which the
probe discards5. The probe then starts to process the alarms
Wakeup Processing
If the device is inactive for a period longer than that specified by theConnectionMaxWait property, the probe sends a ^A character to determinewhether the device is still running. If the device fails to respond within the timespecified by the Timeout property, the probe exits.
4 IBM Tivoli Netcool/OMNIbus Probe for Alcatel OCB-283: Reference Guide
Raw Stream Capture
The Probe for Alcatel OCB-283 can capture all raw data sent from a device. Thisraw data is stored in a log file and can be used for debugging purposes, todevelop new features for the probe, or to pass to other management systems thatrequire the same data. To enable stream capture, set the StreamCapture property to1 and specify a file to store the data using the StreamCaptureFilename property.
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.
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-6373).
IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent OCB-283 5
Table 4. Properties and command line options
Property name Command line option Description
ChatIn string -chatin string Use this property to specify thechat in script for connection to thehost system.
The default is @ \\004.
ConnectionMaxWait string -connectionmaxwait string Use this property to specify thetime (in seconds) that the probewaits to receive a data streamfrom the device before sending awakeup string.
The default is 900.
ConnectionRetryIntervalsinteger
-connectionretryintervalsinteger
Use this property to specify thetime (in seconds) that the probewaits between successive wakeupattempts.
The default is 10.
DiscardCharacter string -discardcharacter string Use this property to specify thecharacter that the probe discardsfrom the incoming data stream.
The default is Ctrl-G.
FlashTimeout integer -flashtimeout integer Use this property to specify thetime (in seconds) the probe waitsbefore flushing the event to theObjectServer.
The default is 3.
Host string -host string Use this property to specify thename of the host to which theprobe connects.
The default is localhost.
LoginAskShellRetriesinteger
-loginaskshellretries integer Use this property to specify thenumber of times the proberequests a shell from the device.
The default is 3.
LoginRetries integer -loginretries integer Use this property to number oftimes that the probe attempts tolog in to the device.
The default is 3.
LoginShellTimeout integer -loginshelltimeout integer Use this property to specify thetime (in seconds) that the probewaits for the device to present acommand prompt.
The default is 3.
Port integer -port integer Use this property to specify theport to which the probe connects.
The default is 2600.
6 IBM Tivoli Netcool/OMNIbus Probe for Alcatel OCB-283: Reference Guide
Table 4. Properties and command line options (continued)
Property name Command line option Description
ReconnectionAttemptsinteger
-reconnectionattemptsinteger
Use this property to specify themaximum number of times thatthe probe attempts to reconnect tothe socket.
The default is 3.
StreamCapture integer -streamcapture integer Use this property to specifywhether data stream capture isactive:
0: The probe keeps the datastream capture inactive.
1: The probe keeps the datastream capture active.
The default is 0.
StreamCaptureFilenamestring
-streamcapturefilenamestring
Use this property to specify thefile the probes uses (when thestream capture is enabled) to storethe input stream log.
The default is$OMNIHOME/var/alcatel_ocb283.Stream.
Timeout integer -timeout integer Use this property to specify thenumber of milliseconds that theprobe allows the socket to besilent. If this time is exceeded, itassumes that the connection isdead and disconnects.
The default is 180.
WakeUp string -wakeup string Use this property to specify thecharacter that the probe sends tothe device to initiate a session.
The default is \\001.
ElementsThe probe breaks event data down into tokens and parses them into elements.Elements are used to assign values to ObjectServer fields; the field values containthe event details in a form that the ObjectServer understands.
The following table describes the elements that the Probe for Alcatel OCB-283generates. Not all the elements described are generated for each event; theelements that the probe generates depends upon the event type.
Table 5. Elements
Element name Element description
$Priority This element indicates the severity of the alarm.
$FormatEdition This element contains the alarm format number.
IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent OCB-283 7
Table 5. Elements (continued)
Element name Element description
$Nidal This element shows the alarm identificationnumber.
$Date This element shows the date of the alarm.
$Time This element shows the time of the alarm.
$N This element contains the serial number of theswitch.
$TYP This element indicates the type of alarm.
$CAT This element indicates the category of the alarm.
$EVENT This element shows the state of the alarm.
$NCEN This element identifies the name of theswitch/exchange.
$AM This element contains the physical address.
$AFUR This element contains part of the address (notalways present).
$AFCN This element contains part of the address (notalways present).
$OBJET This element contains part of the address (notalways present).
$AGEO This element shows the geographic address.
$TEXAL This element contains the summary.
$LineXX This element contains additional lines ofinformation about the 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-6373).
Table 6. Error messages
Error Description Action
Connection Unsuccessfulwait for seconds
Connection Unsuccessful
There is a problem with thenetwork.
Check that you can access thetarget port from the hostrunning the probe.
ConvertEscapes: Errorallocating memory foroctal code
Expect: Error allocatingmemory for buffer
There is not enough memoryavailable.
Make more memory available.
Expect timed out afterseconds
When the probe tried to login or log out of the host, theexpect part of the chat timedout.
Check that the login nameand password are valid forthe target host.
8 IBM Tivoli Netcool/OMNIbus Probe for Alcatel OCB-283: Reference Guide
Table 6. Error messages (continued)
Error Description Action
Failed to open socket. There is a problem with yourmachine, the network, or theprobe configuration.
Check that there are noproblems with your networkand that you configured thecorrect port number in theprobe properties file.
Failed to open socket.Invalid port number.
You have specified either anon-existent port number or aport number that is already inuse.
Correct the port number inthe probe properties file.
Failed to wake up The device has failed torespond to the probe withinthe time specified by theTimeout property.
Check that the AlcatelOCB-283 system is workingcorrectly.
Only managed to writepercentage out of totalcharacters
The probe cannot write outdata because the disk is full.
Make more space available onyour disk.
Timed out trying to opensocket
There is a problem with yournetwork, the Alcatel OCB283system, or the probeconfiguration.
Change the Timeout propertyto a higher value. Check thatthere are no problems withyour network and that youconfigured the correct portnumber in the probeproperties file. Check that theAlcatel OCB-283 system isworking correctly.
Unable to open file:filename - reason
The probe could not open thefile specified.
Check that the permissionsare set correctly on the filespecified.
Unable to write to file:filename - reason
The filename indicates a filethat the probe could not openor write to. The reasonindicates why the probe couldnot open or write to the file.
Check that the file exists andthat its access permissions areset correctly.
IBM Tivoli Netcool/OMNIbus Probe for Alcatel-Lucent OCB-283 9
10 IBM Tivoli Netcool/OMNIbus Probe for Alcatel OCB-283: Reference Guide
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 11
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.
12 IBM Tivoli Netcool/OMNIbus Probe for Alcatel OCB-283: Reference Guide
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 13
14 IBM Tivoli Netcool/OMNIbus Probe for Alcatel OCB-283: Reference Guide
����
Printed in USA
SC23-7841-02
