30
Tivoli ® Netcool/OMNIbus Probe for Cisco CTM (CORBA) Version 3.0.5 (CTM Versions 6.0, 7.0, 8.0, 8.5), 1.0.6 (CTM Version 9.0) Reference Guide January 15, 2010 SC23-6033-02

Cisco Ctm Corba-PDF

Embed Size (px)

Citation preview

Page 1: Cisco Ctm Corba-PDF

Tivoli® Netcool/OMNIbus Probe for Cisco CTM (CORBA)Version 3.0.5 (CTM Versions 6.0, 7.0, 8.0, 8.5), 1.0.6 (CTM Version9.0)

Reference GuideJanuary 15, 2010

SC23-6033-02

����

Page 2: Cisco Ctm Corba-PDF
Page 3: Cisco Ctm Corba-PDF

Tivoli® Netcool/OMNIbus Probe for Cisco CTM (CORBA)Version 3.0.5 (CTM Versions 6.0, 7.0, 8.0, 8.5), 1.0.6 (CTM Version9.0)

Reference GuideJanuary 15, 2010

SC23-6033-02

����

Page 4: Cisco Ctm Corba-PDF

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

Edition notice

This edition applies to 3.0.5 (CTM Versions 6.0, 7.0, 8.0, 8.5) and 1.0.6 (CTM Version 9.0) of Probe for Cisco CTM(CORBA) (SC23-6033-02) and to all subsequent releases and modifications until otherwise indicated in new editions.

This edition replaces SC23-6033-01.

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

Page 5: Cisco Ctm Corba-PDF

Contents

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

IBM Tivoli Netcool/OMNIbus Probe forCisco CTM (CORBA) . . . . . . . . . 1Summary . . . . . . . . . . . . . . . 1Installing the probe on Tivoli Netcool/OMNIbusV7.1.0, 7.2.0, and 7.2.1 . . . . . . . . . . . 2

Installing the probe . . . . . . . . . . . 2Installing the probe on Tivoli Netcool/OMNIbusV7.3.0 or later . . . . . . . . . . . . . . 3

Installing the probe . . . . . . . . . . . 3Configuring the probe . . . . . . . . . . . 4Data acquisition . . . . . . . . . . . . . 4

Connecting to the CORBA interface. . . . . . 5Retrieving alarms . . . . . . . . . . . . 5

Status checking . . . . . . . . . . . . 5Timeout . . . . . . . . . . . . . . . 5Backoff strategy . . . . . . . . . . . . 5Peer-to-peer failover functionality . . . . . . 6Command line interface . . . . . . . . . 6

Properties and command line options . . . . . . 7Elements . . . . . . . . . . . . . . . 12Error messages . . . . . . . . . . . . . 13ProbeWatch messages . . . . . . . . . . . 14Troubleshooting . . . . . . . . . . . . . 15

Appendix. Notices and Trademarks . . 17Notices . . . . . . . . . . . . . . . . 17Trademarks . . . . . . . . . . . . . . 19

© Copyright IBM Corp. 2006, 2010 iii

Page 6: Cisco Ctm Corba-PDF

iv IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 7: Cisco Ctm Corba-PDF

Document control page

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

The Probe for Cisco CTM (CORBA) documentation is provided in softcopy formatonly. 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 April 30, 2009 First IBM publication.

02 January 15,2010

Support for CTM version 9.0 added.

“Summary” on page 1 updated.

“Installing the probe on Tivoli Netcool/OMNIbus V7.1.0,7.2.0, and 7.2.1” on page 2 and “Installing the probe onTivoli Netcool/OMNIbus V7.3.0 or later” on page 3added to replace previous installation section.

Description for FlushBufferInterval added to “Propertiesand command line options” on page 7.

© Copyright IBM Corp. 2006, 2010 v

Page 8: Cisco Ctm Corba-PDF

vi IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 9: Cisco Ctm Corba-PDF

IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA)

The Cisco Transport Manager (CTM) system is an optical transport domainmanager. It uses open interfaces to operations support systems (OSSs) usingindustry-standard protocols. The Probe for Cisco CTM (CORBA) acquires datafrom the Cisco Transport Manager (CTM) system using a Common Object RequestBroker Architecture (CORBA) interface.

This guide contains the following sections:v “Summary”v “Installing the probe on Tivoli Netcool/OMNIbus V7.1.0, 7.2.0, and 7.2.1” on

