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, (SC23-6373).

Table 1. Properties and command line options

Property name

Command line option

Description

CleanStart string

-cleanstart string

Use this property to specify whether the probe runs in cleanstart mode. This property takes the following values:

false: The probe runs in recovery mode, which means that when the probe starts, it references the recovery file to determine the point within the log file from which to start reading alarms.

true: The probe runs in non-recovery mode, which means it ignores the recovery file as well as any existing file content and starts reading new events created in the log file since the probe started.

For more details see Modes of operation.

The default is false.

DSLLogConfig string

-dsllogconfig string

Use this property to specify the log file configuration file that defines the DSL framework Apache Camel context advanced logging for troubleshooting purposes.

The default is "".

EncodingStandard string

-encodingstandard string

Use this property to specify the character set used in the input log file to encode the content to be read. If no value is specified for this property, the probe checks and uses the character set configured on the host.

The default is "".

LogFileName string

-logfilename string

Use this property to specify the path to the log file from which the probe reads alarm data.

The default is "".

Note: When a log file is opened using a symbolic link, change detection is performed on the symbolic link itself, not on the content of the linked file. Therefore you should avoid using symbolic links when specifying a value for the LogFileName property.

ParserElementDelimiter string

-parserelement delimiter string

Use this property to specify the Java regular expression that indicates the delimiter for the individual token in a line of the log file.

The default is " " (a space character).

Note: You must use a Java regular expression to specify a value for this property. For example "[ |\\t]" would delimit by either a space, pipe character, or a tab.

ParserIgnoreEmpty Fields string

-parserignoreempty fields string

Use this property to specify whether the probe discards tokens that contain no content This property takes the following values:

false: The probe does not discard tokens that contain no content

true: The probe discards tokens that contain no content

The default is true.

Note: Discarded tokens are not visible in the rules file.

ParserMaxEventSize integer

-parsermaxeventsize integer

Use this property to specify the maximum buffer size (in bytes) that the probe allows for a single event. If this size is exceeded, the probe writes a warning message to the log file and breaks the event into smaller chunks, which it sends to the ObjectServer.

The default is 4098.

ParserNVPDelimiter string

-parsernvpseparator string

Use this property to specify the string that indicates the delimiter that separates the token name from the token value in the name-value pairs of an event attribute.

The default is "".

ParserQuoteCharacter string

-parserquotecharacter string

Use this property to specify the quotation character, (this will either be the single or the double quote). The probe processes directly all event data that appears between quotation characters without attempting to interpret it.

This property takes the following values:

": The probe treats the double quote mark as the quotation mark.

': The probe treats the single quote mark as the quotation mark.

By default, no value is specified for this property.

Note: If you do not specify a value for this property, the probe treats all quotation marks as ordinary literal characters.

ParserReplaceStrip CharWith string

-parserreplacestrip charwith string

Use this property to specify that character with which the probe replaces the strip character when it is encountered in the data stream.

The default is "".

ParserStripCharacter string

-parserstripcharacter string

Use this property to specify the characters that should be stripped out of the token value.

The default is "".

Note: You must use a Java regular expression to specify a value for this property. For example "[|]" would strip all pipe characters. To disable this feature, do not specify a value for this property.

RecoveryFile string

-recoveryfile string

Use this property to specify the name of the recovery file that the probe references when running in recovery mode.

For more details see Modes of operation.

The default is /opt/IBM/tivoli/netcool/omnibus/var/glf_java.reco.

Note: You must always specify the full path to the recovery file regardless of the mode in which the probe is running.