Properties and command line options provided by the Java Probe Integration Library (probe-sdk-java) version 4.0

All probes can be configured by a combination of generic properties and properties specific to the probe.

The following table describes the properties and command line options that are provided by the Java Probe Integration Library (probe-sdk-java) version 4.0.

Note: Some of the properties listed may not be applicable to your probe.
Table 1. Properties and command line options

Property name

Command line option

Description

CommandPort integer -commandport integer

Use this property to specify the port to which users can Telnet to communicate with the probe using the Command Line Interface (CLI) supplied.

The default is 6970.

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.

DataBackupFile string

-databackupfile string

Use this property to specify the path to the file that stores data between probe sessions.

The default is "".

Note: Specify the path relative to $OMNIHOME/var.

HeartbeatInterval integer

-heartbeatinterval integer

Use this property to specify the frequency (in seconds) with which the probe checks the status of the host server.

The default is 60.

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 string

-initialresync string

Use this property to specify whether the probe requests all active alarms from the host server on startup. This property takes the following values:

false: The probe does not request resynchronization on startup.

true: The probe requests resynchronization on startup.

For most probes, the default value for this property is false.

If you are running the JDBC Probe, the default value for the InitialResync property is true. This is because the JDBC Probe only acquires data using the resynchronization process.

MaxEventQueueSize integer

-maxeventqueue sizeinteger

Use this property to specify the maximum number of events that can be queued between the non native process and the ObjectServer.

The default is 10000.

Note: You can increase this number to increase the event throughput when a large number of events is generated.

ResyncInterval integer

-resyncinterval integer

Use this property to specify the interval (in seconds) at which the probe makes successive resynchronization requests.

For most probes, the default value for this property is 0 (which instructs the probe to not make successive resynchronization requests).

If you are running the JDBC Probe, the default value for the ResyncInterval property is 60. This is because the JDBC Probe only acquires data using the resynchronization process.

RetryCount integer

-retrycount integer

Use this property to specify how many times the probe attempts to retry a connection before shutting down.

The default is 0 (which instructs the probe to not retry the connection).

RetryInterval integer

-retryinterval integer

Use this property to specify the length of time (in seconds) that the probe waits between successive connection attempts to the target system.

The default is 0 (which instructs the probe to use an exponentially increasing period between successive connection attempts, for example, the probe will wait for 1 second, then 2 seconds, then 4 seconds, and so forth).

RotateEndpoint string

-rotateendpoint string

Use this property to specify whether the probe attempts to connect to another endpoint if the connection to the first endpoint fails.

This property takes the following values:

false: The probe does not attempt to connect to another endpoint if the connection to the first endpoint fails.

true: The probe attempts to connect to another endpoint if the connection to the first endpoint fails.

The default is false.