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 more information about generic Netcool/OMNIbus properties and command line options, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 1. Properties and command line options

Property name

Command line option

Description

CommandPort integer

-commandport integer

This property is no longer supported.

CommandPortLimit integer

-commandportlimit integer

This property is no longer supported.

EventExtraction string

-eventextraction string

Use this property to specify which method the probe uses to extract details of the events attached to an alarm. This property takes the following values:

AM: The probe makes an additional call to Archive Manager (AM) to retrieve details of one or more events that raised the alarm.

OE: The probe extracts from the alarm details of the originating event that raised the alarm from the Originating Event (OE) byte stream, and so does not make an additional call to Archive Manager.

The default is AM.

Note: When the probe is connected to the secondary SpectroSERVER, it will always use the OE method to extract details of events attached to an alarm regardless of setting of the EventExtraction property.

EventRetryCount integer

-eventretrycount integer

Use this property to specify how many times the probe attempts to extract from the Archive Manager the event details associated with an alarm event before moving on to the next alarm.

The maximum that you can set this property to is 5. If you set this property to 0, the probe will not retry the event details extraction.

The default is 3.

Note: If you set this property to a value other than between 0 and 5, the probe will use the default value of 3.

EventRetryTimeout integer

-eventretrytimeout integer

Use this property to specify the time (in seconds) that probe waits to receive from the Archive Manager the event details associated with an alarm. If this time is exceeded, the probe retries the event extraction request. The number of times that the probe retries the event extraction is specified by the EventRetry property.

The maximum that you can set this property to is 5 seconds. If you set this property to 0, the probe will not timeout while waiting for the event details.

The default is 3.

Note: If you set this property to a value other than between 0 and 5, the probe will use the default value of 3.

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 (the probe does not flush alerts to the ObjectServer).

HeartbeatInterval integer

-heartbeatinterval integer

Use this property to specify the frequency (in seconds) with which the probe checks the status of each connection for the targeted Spectrum server.

The default is 0.

HostFile string

-hostfile string

Use this property to specify the location of the host configuration file ca_spectrum_corba_host.xml.

The default is "".

Inactivity integer

-inactivity integer

Use this property to specify the length of time (in seconds) that the probe allows the port to receive no incoming data before disconnecting.

The default is 0 (which instructs the probe to not disconnect during periods of inactivity).

InitialResync integer

-initialresync string

Use this property to specify whether the probe retrieves all active alarms when it connects or only those that have been created since the last connection. This property takes the following values:

false: The probe only retrieves alarms generated since the last connection.

true: The probe retrieves all active alarms; no alarm filter is applied by the probe.

The default is false.

MaxSpectrumSeverity integer

-maxspectrumseverity integer

Use this property to specify the maximum severity level above which the probe will not retrieve alarms.

The default is 6 (CA Spectrum severity Initial).

MinSpectrumSeverity integer

-minspectrumseverity integer

Use this property to specify the minimum severity level below which the probe will not retrieve alarms.

The default is 0 (CA Spectrum severity Normal).

ORBLocalHost string

-orblocalhost string

Use this property to specify the local host name or IP address 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 string

-orblocalport string

Use this property to specify the local port to which the Object Request Broker (ORB) listens for connections from the probe.

The default is 0 (the ORB selects an available port at random).

OSHost string

-oshost string

Use this property to specify the host name of the ObjectServer to which the probe connects during resynchronization operations.

The default is localhost.

OSPassword string

-ospassword string

Use this property to specify the password of the ObjectServer to which the probe connects during resynchronization operations.

The default is "".

Use the nco_g_crypt utility supplied with Netcool/OMNIbus to encrypt the password. . For information about using this utility, see the IBM Tivoli Netcool/OMNIbus Administration Guide.

OSPort integer

-osport integer

Use this property to specify the port number of the ObjectServer to which the probe connects during resynchronization operations.

The default is 4100.

OSUserName string

-osusername string

Use this property to specify the user name used to connect to the ObjectServer during resynchronization operations.

The default is root.

ResyncInterval integer

-resyncinterval string

This property sets a global ResyncInterval value for the entire probe. It is found in the ca_spectrum_corba.props file.

Any probe's target connection that does not have ResyncInterval configured in the probe's host properties file (ca_spectrum_corba_host.xml) will refer to this value.

The default value is 0.

Note: Use for multiple target environment where some target connections will have the same ResyncInterval value, while other subsets from it would not.

In the event both ResyncInterval properties are configured, the ResyncInterval property from ca_spectrum_corba_host.xml always takes precedence over the ResyncInterval property from ca_spectrum_corba.props.

ResyncOnFailover integer

-resynconfailover string

Use this property to specify whether the probe performs a resynchronization during the SpectroSERVER failover process. This property takes the following values:

true: The probe performs a resynchronization.

false: The probe does not perform a resynchronization.

The default is false.

ResyncPrimaryOnly integer

-resyncprimaryonly string

Use this property to make the probe resynchronize with the primary SpectroSERVER only during the SpectroSERVER failover process. This property takes the following values:

true: The probe performs a resynchronization with the primary SpectroSERVER only.

false: The probe resynchronizes with either SpectroSERVER.

The default is false.

ResyncThreadMax integer

-resyncthreadmax integer

Use this property to specify the maximum number of threads that the probe spawns to perform a resynchronization.

If you set this property to a value of 0 the probe uses an unlimited number of threads.

The default is 5.

RetryCount integer

-retrycount integer

RetryCount is the number of attempts the probe as a whole will attempt to reestablish all connections to the SpectroSERVER.

The default is 0.

RetryInterval integer

-retryinterval integer

Use this property to define the length of retry interval (in seconds) for reconnecting to the SpectroSERVER after being disconnected.

The default is 30.

SpectroServer PollInterval integer

-spectroserver pollinterval integer

Use this property to specify the interval (in seconds) at which the probe polls the CORBA services to check their availability.

The default is 20 seconds.

SpectrumRetry string

-spectrumretry string

Use this property to specify whether the probe attempts to reconnect to a SpectroSERVER after losing the connection.

This property takes the following values:

true: The probe's connection waits for connection to reestablish with the SpectroSERVER.

false: The probe does not wait for connection to reestablish with SpectroSERVER.

The default is true.

For more information about using SpectrumRetry scenarios see Backoff strategy.