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 probe specific properties and command line options configured by the hpe_omi.props file.

For information about default 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
Cookie `string`	-cookie `string`	Use this property to specify the HTTP cookie name to be retrieved from the probe store. The probe uses the value retrieved from the cookie to replace `++property_setting++` in the hpeomiTransport .properties file. You can specify multiple values for this property by separating each string with a comma (,). The default is "". The event source sends the cookie in response to the probe's login request. The default setting for this property instructs the probe to replace the `++property_setting++` token in the hpeomiTransport. properties file with the cookie value.
EnableSSL `string`	-noenablessl (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 for resynchronization and notification is enabled or disabled. This property takes the following values: false: SSL connectivity is disabled. true: SSL connectivity is enabled. The default is false.
EventCacheConfig `string`	-eventcacheconfig `string`	Use this property to specify the configuration file for the Event Cache to store OMi data tokens. The default is $OMNIHOME/probes/<arch>/ event_cache.cfg.
FormatEventQuery `string`	-formateventquery `string`	Use this property to specify whether the value set in the ResyncEventQuery property is subjected to validation or will be used for the OMi query as specified without validation. The default is true.
Host `string`	-host `string`	Use this property to specify the host name or IP address of the URL used for alert resynchronization. The default is "".
KeyStore `string`	-keystore `string`	Use this property to specify the location of the keystore file that contains the client certificate for the SSL and trusted authority certificate. The default is "".
KeyStorePassword `string`	-keystorepassword `string`	Use this property to specify the password required to access the certificate specified by the KeyStore property. The default is "". Note: You can encrypt this password using the nco_aes_crypt utility within Netcool/OMNIbus.
MaxRequestRetry `integer`	-maxrequestretry `integer`	Use this property to specify the maximum number of times that the probe retries a resynchronization request if the first resynchronization request was successful. but a subsequent one fails. The default is 10.
PageSize `integer`	-pagesize `integer`	Use this property to specify the page size the probe uses for resynchronization data. The default is 10.
Password `string`	-password `string`	Use this property to specify the password associated with the Username property for authentication for the resynchronization request. The default is "". Note: The probe uses this value to replace the `++Password++` token (if it is specified) in the hpeomiTransport.properties file.
Port `integer`	-port `integer`	Use this property to specify the host port that OMi uses for alert notification. The default is 0.
ResyncDataInclusion `string`	-resyncdatainclusion `string`	Use this property to specify the data inclusion query parameters. This property accepts the following values: include_annotations include_cis include_closed include_history include_relationships The default is include_cis, include_relationships. Note: For details about configuring this property, see Constructing the resynchronization event query and Including and ordering data in the resynchronization query.
ResyncDataOrder `string`	-resyncdataorder `string`	Use this property to specify the field and direction for resynchronization data order. The default is time_changed:ascending.
ResyncEventQuery `string`	-resynceventquery `integer`	Use this property to specify the query the probe sends to resynchronize events from OMi. The default is time_changed GE ++LAST_TIMESTAMP++ ^ time_changed LT ++CURRENT_TIME++.
ResyncTimeout `integer`	-resynctimeout `integer`	Use this property to specify the time (in seconds) that the probe allows for a resynchronization attempt. The default is 30.
StreamCapture `string`	-streamcapture `string`	Use this property to specify whether or not the probe stores the event data in a stream capture file. The default is false.
StreamCaptureFile `string`	-streamcapturefile `string`	Use this property to specify the location of the stream capture file. The default is ${OMNIHOME}/var/ hpe_omi.stream. On UNIX, if you specify an environment variable (for example, `OMNIHOME`) you must include it within curly brackets `{` `}`. On Windows operating systems, you must manually change this property value to: %OMNIHOME%\\var\\ hpe_omi.stream.
TransportFile `string`	-transportfile `string`	Use this property to specify the location of the transport properties file. The default is ${OMNIHOME}/java/conf/ hpeomiTransport.properties On UNIX, if you specify an environment variable (for example, `OMNIHOME`) you must include it within curly brackets `{` `}`. On Windows operating systems, you must manually change this property value to: %OMNIHOME%\\java\\conf\\ hpeomiTransport.properties
TransportType `string`	-transporttype `string`	Use this property to specify the transport method. The default is Webhook. Note: Currently `Webhook` is the only supported value for this property.
UseLastTimestamp `string`	-uselasttimestamp `string`	Use this property to specify whether the probe uses the last event timestamp to replace the `++LAST_TIMESTAMP++` token if configured in ResyncEventQuery property. See Constructing the resynchronization event query. true: The probe replaces the `++LAST_TIMESTAMP++` token with the last recorded event timestamp. If event timestamp is not available, then the `++LAST_TIMESTAMP++` token will be the time value 24 hours before the current time. false: The probe replaces `++LAST_TIMESTAMP++` with the time value 24 hours before the current time. The default is true.
Username `string`	-username `string`	Use this property to specify the username used in the authentication for the resynchronization request. The default is "". Note: The probe uses this value to replace the `++Username++` token (if it is specified) in the hpeomiTransport.properties file.