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
BreakCharacters `string`	-break `string`	Use this property to list the characters that are used in the FIFO to separate non-quoted tokens. The default is ,=.
CleanStart `integer`	-cleanstart (This is equivalent to CleanStart with a value of 1.) -nocleanstart (This is equivalent to CleanStart with a value of 0.)	Use this property to specify whether the probe should ignore the recovery file and start reading events from the log file or FIFO created after the probe started. This property takes the following values: 0: The probe disables clean start. 1: The probe enables clean start. The default is 0. Note: If you have specified a named pipe using the FifoName property, the probe ignores the value set for this property. This is because this functionality cannot be used with FIFOs.
FifoName `string`	-fifoname `string`	Use this property to specify the path to the FIFO in which syslog messages are created and read. The default is " ".
InactivityAlarmTime `integer`	-inactivityalarmtime `integer`	Use this property to specify the time (in seconds) the probe allows a port to be inactive before sending an inactivity alarm. The probe generates a ProbeWatch message for every interval of inactivity that occurs. The default is 60. Note: Setting this property to 0 disables the inactivity feature.
LogFile `string`	-logfile `string`	Use this property to specify the path to the log file from which the probe reads syslog messages. The default is /var/log/ncolog.
OffsetOne `integer`	-offset1 `integer`	Use this property to specify the number of token elements to create. The default is 20.
OffsetTwo `integer`	-offset2 `integer`	Use this property to specify the position (count of tokens) within the syslog message at which the details section begins. The default is 6.
OffsetZero `integer`	-offset0 `integer`	Use this property to specify the character position from where the probe should parse the event data. The default is 0.
QuoteCharacters `string`	-quote `string`	Use this property to specify the characters that the probe treats as quote marks. Anything contained within matching quote characters is treated as a single token. The default is \'\".
RecoveryFile `string`	-recoveryfile `string`	Use this property to specify the name of the recovery file to which the probe writes recovery data. The default is $OMNIHOME/var/syslog.reco. Note: If you have specified a named pipe using the FifoName property, the probe ignores the value set for this property. This is because this functionality cannot be used with FIFOs.
ReplayFile `integer`	-noreplayfile (This is equivalent to ReplayFile with a value of 0.) -replayfile (This is equivalent to ReplayFile with a value of 1.)	Use this property to specify whether the probe reads events from the beginning of the event logs. This property takes the following values: 0: The probe checks the recovery file and reads events starting from the last event read. 1: The probe reads events from the beginning of the event log, creating events for each one. The default is 0. Note: If you have specified a named pipe using the FifoName property, the probe ignores the value set for this property. This is because this functionality cannot be used with FIFOs.
SendHUP `integer`	-nosendhup (This is equivalent to SendHUP with a value of 0.) -sendhup (This is equivalent to SendHUP with a value of 1.)	Use this property to specify whether the probe sends a SIGHUP signal to the syslog daemon on startup. This property takes the following values: 0: The probe does not send a SIGHUP signal. 1: The probe sends a SIGHUP signal. The default is 0. Note: To send SIGHUP signal, the probe must be used with suid root. For details about using the SendHUP property and for details about a known issue on AIX, see Sending a SIGHUP signal.
SyslogPIDFile `string`	-syslogpidfile `string`	Use this property to specify the name of the file that stores the process ID for the device. The default is /etc/syslog.`pid`, where `pid` is the process ID number. Note: Make sure that the user running the probe has read permission to the file that you specify with this property.
TimeFormat `string`	-timeformat `string`	Use this property to specify the timestamp conversion format (refer to the UNIX online manual page for `strptime`). The default is %b %d %T. Note: The probe will not recognize the time format if the locale is not set to English.
WhiteSpaces `string`	-white `string`	Use this property to specify the characters that the probe treats as whitespace that separate tokens. The default is \t.