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-7530).

Table 1. Properties and command line options

Property name

Command line option

Description

ChatinString string

-chatinstring string

Use this property to specify the chat in script for connection to the host system.

The default is "".

A typical chat in script might be: ".*login.*:.*anu\r\n.*assword.*: .*anu\r\n".

ChatoutString string

-chatoutstring string

Use this property to specify the chat out script for disconnection from the host system.

The default is "".

DateStreamCapture integer

-datestreamcapture integer

Use this property to specify whether the probe appends a date and time to the stream capture filename:

0: The probe does not append the date and time to the stream capture filename.

1: The probe appends the date and time to the stream capture filename

The default is 0.

Note: Setting the DateStreamCapture property to 1 prevents the stream capture file from being overwritten.

ExpectTimeout integer

-expecttimeout integer

Use this property to specify the time (in seconds) the probe allows for a response to the expect part of the chat in/out script.

The default is 20.

FlushTime integer

-flushtime integer

Use this property to specify the time (in seconds) the probe waits to receive the event terminator before sending the event to the ObjectServer.

The default is 0.

Note: If this property is set to 0, the probe only sends events to the ObjectServer on receipt of an event terminator.

Host string

-host string

Use this property to specify the name of the host to which the probe connects.

The default is localhost.

Inactivity integer

-inactivity integer

Use this property to specify the time (in seconds) the probe allows a port to be inactive before sending the inactivity related ProbeWatch message.

The default is 0 (probe does not disconnect if the port becomes inactive).

InactivityRetry integer

-inactivityretry integer

Use this property to specify the number of consecutive periods of inactivity the probe allows before attempting to reconnect to the host.

The default is 0 (this feature is disabled).

MaxStreamCapFileSize integer

-maxstreamcapfilesize integer

Use this property to specify the maximum size (in bytes) of the stream capture file. When this limit is reached, the probe creates a new file.

The default is 0.

Note: If the probe reads a stream whose size exceeds the remaining allowable space in the file, it creates a new one, thus storing the whole stream in a single file.

Port integer

-port integer

Use this property to specify the port to which the probe connects.

The default is 8765.

ReadTimeout integer

-readtimeout integer

Use this property to specify the time (in milliseconds) the probe waits to read an alarm data before timing out.

The default is 70000.

Note: The value set for the ReadTimeout property (in milliseconds) divided by 1000 should be less then the value set for Inactivity property (in seconds).

ReconnectionAttempts integer

-reconnectionattempts integer

Use this property to specify the maximum number of times that the probe attempts to reconnect to the socket.

The default is 0 (probe makes unlimited attempts to reconnect to the socket).

ReconnectionInterval integer

--reconnectioninterval integer

Use this property to specify the ime (in seconds) between successive reconnection attempts.

The default is 0 (probe uses standard backoff strategy).

StreamCaptureFile string

-streamcapturefile string

Use this property to specify the file the probe uses to store the input data stream.

The default is "".

Note: Leaving this property blank disables the stream capture function. When you no longer require data for debugging, you should disable the stream capture function.

TimeFormat string

-timeformat string

Use this property to specify the format used for the time stamp.

The default is %Y-%m-%d %H:%M:%S.