Properties and command line options

You use properties to specify how the probe interacts with the device. You can override the default values by using the properties file or the command line options.

The following table describes the properties and command line options specific to this probe. For information about default properties and command line options, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide (SC14-7608).

Table 1. Properties and command line options

Property name

Command line option

Description

AgentHeartBeat integer

-agentheartbeat integer

Use this property to specify the frequency (in seconds) with which the probe sends a ping command to check that CTM is still running.

The default is 60.

CommandPort integer

-commandport integer

Use this property to specify the port through which users can use Telnet to communicate with CTM using the CLI supplied with the probe.

The default is 6970.

For more information about the CLI, see Command line interface.

CommandPortLimit integer

-commandportlimit integer

Use this property to specify the maximum number of Telnet connections that can be made to the probe.

The default is 10.

EncodingStandard string

-encodingstandard string

Use this property to specify the standard used to encode and decode multibyte characters.

The default is ISO-8859-1.

ExcludeSeverityCleared string

-excludeseveritycleared string

Use this property to specify whether or not the probe excludes alarms of severity Cleared from those that it retrieves. This property takes the following values:

false: The probe does not exclude alarms of severity Cleared.

true: The probe excludes alarms of severity Cleared.

The default is false.

ExcludeSeverityCritical string

-excludeseveritycritical string

Use this property to specify whether or not the probe excludes alarms of severity Critical from those that it retrieves. This property takes the following values:

false: The probe does not exclude alarms of severity Critical.

true: The probe excludes alarms of severity Critical.

The default is false.

ExcludeSeverity Indeterminate string

-excludeseverity indeterminate string

Use this property to specify whether or not the probe excludes alarms of severity Indeterminate from those that it retrieves. This property takes the following values:

false: The probe does not exclude alarms of severity Indeterminate.

true: The probe excludes alarms of severity Indeterminate.

The default is false.

ExcludeSeverityMajor string

-excludeseveritymajor string

Use this property to specify whether or not the probe excludes alarms of severity Major from those that it retrieves. This property takes the following values:

false: The probe does not exclude alarms of severity Major.

true: The probe excludes alarms of severity Major.

The default is false.

ExcludeSeverityMinor string

-excludeseverityminor string

Use this property to specify whether or not the probe excludes alarms of severity Minor from those that it retrieves. This property takes the following values:

false: The probe does not exclude alarms of severity Minor.

true: The probe excludes alarms of severity Minor.

The default is false.

ExcludeSeverityWarning string

-excludeseveritywarning string

Use this property to specify whether or not the probe excludes alarms of severity Warning from those that it retrieves. This property takes the following values:

false: The probe does not exclude alarms of severity Warning.

true: The probe excludes alarms of severity Warning.

The default is false.

FlushBufferInterval integer

-flushbufferinterval integer

Use this property to specify how often (in seconds) the probe flushes all alerts in the buffer to the ObjectServer.

The default is 0 (which instructs the probe to never flush the alerts to the ObjectServer).

GetPublicKey string

-getpublickey string

Use this property to specify whether or not the probe retrieves the latest public encryption key from the CTM server. This property takes the following values:

0: The probe does not retrieve a public key.

1: The probe retrieves a public key.

The default is 0.

Note: The public key is a string that the probe uses to encrypt the user name and password required to connect to CTM.

IORFile string

-iorfile string

Use this property to specify the location of the IOR file.

The default is "".

NamingContextIORFile string

-nsior string

Use this property to specify the location of the IOR file that contains the root context of the Naming Service.

The default is "".

NamingContextPath string

-nspath string

Use this property to specify the location of the EmsSessionFactory_I interface object within the Naming Service.

The default is "".

NELookup integer

-nelookup integer

Use this property to specify whether or not the probe builds the managed element lookup table at startup. This property takes the following values:

0: The probe does not build the lookup table at startup.

1: The probe builds the lookup table at startup.

The default is 0.

Note: You can use the CLI to instruct the probe to build the lookup file when the probe is already running. For more information, see Command line interface.

NELookupLocation string

-nelookuplocation string

Use this property to specify the location of the lookup table that the probe builds at startup (if the NELookup property is set to 1).

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

NEBatchSize integer

-nebatchsize integer

Use this property to specify the maximum size of the array that the probe receives when performing a lookup on all managed element objects.

The default is 100.

ORBInitialHost string

-orbinitialhost string

Use this property to specify the name of the Naming Service host.

The default is "".

ORBInitialPort integer

-orbinitialport integer

Use this property to specify the port number through which to connect to the Naming Service host.

The default is 1570.

ORBCharEncoding string

-orbcharencoding string

Use this property to specify the native character encoding set that the Object Request Broker (ORB) uses for character data. Possible values for this property are:

  • ISO8859_1
  • UTF8

The default is: UTF8.

ORBLocalHost string

-orblocalhost string

Use this property to specify the local host used by the server-side ORB to place the server's host name or IP address into the IOR of a remote object.

The default is: "".

ORBLocalPort integer

-orblocalport integer

Use this property to specify the local port that the ORB listens on for connections from the probe.

The default is: 0 (the ORB selects a port at random).

ORBWCharDefault string

-orbwchardefault string

Use this property to specify the wide character (wchar) set that the IBM® ORB uses when communicating with other ORBs that do not publish a wchar set. Possible values for this property are:

  • UCS2
  • UTF16

The default is: UTF16.

Password string

-password string

Use this property to specify the password used to log in to CTM.

The default is "".

ReactOnStateChange integer

-reactonstatechange integer

Use this property to specify whether or not the probe reacts when a StateChange alarm is received. This property takes the following values:

1: The probe renews the NE lookup file and performs a resynchronization.

0: The probe does not react.

The default is 0.

Resynch string

-noresynch (This is equivalent to Resynch with a value of false.)

-resynch (This is equivalent to Resynch with a value of true.)

Use this property to specify whether or not the probe requests all active alarms from CTM before acquiring new alarms. This property takes the following values:

false: The probe does not perform resynchronization.

true: The probe performs resynchronization.

The default is false.

ResynchBatchSize integer

-resynchbatchsize integer

Use this property to specify the maximum number of alarms that the probe retrieves in each batch of resynchronization alarms.

The default is 100.

Retry string

-noretry (This is equivalent to Retry with a value of false.)

-retry (This is equivalent to Retry with a value of true.)

Use this property to specify whether or not the probe attempts to reconnect to CTM following a connection error. This property takes the following values:

false: The probe shuts down and does not attempt to reconnect.

true: The probe attempts to reconnect to the system using a backoff strategy.

The default is false.

For more information about the probe's backoff strategy, see Backoff strategy.

Timeout integer

-timeout integer

Use this property to specify the time (in seconds) that the probe waits to receive a new alarm before disconnecting from CTM and shutting down.

The default is 0 (the probe never disconnects).

Username string

-username string

Use this property to specify the user name used to log in to CTM.

The default is "".