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
ChatinString `string`	-chatinstring `string`	Use this property to specify the chatin string for connecting to the target system. The default is "".
ChatoutString `string`	-chatoutstring `string`	Use this property to specify the chatout string for disconnecting from the target system. The default is "".
DateStreamCapture `integer`	-datestreamcapture `integer`	Use this property to specify whether the probe appends the current date and time to the name of the data stream capture file. This property takes the following values: 0: The probe does not append the date and time to the file name. 1: The probe appends the date and time to the file name. The default is 0. For more information, see Data stream capture.
ExpectTimeout `integer`	-expecttimeout `integer`	Use this property to specify the time (in seconds) that the probe waits for an expected string when logging in or logging out. The default is 20.
FlushTime `integer`	-flushtime `integer`	Use this property to specify the time (in seconds) that the probe waits before flushing an event to the ObjectServer. The default is 5.
Host `string`	-host `string`	Use this property to specify the DNS name of the host to which the probe connects. The default is localhost.
HostsFile `string`	-hostsfile `string`	Use this property to specify the name and location of the hosts file. The default is "".
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.
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.
InvalidAlarmLogFile `string`	-invalidlog `string`	Use this property to specify the file to which the probe logs invalid alarms. The current date and time is appended to the file name. The default is $OMNIHOME/var/eaglestp.invalid.
InvalidAlarmLogging `integer`	-invalidalarmlogging `integer`	Use this property to specify whether 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 read simultaneously from a device. The default is 1. Note: When a large number of events is being generated by the device, you can increase this number to increase event throughput.
MaxInvalidAlarmLog FileSize `integer`	-maxinvalidlog `integer`	Use this property to specify the maximum size (in bytes) of the invalid alarm log file. When this limit is reached, the probe creates a new file and appends the current date and time to the file name. The default is 1048576.
MaxStreamCapFileSize `integer`	-maxstreamcapfilesize `integer`	Use this property to specify the maximum size (in bytes) of the data stream capture file. When this limit is reached, the probe creates a new file. The default is 0.
Port `integer`	-port `integer`	Use this property to specify the port to which the probe connects. The default is 23.
Props.CheckNames `boolean`	N/A	Use this property to specify whether the probe shuts down if it detects an invalid property value in the properties file. This property takes the following values: TRUE: The probe shuts down if it detects an invalid property value in the properties file. FALSE: The probe does not shut down if it detects an invalid property value. The default is TRUE.
ReadTimeout `integer`	-readtimeout `integer`	Use this property to specify the time (in milliseconds) for which the probe tries to read an alarm before timing out. The default is 100.
ReconnectionAttempts `integer`	-reconnectionattempts `integer`	Use this property to specify the maximum number of times that the probe attempts to reconnect to the device. The default is 0 (the probe makes an unlimited number of attempts to reconnect).
ReconnectionInterval `integer`	-reconnectioninterval `integer`	Use this property to specify the time interval (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 name and location of the file that the probes uses to store the raw data stream sent from the device. The default is "". For more information, see Data stream capture.