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 |
|---|---|---|
ChatinString string |
-chatinstring string |
Use this property to specify the chat in script for connection to the host system. The default is "". Note: The probe uses this property only when running in Client mode (that is, when the
SocketMode property is set to Client).
|
ChatoutString string |
-chatoutstring string |
Use this property to specify the chat out script for disconnection from the host system. The default is "". Note: The probe uses this property only when running in Client mode (that is, when the
SocketMode property is set to Client).
|
| ConnectTimeout integer | -connecttimeout integer |
Use this property to specify the time (in seconds) to wait for the socket to be available. The default is 10. |
|
DSLLogConfig string |
-dsllogconfig string |
Full path to configuration file for detail probe components logging. The default is /opt/IBM/tivoli/netcool/omnibus/probes/<arch> /socket_java_dsl_log.properties. |
|
EnableSSL string |
-disablessl (This is equivalent to EnableSSL with a value of false.) -enablessl (This is equivalent to EnableSSL with a value of true.) |
Use this property to specify whether SSL connectivity between the probe and the EMS server is enabled or disabled. This property takes the following values: true: SSL connectivity between the probe and the EMS server is enabled. false: SSL connectivity between the probe and the EMS server is disabled. The default is false. |
|
EndpointSocketHost string |
-endpointsockethost string |
Use this property to specify the name of the host the probe connects to when running in Client mode. The default is localhost. Note: The probe uses this property only when running in Client mode (that is, when the
SocketMode property is set to Client).
|
| EndpointSocketPort integer | -endpointsocketport integer |
Use this property to specify the active port the probe connects to when running in Client mode. The default is 4567. Note: The probe uses this property only when running in Client mode (that is, when the
SocketMode property is set to Client).
|
| EventReadString string | -eventreadstring string |
Use this property to specify the string the probe sends to the host to indicate that it has received an event. This string can act as an acknowledgment that prompts the host to send the next alarm. The default is "". Note: The probe uses this property only when running in Server mode (that is, when the
SocketMode property is set to Server).
|
| HostNameResolution string | -hostnameresolution string |
The way this property functions depends on the mode in which the probe is operating. When the probe is running in Server mode, use this property to specify whether the probe performs name resolution on IP addresses but only if the LocalSocketHost property is configured as an IP address. This property takes the following values: true: The probe performs name resolution. false: The probe does not perform name resolution. The default is true. When running the probe in Client mode, use this property to specify whether the probe performs name resolution, but only if the EndpointSocketHost property is configured as an IP address. If the EndpointSocketHost property is configured as a host name, it sets the fully qualified domain name accordingly. This property takes the following values: true: The probe performs name resolution. false: The probe does not perform name resolution. The default is true. |
| IdleConnectionTimeout integer | -idleconnectiontimeout integer |
Use this property to specify the period (in seconds) before the probe closes idle client connections. If set to default value 0, the probe will keep idle connections. The default is 0. Note: The probe uses this property only when running in Server mode (that is, when the
SocketMode property is set to Server).
|
|
KeyStore string |
-keystore string |
Use this property to specify the location of the keystore file that contains the client certificate for SSL and trusted authority certificate. The keystore file can be The default is "". |
|
KeyStorePassword string |
-keystorepassword string |
Use this property to specify the password required to access the certificate defined in the Keystore property. The default is "". |
| LocalSocketHost string | -localsockethost string |
Use this property to specify the name of the host machine which the probe opens a socket to when running in Server mode. The default is localhost. Note: The probe uses this property only when running in Server mode (that is, when the
SocketMode property is set to Server).
|
| LocalSocketPort integer | -localsocketport integer |
This property functions differently depending on which mode the probe is operating. When running the probe in Server mode, use this property to specify the active port on which the probe listens for connections. The default is 4567. Note: Binding multiple instances of the probe to the same port is possible only on some Windows
operating system. In this case one of the instances would receive the connection requests at a given
time. The instance that receives the requests would remain unknown.
|
| LoginScript string | -loginscript string |
Use this property to control the prompt that the probe sends to any client that connects to it, and the expected reply from the client. The prompt specified must consist of two words separated by a space. The first word is the prompt the probe sends to the client and the second word is the expected reply from the client. If the reply from the client matches the reply specified by this property the probe continues processing events, otherwise the probe disconnects from the client. For example:
The default is "". Note: The probe uses this property only when running in Server mode (that is, when the
SocketMode property is set to Server).
|
| MaximumLineSize integer | -maximumlinesize integer |
Use this property to specify the maximum size (in bytes) of an event that the probe can read. The default is 1024. |
| MaximumPoolSize integer | -maximumpoolsize integer |
Use this property to specify the number of core servicing threads allowed in the thread pool. The more threads you have the more likely it is that a socket will be serviced immediately. However, the more threads you have, the more resources the probe consumes. The default is 16. |
| ParserAlarmEnd string | -parseralarmend string |
Use this property to specify the regular expression that indicates the footer of an event. The default is "". |
| ParserAlarmHeader string | -parseralarmheader string |
Use this property to specify the alarm header regular expression to be extracted. The default is "". Note: Specify a value for both the ParserAlarmStart and
ParserAlarmEnd properties so that the probe can send events to the
ObjectServer.
|
| ParserAlarmStart string | -parseralarmstart string |
Use this property to specify the regular expression that indicates the header of an event. The default is "". |
|
ParserElementDelimiter string |
-parserelement delimiter string |
Use this property to specify the characters that indicate token delimiters. When set, the probe parses the event stream treating the specified characters as the field delimiter instead of generating standard name-value pairs. The default is "". Note: This property is used in conjunction with the ParserSingleLines property.
For details, see Event stream parsing as a single line.
|
| ParserIgnoreEmpty Fields string |
-parserignoreempty fields string |
Use this property to specify whether the probe ignores instances of empty delimiters (adjacent delimiters with no data in between) in a row. true: The probe ignores empty fields and only generates tokens for fields that contain information. false: The probe generates tokens for all fields including empty fields. The default is false. For details, see Line parsing with empty values. |
| ParserNVPDelimiter string | -parsernvpdelimiter string |
Use this property to specify the name value pair delimiter. The default is =. Note: This property is used in conjunction with the ParserSingleLines property.
For details, see Event stream parsing as a single line.
|
| ParserNextAlarm Delimiter string | -parsernextalarm delimiter string |
Use this property to specify the string that indicates the end of an event. The default is "". |
| ParserParseAsLines string |
-parserparseaslines string |
Use this property to specify whether the probe parses all entries between the header and the footer one line at a time as individual elements. This property takes the following values: true: The probe parses the entries one line at a time. false: The probe does not parse the entries one line at a time. The default is false. Note: You can use this field only if you have specified values for
ParserAlarmStart and ParserAlarmEnd properties.
|
| ParserPreserveLine string | -parserpreserveline string |
Use this property to specify how the probe handles consecutive unquoted white spaces within the token value. This property takes the following values: true: The probe maintains consecutive white spaces. false: The probe reduces consecutive unquoted white spaces to a single space. The default is false. Note: For details about using this property, see Line parsing with consecutive unquoted white spaces.
|
| ParserQuoteCharacter string | -parserquotecharacter string |
Use this property to specify the quote character in the event. If this property is not set, the parser will treat quote characters as normal characters. The default is ". Note: For details about using this property, see Line parsing with quotation marks.
|
| ParserReplaceStrip CharWith string | -parserreplace stripcharwith string |
Use this property to specify the character to replace the strip character set in the ParserStripCharacter property. The default is "". |
| ParserSingleLines string | -parsersinglelines string |
Use this property to specify whether the probe parses each line as a single event. This property takes the following values: true: The probe parses each line as a single event. false: The probe does not parse each line as a single event. The default is false. Note: Set this property to true if the event data consists of a single line. For
details, see Event stream parsing as a single line
|
| ParserStripCharacter string | -parserstripcharacter string |
Use this property to specify the character to strip from the event. The default is "". |
| ParserTrimElement string | -parsertrimelement string |
Use this property to specify whether the probe strips leading and trailing white spaces and new lines from elements that it generates. true: The probe strips leading and trailing white spaces and new lines from elements that it generates. false: The probe does not strip white space and lines from elements. The default is true. |
| ProtocolHeartbeat String string | -protocolheartbeat string string |
Use this property to specify the heartbeat string from the end point to the probe. The default is "". Note: The probe uses this property only when running in Client mode (that is, when the
SocketMode property is set to Client).
|
| ReadTimeout integer | -readtimeout integer |
Use this property to specify the number of milliseconds that the probe allows a socket to write data for the probe to read. The probe discards any incomplete data after timeout. Set this property to 0 to disable ReadTimeout. The default is 0. |
| ReportStatus string |
-reportstatus string |
Use this property to specify whether the probe sends a ProbeWatch message to the ObjectServer when clients connect to or disconnect from the socket. This property takes the following values: true: The probe sends ProbeWatch messages. false: The probe does not send ProbeWatch messages. The default is true. |
| SecurityProvider string |
-securityprovider string |
Use this property to specify security provider of the configured keystore. The default is PKIX. |
| SocketBufferSize integer | -socketbuffersize integer |
Use this property to specify the maximum buffer size for each socket. The default is 65536. Note: You can increase this number if the probe needs to read a large number of events
quickly.
|
| SocketMode string | -socketmode string |
Use this property to specify whether the probe runs in Server or Client mode. This property takes the following values: Client: The probe operates in Client probe mode. Server: The probe operates in Server probe mode. The default is Server. |
| StreamCapture integer | -streamcapture integer | Use this property to specify whether the stream capture feature is enabled for debugging purposes. This property takes the following values: 0: This disables the stream capture feature. 1: This enables the stream capture feature. The default is 0. Note: If
you set this property to 1, specify the file in which
to store the data using the StreamCaptureFilename property.
When you no longer require data for debugging, set the StreamCapture property
to 0 to disable the stream capture function.
|
| StreamCaptureFilename string | -streamcapturefilename string | Use this property to specify the file that the probe uses to store the input data stream. The default is /opt/IBM/tivoli/netcool/omnibus/ var/socket_java.stream. Note: This
property is required if you set the StreamCapture property
to 1.
|