page 2v “Installing the probe on Tivoli Netcool/OMNIbus V7.3.0 or later” on page 3v “Data acquisition” on page 4v “Properties and command line options” on page 7v “Elements” on page 12v “Error messages” on page 13v “Troubleshooting” on page 15

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

The following table provides a summary of the Probe for Cisco CTM (CORBA).

Table 2. Summary

Probe target Cisco CTM (CORBA) Versions 6.0, 7.0, 8.0, 8.5, and 9.0

Probe executable name nco_p_cisco_ctm_corba (CTM Versions 6.0, 7.0, 8.0, or8.5)

nco_p_cisco_ctm_corba_v9 (CTM Version 9.0)

Patch number 3.0 (CTM Versions 6.0, 7.0, 8.0, 8.5)

1.0 (CTM Version 9.0)

Probe supported on Solaris, HP-UX PA-RISC

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

Properties file $OMNIHOME/probes/arch/cisco_ctm_corba.props (CTMVersions 6.0, 7.0, 8.0, 8.5)

$OMNIHOME/probes/arch/cisco_ctm_corba_v9 (CTMVersion 9.0)

© Copyright IBM Corp. 2006, 2010 1

Page 10: Cisco Ctm Corba-PDF

Table 2. Summary (continued)

Rules file $OMNIHOME/probes/arch/cisco_ctm_corba.rules (CTMVersions 6.0, 7.0, 8.0, 8.5)

$OMNIHOME/probes/arch/cisco_ctm_corba_v9.rules(CTM Version 9.0)

Requirements A currently supported version of IBM TivoliNetcool/OMNIbus.

probe-nonnative-base-7

probe-visibroker-support

Note: The VisiBroker patch is not available on the IBMTivoli Information Center; to obtain this patch, youmust contact the IBM Technical Support.

JDK 1.5

To run the probe with Cisco CTM Version 8.5, youmust install the 8.5.0.359.1 patch which is availablefrom the Cisco support web site.

Connection method CORBA

Remote connectivity Available

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

Internationalization Not available

Peer-to-peer failover functionality Available

IP environment IPv4 and IPv6Note: The probe is supported on IPv6 when runningon IBM Tivoli Netcool/OMNIbus V7.1.0, 7.2.0, 7.2.1,and 7.3.0 on Solaris, and on IBM TivoliNetcool/OMNIbus V7.2.0, 7.2.1, and 7.3.0 on all otherUNIX plaftorms.

Federal Information ProtocolStandards (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 web site 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 the probe on Tivoli Netcool/OMNIbus V7.1.0, 7.2.0, and 7.2.1The process of installing probes on Tivoli Netcool/OMNIbus V7.1.0, 7.2.0, and 7.2.1consists of downloading the appropriate installation package, and installing each ofthe patches that the package contains.

Installing the probe

To install the probe and each of its required patches, use the following steps:

2 IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 11: Cisco Ctm Corba-PDF

1. Make a backup of any existing configuration files that you might already havefor an earlier version of the probe and that you want to retain.

2. Download the UNIX or Linux installation package for the probe from thePassport Advantage Online Web site:http://www-306.ibm.com/software/howtobuy/passportadvantage/pao_customers.htm

3. Extract the contents of the package to a temporary location.4. Navigate to the patches directory under the directory containing the

README.txt file in the extracted package.This directory contains the main patches for the probe.

5. Consult the README.txt file to ascertain whether you will need to downloadany further patches from the Passport Advantage Online Web site.

6. Install each of the patches in the patches directory, and any additional requiredpatches, in the order shown in the README.txt file by running the followingcommand:$NCHOME/omnibus/install/nco_patch -install patch_path

Where patch_path is the path of the required patch.

Note: At any stage, you can see which patches are already installed by runningthe following command:$NCHOME/omnibus/install/nco_patch -print=id

Installing the probe on Tivoli Netcool/OMNIbus V7.3.0 or laterWith the introduction of Tivoli Netcool/OMNIbus V7.3.0, all probes are installedusing the Tivoli Netcool/OMNIbus installer. You can install the probe using theinstallation wizard, using a text-based installer (console mode), or using settingspredefined in a text file (silent mode).

Installing the probe

To install the probe, use the following steps:1. Make a backup of any existing configuration files that you might already have

for an earlier version of the probe and that you want to retain.2. Download the UNIX or Linux installation package for the probe from the

Passport Advantage Online Web site:http://www-306.ibm.com/software/howtobuy/passportadvantage/pao_customers.htm

3. Extract the contents of the package to a temporary location. The packagecontains the probe itself and all non-third party dependencies.

4. If you want to install the probe using the installation wizard, use the followingsteps:a. Run the following command:

$NCHOME/omnibus/install/nco_install_integration

b. When the wizard runs, specify the location of the probe to be installed. Thislocation is the directory containing the README.txt file in the extractedpackage.

c. Accept the license conditions.If you want to install the probe in console mode, use the following steps:a. Run the following command:

IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA) 3

