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 "".

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 or not the probe appends a date and time to the stream capture filename. This property takes the following values:

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

1: The probe appends the date and time to the stream capture file name.

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) that the probe waits for a response to the expect part of the chat in or chat out script.

The default is 20.

FlushTime integer

-flushtime integer

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

The default is 5.

Note: If this property is set to 0, the probe only sends events to the ObjectServer after it has received their 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) that the probe allows a port to be inactive before disconnecting.

The default is 0 (the 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 that the probe allows before attempting to reconnect to the host.

The default is 0 (this disables the feature).

InvalidAlarmLogFile string

-invalidalarmlogfile string

Use this property to specify the file to which the probe logs invalid alarms. The current date and time is appended to this filename.

The default is $OMNIHOME/var/5ess.invalid.

InvalidAlarmLogging integer

-invalidalarmlogging integer

Use this property to specify whether or not the probe logs invalid alarms. This property takes the following values:

0: The probe does not log invalid alarms.

1: The probe logs invalid alarms.

The default is 0.

MaxEvents integer

-maxevents integer

Use this property to specify the maximum number of events that the probe attempts to simultaneously read from a given source.

The default is 10.

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

MaxInvalidAlarmLogFileSize integer

-maxinvalidlog filesize integer

Use this property to specify the maximum size (in bytes) for the invalid alarm log file. When this limit is reached, the probe creates a new file with a new date and time.

The default is 1048576.

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 file to store the whole stream in.

Port integer

-port integer

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

The default is 23.

ReadTimeout integer

-readtimeout integer

Use this property to specify the time (in milliseconds) that the probe waits before a socket-read times out.

The default is 100 (equal to 0.1 seconds).

Note: The default value for this property is set low to maximize performance. This ensures that the probe quickly moves on to the next socket. Only increase this value if you have a slow network.

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 (the probe makes unlimited attempts to reconnect to the socket).

ReconnectionInterval integer

-reconnectioninterval integer

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

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

StreamCaptureFile string

-streamcapturefile string

Use this property to specify the file that 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.

Switch integer

-switch integer

Use this property to specify the format of the incoming event stream. This property takes the following values:

0: The event stream is in international format.

1: The event stream is in domestic format.

The default is 0.

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

WhiteSpace integer

-whitespace (This is equivalent to WhiteSpace with a value of 1; omitting this command line option is equivalent to WhiteSpace with a value of 0.)

Use this property to specify whether or not the probe removes white space when generating $AdditionalLine elements. This property takes the following values:

0: The probe deletes white space.

1: The probe does not delete white space.

The default is 0.