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 characters that are used in the FIFO to separate non-quoted tokens.

The default is ,=.

NoNameResolution integer

-nonameresolution (equivalent to NoNameResolution with a value of 0)

-nameresolution (equivalent to NoNameResolution with a value of 1)

Use this property to specify whether or not the probe performs name resolution on IP addresses. This property can take the following values:

0: The probe performs name resolution.

1: The probe does not perform name resolution.

The default is 0.

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 syslogd 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 \'\".

ReadRulesFileTimeout integer

-readrulesfiletimeout integer

Use this property to specify the period (in minutes) in which the probe checks whether the rules file has been modified. If the rules file has been modified, the probe re-reads the rules file.

The default is 10.

StreamCaptureFile string

-streamcapturefile string

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

The default is "".

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

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

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.

UDPPort integer

-udpport integer

Use this property to specify the UDP port on which the probe listens.

The default is 514.

WhiteSpaces string

-white string

Use this property to specify the characters that the probe treats as whitespace that separate tokens.

The default is \t.