Page 12: Cisco Ctm Corba-PDF

$NCHOME/omnibus/install/nco_install_integration -i console

b. When the text-based installer runs, specify the location of the probe to beinstalled. This location is the directory containing the README.txt file in theextracted package.

c. Accept the license conditions.If you want to install the probe in silent mode, use the following steps:a. Create a text file named reponse.txt that contains the following settings:

PROBE_OR_GATE_LOCATION=README_directorypathLICENSE_ACCEPTED=true

Where README_directorypath is the path to the directory containing theREADME.txt file in the extracted package.

b. Run the following command:$NCHOME/omnibus/install/nco_install_integration -i silent -fresponse_path/response.txt

Where response_path is the full path to the response.txt file.

In each case, the probe is installed in the following directory:

$NCHOME/omnibus/probes

Configuring the probeAfter installing the probe, you need to make various configuration settings to suityour environment.

Setting environment variables

You must include the following path in the $PATH environment variable:

jre_directory/bin

where jre_directory is the installation directory of the Java Runtime Environment(JRE).

Note: This must be the first path set in the $PATH environment variable.

Data acquisitionThe Probe for Cisco CTM (CORBA) gathers events from the Cisco CTM using aCommon Object Request Broker Architecture (CORBA) interface. CORBA is anObject Management Group specification that provides a standard interfacedefinition between objects in a distributed environment; that is, it allowsapplications to communicate with one another regardless of where they are locatedor who has designed them.

Data acquisition is described in the following topics:v “Connecting to the CORBA interface” on page 5v “Retrieving alarms” on page 5v “Status checking” on page 5v “Timeout” on page 5v “Backoff strategy” on page 5v “Peer-to-peer failover functionality” on page 6

4 IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 13: Cisco Ctm Corba-PDF

v “Command line interface” on page 6

Connecting to the CORBA interfaceThere are two methods that the probe can use to connect to Cisco CTM: using anInteroperable Object Reference (IOR) file or using the Naming Service.

Using IOR files

If using IOR files, the probe gets the object reference of the EmsSessionFactory_Iobject from the Interoperable Object Reference (IOR) file specified by the IORFileproperty.

Using a Naming Service

If the IORFile property is not specified, the probe gets the object reference of theEmsSessionFactory_I object from the Naming Service. To locate the NamingService, the probe either uses the ORBInitialHost and ORBInitialPort propertiesto identify the host name and port number of the Naming Service, or uses the IORfile specified by the NamingContextIORFile property.

The Naming Service uses the value specified by the NamingContextPath to locatethe EmsSessionFactory_I object.

Retrieving alarmsIf the Resynch property is set to true, the probe initially receives a list of all activealarms from the server in the order of their severity. The probe then connects tothe Notification service and uses the CORBA notification push model to receivenew alarms from the server as they are generated. If the Resynch property is set tofalse, the probe only receives new alarms.

Status checkingThe probe checks that the Cisco CTM server is running by sending a pingcommand every 60 seconds. You can change this frequency using theAgentHeartbeat property.

TimeoutThe Probe for Cisco CTM (CORBA) has a timeout facility that allows it todisconnect from the system if there has been no activity for a predefined amountof time.

You can specify how long the probe waits before disconnecting using the Timeoutproperty. If you set the Timeout property to 0, the probe never disconnects fromthe system.

Backoff strategyIf the Retry property is set to true and the probe fails to establish a connection orloses an existing connection to the device, it reverts to a backoff strategy. The probewill try to reestablish a connection after one second, two seconds, then fourseconds, and so on, up to a maximum of 4096 seconds. Once the connection ismade to the CORBA interface, the probe tries to log in to the device. If the probefails to log in, it shuts down and tries to connect again. The backoff strategyremains in place until a successful login occurs.

IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA) 5

Page 14: Cisco Ctm Corba-PDF

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 probes]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 probes]Mode : "slave"

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

Command line interfaceThe Probe for Cisco CTM (CORBA) is supplied with a command line interface(CLI). This interface allows you to perform commands using the probe (forexample, to request a full resynchronization of the CORBA interface).

To use the CLI, you must use the CommandPort property in the properties file tospecify a port through which commands will be sent. When you want to performcommands, telnet to this port.

The following table describes the commands that you can use with the commandline interface.

Table 3. CLI commands

Command Description

help This command displays online help about theCLI.

6 IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 15: Cisco Ctm Corba-PDF

Table 3. CLI commands (continued)

Command Description

nelookup This command instructs the probe to build themanaged element lookup table.

resynch_all This command allows you to perform a fullresynchronization with the Cisco CTM server.

version This command displays the version of the 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 4. Properties and command line options

Property name Command line option Description

AgentHeartBeat integer -agentheartbeat integer Use this property to specify thefrequency (in seconds) with whichthe probe sends a ping commandto check that Cisco CTM is stillrunning.

The default is 60.

CommandPort integer -commandport integer Use this property to specify theport to which users can Telnet tocommunicate with Cisco CTMusing the command line interface(CLI) supplied with the probe.

For details about the CLI, see“Command line interface” on page6.

The default is 6970.

CommandPortLimitinteger

-commandportlimit integer Use this property to specify themaximum number of Telnetconnections that can be made tothe probe.

The default is 10.

EncodingStandard string -encodingstandard string Use this property to specify thestandard used to encode anddecode multi-byte characters.

The default is ISO-8859-1.

IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA) 7

Page 16: Cisco Ctm Corba-PDF

Table 4. Properties and command line options (continued)

Property name Command line option Description

ExcludeSeverityClearedstring

-excludeseverityclearedstring

Use this property to specifywhether the probe excludes alarmsof severity Cleared from those thatit retrieves. This property takesthe following values:

false: The probe does not excludealarms of severity Cleared.

true: The probe excludes alarms ofseverity Cleared.

The default is false.

ExcludeSeverityCriticalstring

-excludeseveritycriticalstring

Use this property to specifywhether the probe excludes alarmsof severity Critical from thosethat it retrieves. This propertytakes the following values:

false: The probe does not excludealarms of severity Critical.

true: The probe excludes alarms ofseverity Critical.

The default is false.

ExcludeSeverityIndeterminate string

-excludeseverityindeterminate string

Use this property to specifywhether the probe excludes alarmsof severity Indeterminate fromthose that it retrieves. Thisproperty takes the followingvalues:

false: The probe does not excludealarms of severity Indeterminate.

true: The probe excludes alarms ofseverity Indeterminate.

The default is false.

ExcludeSeverityMajorstring

-excludeseveritymajorstring

Use this property to specifywhether the probe excludes alarmsof severity Major from those that itretrieves. This property takes thefollowing values:

false: The probe does not excludealarms of severity Major.

true: The probe excludes alarms ofseverity Major.

The default is false.

8 IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 17: Cisco Ctm Corba-PDF

Table 4. Properties and command line options (continued)

Property name Command line option Description

ExcludeSeverityMinorstring

-excludeseverityminorstring

Use this property to specifywhether the probe excludes alarmsof severity Minor from those that itretrieves. This property takes thefollowing values:

false: The probe does not excludealarms of severity Minor.

true: The probe excludes alarms ofseverity Minor.

The default is false.

ExcludeSeverityWarningstring

-excludeseveritywarningstring

Use this property to specifywhether the probe excludes alarmsof severity Warning from those thatit retrieves. This property takesthe following values:

false: The probe does not excludealarms of severity Warning.

true: The probe excludes alarms ofseverity Warning.

The default is false.

FlushBufferIntervalinteger

-flushbufferinterval integer Use this property to specify howoften (in seconds) the probeflushes all alerts in the buffer tothe ObjectServer.

The default is 0 (which instructsthe probe to never flush the alertsto the ObjectServer).

Note: The FlushBufferIntervalproperty is only supported on theCTM 9.0 version of the probe.

GetPublicKey integer -getpublickey integer Use this property to specifywhether the probe retrieves thelatest public key from the CiscoCTM server for credentialencryption. This property takesthe following values:

