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.
| Property name | Command line option | Description |
|---|---|---|
EIFDebugFileName string |
-eifldebugfilename string |
Use this property to specify the path to the debug file generated by the Java API. The default is $OMNIHOME/var/debug_eif.trc. |
EIFDebugLevel string |
-eifdebuglevel string |
Use this property to specify whether or not the Java API generates debug messages. This property takes the following values: ALL: The EIF Java API generates debug messages of all types (WARN, FATAL, DEBUG, INFO, and ERROR). NO: The API generates no debug messages. The default is NO. |
EIFHeartBeatInterval integer |
-eifHeartBeatInterval integer |
Use this property to specify the frequency (in seconds) that the probe sends a heartbeat message through the probe EIF layer. The default is 0 (which instructs the probe to not send heartbeat messages to the device). |
EIFHeartBeatFailures integer |
-eifHeartBeatFailures integer |
Use this property to specify the number of successive EIF heartbeat failures that the probe detects before shutting down automatically. The default is 0 (which instructs the probe to ignore heartbeat failures). |
EIFReadRetryInterval integer |
-eifReadRetryInterval integer |
Use this property to specify the time (in seconds) that the EIF API waits to receive events before retrying the connection. The default is 120. Note: See ReadRetryInterval if
using the Probe for IBM Tivoli EIF V9
or lower.
|
EIFLogFileName string |
-eiflogfilename string |
Use this property to specify the path of the log file generated by the EIF Java API. The default is $OMNIHOME/var/tivoli_eif.log. |
EIFLogLevel string |
-eifloglevel string |
Use this property to specify whether or not the EIF Java API generates log messages. This property takes the following values: ALL: The EIF Java API generates log messages of all types (WARN, FATAL, DEBUG, INFO, and, ERROR). NO: The API generates no log messages. The default is NO. |
EIFTraceFileName string |
-eiftracefilename string |
Use this property to specify the path of the trace file generated by the EIF Java API. The default is $OMNIHOME/var/tivoli_eif.trc. |
EIFTraceLevel string |
-eiftracelevel string |
Use this property to specify whether or not the EIF Java API generates trace messages. This property takes the following values: ALL: The EIF Java API generates trace messages of all types (WARN, FATAL, DEBUG, INFO, and ERROR). NO: The API generates no trace messages. The default is NO. |
EventCopies integer |
-eventcopies integer |
Use this property to specify the number of times the probe must send each event to the ObjectServer. The default is 1. |
FlushBufferInterval integer |
-flushbufferinterval integer |
Use this property to specify how often (in seconds) the probe flushes all alerts in the buffer to the ObjectServer. |
HandleMalformedAlarms string |
-handlemalformedalarms (This is equivalent to HandleMalformedAlarms with a value of true.) -nohandlemalformedalarms (This is equivalent to HandleMalformedAlarms with a value of false.) |
Use this property to specify whether the probe parses malformed alarms from IBM® Tivoli® TEC. This property takes the following values: false: The probe does not parse malformed alarms. true: The probe parses malformed alarms. The default is true. |
MaxEventQueueSize integer |
-maxeventqueuesize integer |
Use this property to specify the maximum number of events that can be queued between the native process and the ObjectServer. The default is 10000. |
PortMapper string |
-portmapper (This is equivalent to PortMapper with a value of true.) -noportmapper (This is equivalent to PortMapper with a value of false.) |
Use this property to specify whether or not the probe registers with a port mapper. The default is false. Note: This
property is not available when running the probe on Windows operating
systems.
|
PortMapperNumber integer |
-portmappernumber integer |
Use this property to specify the identifier that the probe will use to register with the port mapper. The default is 100033057 (which allows the probe to appear to be a TEC server). Note: This property is not available when
running the probe on Windows operating systems.
|
PortNumber integer |
-portnumber integer |
Use this property to specify the active port to which the probe listens for connections from the host system. The default is 9998. |
ReadRetryInterval integer |
-readretryinterval integer |
Use this property to specify the time (in seconds) that the EIF API waits to receive events before retrying the connection. The default is 120. Note: The ReadRetryInterval property is valid
with the Probe for IBM Tivoli EIF V11
but it is a deprecated property for the purpose of backward compatibility.
The properties file for the Probe for IBM Tivoli EIF version
9 and earlier contains the ReadRetryInterval property.
If you are using an older properties file you will not have any issues
starting the probe due to this property. EIFReadRetryInterval is
the equivalent property for the Probe for IBM Tivoli EIF version
11.
|
StreamCapture string |
-streamcapture (This is equivalent to StreamCapture with a value of true.) -nostreamcapture (This is equivalent to StreamCapture with a value of false) |
Use this property to specify whether the stream capture feature is enabled for debugging purposes. This property takes the following values: false: The probe disables the stream capture feature. true: The probe enables the stream capture feature. The default is false. Note: If
you set this property to true, the probe stores the
data in the file specified in the StreamCaptureFile property.
When you no longer require data for debugging, set the StreamCapture property
to false to disable the stream capture function.
|
StreamCaptureFile string |
-streamcapturefile string |
Use this property to specify the file the probe uses to store the input data stream. The default is $OMNIHOME/var/tivoli_eif.stream. |
N/A |
-utf8enabled string |
Use this command line option to control the encoding of data that is passed into, or generated by, the Windows version of the probe . Set this command line option to TRUE to run the probe in UTF-8 mode. The default is FALSE (which instructs the probe to use the default system code page). |