IBM Tivoli Probe for Ciena ON-Center: Reference Guide · PDF fileData acquisition The Probe...

Netcool/OMNIbus Probe for Ciena ON-CenterVersion 4.0

Reference GuideMarch 28, 2008

SC23-7855-01

��

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

Edition notice

This edition applies to version 4.0.4078 of Tivoli Netcool/OMNIbus Probe for Ciena ON-Center (SC23-7855-01) andto all subsequent releases and modifications until otherwise indicated in new editions.

© Copyright IBM Corporation 2008.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 forCiena ON-Center . . . . . . . . . . . 1Summary . . . . . . . . . . . . . . . 1Data acquisition . . . . . . . . . . . . . 2

Running the probe . . . . . . . . . . . 2Connecting to the CORBA interface. . . . . . 2Retrieving objects . . . . . . . . . . . . 2Status checking . . . . . . . . . . . . 2

Devices managed by the EMS system . . . . . 2Basic configuration . . . . . . . . . . . 3Peer-to-peer failover functionality . . . . . . 3

Properties and command line options . . . . . . 4Elements. . . . . . . . . . . . . . . . 6Error Messages . . . . . . . . . . . . . 7

Appendix. Notices and Trademarks . . . 9Notices . . . . . . . . . . . . . . . . 9Trademarks . . . . . . . . . . . . . . 11

© Copyright IBM Corp. 2008 iii

iv IBM Tivoli Probe for Ciena ON-Center: Reference Guide

Document control page

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

The IBM Tivoli Netcool/OMNIbus Probe for Ciena ON-Center documentation isprovided in softcopy format only. To obtain the most recent version, visit the IBMTivoli Netcool Knowledge Center:

http://www-01.ibm.com/support/knowledgecenter/SSSHTQ/omnibus/common/kc_welcome-444.html?lang=en

Table 1. Document modification history

Documentversion

Publicationdate

Comments

01 March 28,2008

First IBM publication.

© Copyright IBM Corp. 2008 v



vi IBM Tivoli Probe for Ciena ON-Center: Reference Guide

IBM Tivoli Netcool/OMNIbus Probe for Ciena ON-Center

The Ciena ON-Center Management Suite provides element, network, and servicemanagement capabilities across networks.

This guide contains the following sections:v “Summary”v “Data acquisition” on page 2v “Properties and command line options” on page 4v “Elements” on page 6v “Error Messages” on page 7

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 Ciena ON-Center.

Table 2. Summary

Probe target Ciena ON-Center

Probe executable name nco_p_ciena_oncenter

Patch number 4.0

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

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

Connection method CORBA

Remote connectivity Available

The Probe for Ciena ON-Center can connect to a remotedevice. Details of the remote device are specified usingthe Host and Port properties in the properties file.

Internationalization Not available

Peer-to-peer failover functionality Available

IP environment IPv4 only

© Copyright IBM Corp. 2008 1

Data acquisitionThe Probe for Ciena ON-Center collects events from the Ciena ON-Center ElementManagement System (EMS) CORBA interface.

Running the probeThere is no default configuration for this probe. To run this probe, you must:1. Set the EMSUsername and EMSPassword properties.2. Specify either the IOR filename (this is the vendor independent method of

connecting to a CORBA server), or supply the full naming service path to theEmsSessionFactory_I object using the EmsSessionFactoryNS property.

If you specify a value for the EmsSessionFactoryNS property, you must also specifyconnection details for the Naming Service using the NamingServiceHost andNamingServicePort properties.

Connecting to the CORBA interfaceThe probe reads an Interopable Object Reference (IOR) file containing the referenceto the TMF EmsSessionFactory_I object. From this reference, the probe logs intothe system using the user name and password specified by the EMSUsername andEMSPassword properties and creates an EMS Session.

Retrieving objectsIf the Resynch property is set to true, the probe performs a resynch with the EMS.It requests all active EMS and system alarms. After parsing these events, the probeattempts to get a reference to the COS Notification Service to receive new alarms.

Status checkingThe probe checks the status of the IRP agent every 60 seconds. You can change thisfrequency if required using the Agentheartbeat property.

Devices managed by the EMS systemThe following devices are managed by the EMS system with which this probeintegrates:

Telco/Enterprise element management systemsEMS Systemsv Ciena Lightworks ON-Centerv Ciena Transport Network Manager

Telco and Voice Devicesv Ciena CoreDirector Intelligent Optical Core Switchv Ciena CoreDirector CI Intelligent Optical Core Switchv Ciena MetroDirector K2 Multiservice Switching Platform

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

2 IBM Tivoli Probe for Ciena ON-Center: Reference Guide

Basic configurationThis section describes the Probe for Ciena ON-Center configuration requirements.

Installation requirementsBefore running the probe, you must install the latest patch for Java 1.5 (and above)runtime libraries.

Environment variablesBefore using the Probe for Ciena ON-Center, you must include the following pathsin the $CLASSPATH environmental variable:v $OMNIHOME/probes/java/nco_p_ciena_oncenter.jar

v $OMNIHOME/probes/java/NSProbe.jar

v $OMNIHOME/probes/java/vbjorb.jar

v $OMNIHOME/probes/java/lm.jar

v $OMNIHOME/probes/java/vbsec.jar

Where arch is the operating system platform architecture; for example, solaris2.

You must also include the following paths in the $LD_LIBRARY_PATHenvironment variable:v <jre_directory>/lib/