0: The probe does not retrieve apublic key.

1: The probe retrieves a public key.

The default is 0.

Note: The public key is a stringthat the probe uses to encrypt theusername and password needed toconnect to Cisco CTM. The serveralso uses this string to decryptthese data.

IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA) 9

|||

Page 18: Cisco Ctm Corba-PDF

Table 4. Properties and command line options (continued)

Property name Command line option Description

IORFile string -iorfile string Use this property to specify thepath of the Inter-operable ObjectReference (IOR) file.

The default is "".

NamingContextIORFilestring

-nsior string Use this property to specify thelocation of the IOR file thatcontains the root context of thenaming service.

The default is "".

NamingContextPath string -nspath string Use this property to specify thelocation of the interface objectwithin the naming service.

The default is "".

NELookup integer -nelookup integer Use this property to specifywhether the probe builds themanaged element lookup table atstartup. This property takes thefollowing properties:

0: The probe does not build thelookup table at startup.

1: The probe builds the lookuptable at startup.

Note: You can use the commandline interface to instruct the probeto build the lookup file when theprobe is already running; fordetails of the nelookup command,see “Command line interface” onpage 6.

The default is 0.

NELookupLocation string -nelookuplocation string Use this property to specify thelocation of the lookup table thatthe probe builds at startup if theNELookup property is set to 1.

The default is$OMNIHOME/probes/includes/ManElement.lookup.

NEBatchSize integer -nebatchsize integer Use this property to specify themaximum size of the array thatthe probe receives whenperforming a lookup on allManagedElement objects.

The default is 100.

ORBInitialHost string -orbinitialhost string Use this property to specify thename of the naming service host.

The default is "".

10 IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 19: Cisco Ctm Corba-PDF

Table 4. Properties and command line options (continued)

Property name Command line option Description

ORBInitialPort integer -orbinitialport integer Use this property to specify theport number of the namingservice.

The default is 1570.

Password string -password string Use this property to specify thepassword required with theUsername property to log in tothe system.

The default is "".

ReactOnStateChangeinteger

-reactonstatechange integer Use this property to specifywhether the probe reacts when aStateChange alarm is received.When set to 1, the probe renewsthe NE lookup file and performsresynchronization.

The default is 0.

Resynch string -noresynch (equivalent toResynch with a value offalse)

-resynch (equivalent toResynch with a value oftrue)

Use this property to specifywhether the probe requests allactive alarms from the serverbefore acquiring new alarms. Thisproperty takes the followingvalues:

false: The probe does not performresynchronization.

true: The probe performsresynchronization.

The default is false.

ResynchBatchSize integer -resynchbatchsize integer Use this property to specify themaximum number of alarms thatthe probe retrieves in each batchof resynchronization alarms.

The default is 100.

IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA) 11

Page 20: Cisco Ctm Corba-PDF

Table 4. Properties and command line options (continued)

Property name Command line option Description

Retry string -noretry (equivalent toRetry with a value offalse)

-retry (equivalent to Retrywith a value of true)

Use this property to specifywhether the probe attempts toreconnect to the system using thebackoff strategy following areported error. This property takesthe following values:

false: The probe shuts down anddoes not attempt to reconnect.

true: The probe attempts toreconnect to the system using thebackoff strategy.

Note: For details about thebackoff strategy, see “Backoffstrategy” on page 5.

The default is false.

Timeout integer -timeout integer Use this property to specify thetime (in seconds) that the probewaits to receive events beforedisconnecting from the CORBAnaming service and shuttingdown.

The default is 0 (the probe nevertimes out).

Username string -username string Use this property to specify theusername of the account withwhich the probe logs on to CiscoCTM.

The default is "".

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 Cisco CTM (CORBA)generates. 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

$additionalInfo This element provides additional informationabout the alarm.

$additionalText This element contains the brief description of theproblem being reported by the alarm.

$affectedTPList This element indicates whether the list oftermination points affected by the problem arereported by the alarm.

12 IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 21: Cisco Ctm Corba-PDF

Table 5. Elements (continued)

Element name Element description

$domain_name This element shows the domain name of theevent.

$emsTime This element displays the time at which thealarm was reported by the EMS.

$event_type This element indicates the type of the alarm.Possible values are:

v communicationsAlarm

v environmentalAlarm

v equipmentAlarm