v $OMNIHOME/platform/arch/lib

Wherev <jre_directory> is the directory where the JRE is installedv arch is the operating system platform architecture; for example, solaris2

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.

IBM Tivoli Netcool/OMNIbus Probe for Ciena ON-Center 3

Example property file settings for peer-to-peer failover

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

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

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

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

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 details about generic properties and command line options, see theIBM Tivoli Netcool/OMNIbus Probe and Gateway Guide, SC23-6387.

Table 3. Properties and command line options

Property name Command line option Description

EmsPassword string -emspassword string Use this property to specify thepassword of the account probe uses tocreate an EMS session.

The default is netcoolPassword.

EmsSessionFactoryIORstring

-emssessionfactoryiorstring

Use this property to specify the name ofthe file containing the IOR of theEmsSessionFactory_I object.

The default is "".Note: This is used for the interopablemethod of connecting to CORBA clientsand servers.


Table 3. Properties and command line options (continued)

Property name Command line option Description

EmsSessionFactoryNSstring

-emssessionfactorynsstring

Use this property to specify the name ofthe EmsSessionFactory_I object asregistered in the Naming Service.

The default is EmsSessionFactory-.Note: If you specify a value for thisproperty, you must also specify valuesfor the NamingService Host andNamingServicePort properties.

EmsUsername string -emsusername string Use this property to specify the name ofthe account the probe uses to create anEMS session.

The default is netcoolUser.

NamingServiceHoststring

-namingservicehoststring

Use this property to specify the hostthat has the EmsSessionFactory_I objectto provide the Naming Service.

The default is localhost.

NamingServicePortinteger

-namingserviceportinteger

Use this property to specify the portwhere the EmsSessionFactory_I objectfor the Naming Service is available.

The default is 20025.

Inactivity integer -inactivity integer Use this property to specify the time (inseconds) the probe waits to receiveevents before sending an inactivityprobe watch message.

The default is 60.

Resynch string -resynch string Use this property to specify whetherthe probe requests all active alarmsfrom the EMS before connecting to thenotification service for new alarms:

The default is true.

Timeout integer -timeout integer Use this property to specify the time (inseconds) the probe waits to receiveevents before disconnecting from theNotification Service and shutting down.

The default is 300.


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 generates.

Table 4. Elements

Element name Element description

$additionalInfo This element contains additional informationabout the alarm.

$additionalText This element contains additional informationabout the alarm.

$affectedTPList This element contains a list of TPs affected by anequipment failure. For example, if the alarm is onan equipment that supports PTPs, this elementcontains a list of the ports supported by thisequipment.

$domain_name This element contains the domain name fromwhich the event was sent.

$emsTime This element contains the time at which the eventwas reported by the EMS system.

$event_name This element contains the name of the event.

$event_type This element contains the type of event.

$isClearable This element indicates whether the event isclearable.

$layerRate This element contains the layer to which thisalarm is relevant.

$nativeEMSName This element contains the name used by the EMSinterface for the object reporting an alarm.

$nativeProbableCause This element contains the probable cause for thealarm as defined by the EMS interface.

$neTime This element contains the time of the alarmprovided by the network element.

$notificationId This element contains the identifier of the alarm.

$objectName This element contains the name of the objectreporting an alarm.

$objectType This element contains the type of object reportingan alarm.

$perceivedSeverity This element contains the severity of the alarm.

$probableCause This element contains the probable cause of thealarm.

$probableCauseQualifier This element is used with objectName, layerRate,and probableCause to identify an alarm.

$serviceAffecting This element indicates whether the alarm hasaffected the notification service.


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-6387.

Table 5. Error messages

Error Description Action

Can't create Java VMCode:number

There is a problem startingthe Java Virtual Machine(JVM). This could be due toinsufficient memory.

Make more memory available.

Can't find Consumer class

Can't find Resynch class

Can't find class

The JVM is unable to locatethe specified class.

Check the location ofnco_p_ciena_oncenter. jar inthe $CLASSPATHenvironment variable.

Can't find Method ID

Can't find Static MethodID

Error Occurred CallingConsumer. disconnect!

Error Occurred find Class!

Error Occurred inFindClass for netcoolOut!

Error Occurred in method

Failed to find methodmethod

Failed to find connectmethod

Error Occurred CreatingObjectArray!

There is a problem with theJVM.

Refer to your Javadocumentation.

Error: Cannot get GlobalReference

SessionFlush failed

Error is irrecoverable,shutting down:

Failed to find Consumerconstructor

There is a problem with theJVM.

Refer to your Javadocumentation.

Can't find netcoolOutclass

The JVM is unable to locatethe netcoolOut class.

Check the location ofembeddedjava.jar in the$CLASSPATH environmentvariable.


Table 5. Error messages (continued)

Error Description Action

Ensure that $CLASSPATHincludesnco_p_ciena_oncenter.jar's location

The path of the nco_p_ciena_oncenter.jar file is missingfrom the $CLASSPATHenvironment variable.

Update the $CLASSPATHenvironment variable.

Failed to initialize Internal error. Contact IBM Support.


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 documentin other 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. 2008 9

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®, 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. inthe United 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 11

��

Printed in USA

SC23-7855-01

IBM Tivoli Probe for Ciena ON-Center: Reference Guide · PDF fileData acquisition The Probe...

Documents

Transcript of IBM Tivoli Probe for Ciena ON-Center: Reference Guide · PDF fileData acquisition The Probe...