v processingErrorAlarm

v qualityofServiceAlarm

$event_name This element shows the name of the event.

$isClearable This element indicates whether the alarm can becleared. Possible values are:

v false

v true

$layerRate This element identifies the layer to which thealarm applies.

$nativeEMSName This element shows the name of the objectreporting the alarm as given in the EMS userinterface.

$nativeProbableCause This element indicates the probable cause asgiven in the EMS user interface.

$neTime This element shows the time at which the erroroccurred in the network element.

$notificationId This element contains the unique identifier of thealarm. This is derived from the serial number ofthe alarm as used by the EMS.

$objectName This element shows the name of the objectreporting the alarm.

$objectType This element shows the type of object reportingthe alarm.

$perceivedSeverity This element indicates the perceived severity ofthe alarm.

$probableCause This element identifies the probable cause of thealarm.

$probableCauseQualifier This element contains the qualifier used toclassify the alarm type.

$serviceAffecting This element indicates whether the alarm hasaffected the 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.

IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA) 13

Page 22: Cisco Ctm Corba-PDF

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 6. Error messages

Error Description Action

Failed to connect toNaming Service

The CORBA service is notrunning on the expectedHost/Port/IOR

The probe failed to connect tothe naming service. Either thenaming service was notrunning on the specified hostand port, or the IOR specifiedfor the naming service wasnot correct.

Check that the naming serviceis running on the specifiedhost and port and that thenaming service IOR is correct.

Failed to get interfaceversion information

Failed to ping Ciscoserver

The probe failed to call amethod on Cisco CTM.

Check that Cisco CTM isrunning correctly and that theIOR files are up to date.

Failed to get objectreference from IOR file

Failed to get object fromIOR file

Failed to find file,please check file exists!

Failed to convert IOR toobject

Please check that theinterface is running andthe probe is using up todate IOR files

The probe failed to get theobject reference from the IORfile. Either the IOR filerequested was not found or itdid not contain a valid IORfile.

Check that the IOR file existsand that it is a valid IOR file.

Failed to narrow objectreference

Failed to narrow managerreference

The probe failed to narrowthe object reference to theinterface object.

This is a CORBA related errorand is probably related to theCORBA installation.

Failed to resolve NamingContext

Exception raised whenlocating server

The probe failed to resolvethe naming context path tofind the server object. Eitherthe naming context path wasinvalid or did not exist.

Check the NamingContextPath property.

Name is null, cannotcreate element

Cannot parsetypevalue_type : name

Failed to parse alarm

The probe failed to parse thealarm.

Check that the alarmconforms to theStructuredEvent format.

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

14 IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 23: Cisco Ctm Corba-PDF

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 7. ProbeWatch messages

ProbeWatch message Description Triggers/causes

ProbeWatch Message Description of what theProbeWatch message isreporting.

Explanation of what causesthe ProbeWatch message.

TroubleshootingVarious issues arise as users work with the probe. Troubleshooting information isprovided to help you diagnose and resolve such issues.

Making the probe deliver time tokens in a known format insteadof an unknown format

Due to the changed time zone, the probe may deliver the alerts with an unknowntime format. This can be changed by modifying the file(nco_p_cisco_ctm_corba.rules or cisco_ctm_corba_v9.rules if you are using CTMVersion 9.0). As a work-around, you can update the datetotime function in therules file, and perform a conversion on time tokens. This will allow you to convertthe time tokens generated by the probe to UNIX time.

For example, suppose $neTime is the time at which an error occurs in a networkelement; to convert $neTime to UNIX time, include the following code in the rulesfiles:$UNIXDateTime = datetotime($neTime, "%Y%m%d%H%M%S")

@FirstOccurrence = $UNIXDateTime@LastOccurrence = $UNIXDateTime

IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA) 15

Page 24: Cisco Ctm Corba-PDF

16 IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 25: Cisco Ctm Corba-PDF

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, 2010 17

Page 26: Cisco Ctm Corba-PDF

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.

18 IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 27: Cisco Ctm Corba-PDF

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 19

Page 28: Cisco Ctm Corba-PDF

20 IBM Tivoli Netcool/OMNIbus Probe for Cisco CTM (CORBA): Reference Guide

Page 29: Cisco Ctm Corba-PDF
Page 30: Cisco Ctm Corba-PDF

����

Printed in USA

SC23-6033-02