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
EventAcknowledgeMode `string`	-eventacknowledgemode `string`	Use this property to specify the acknowledgment mode in which the probe runs. This property takes the following values: `NONE`: The event will not be acknowledged when received by probe. `AUTO_ACKNOWLEDGE`: The event will be auto acknowledged when received by probe where probe will call acknowledgeAlarms API on NMS. The default is NONE.
HttpConnectionReadTimeout `integer`	-httpconnectionreadtimeout `integer`	Use this property to specify the time (in seconds) following which the HTTP connection will timeout on read operation. The default is 300.
HttpConnectionTimeout `integer`	-httpconnectionconnect timeout `integer`	Use this property to specify the time (in seconds) following which the HTTP connection will timeout on connect operation. The default is 20.
HttpLoginPassword `string`	-httploginpassword `string`	Use this property to specify the password used to authenticate for HTTP operations. The default is password.
HttpLoginUsername `string`	-httploginusername `string`	Use this property to specify the username used to authenticate for HTTP operations. The default is username.
HTTPServiceAlarmHandlingURL `string`	-httpservicealarmhandlingurl `string`	Use this property to specify HTTP URL pointing to the alarm handling service on target system. This is used for the acknowledge alarm scenario. The default is http://127.0.0.1:8081/nmsnbi/mtosi/AlarmHandling.
HttpServiceAlarmRetrieval FilterFile `string`	-httpalarmretrieval filterfile `string`	Use this property to specify the file containing the resync filter for alarm retrieval. The default is "".
HttpServiceAlarm RetrievalURL `string`	-httpservicealarm retrievalurl `string`	Use this property to specify the HTTP URL pointing to alarm retrieval service on target system The default is http://127.0.0.1:8081/nmsnbi/mtosi/AlarmRetrieval.
HttpServiceNotification ConsumerIP `string`	-httpservicenotification consumerip `string`	Use this property to specify the local ip address for the NotificationConsumer service end point. The default is 127.0.0.1.
HTTPServiceNotification ConsumerPath `string`	-httpservicenotification consumerpath `string`	Use this property to specify the local path for NotificationConsumer service end point. The default is '/nmsnbi/mtosi/NotificationConsumerService'
HttpServiceNotification Port `string`	-httpservicenotification consumerport `integer`	Use this property to specify the local port for the NotificationConsumer service end point. The default is 2000.
HttpServiceNotification ProducerURL `string`	-httpservicenotification producerurl `string`	Use this property to specify the HTTP URL pointing to the notification producer service on the target system. (This is used for subscribing/unsubscribing to alarm notification scenario). The default is http://127.0.0.1:8081/nmsnbi/mtosi/NotificationProducer.
KeyStore `string`	-keystore `string`	Use this property to specify the keystore's location and filename. The default is "".
KeyStorePassword `integer`	-keystorepassword `integer`	Use this property to specify the password required to access the keystore file containing the trusted certificates. The default is password.
ResyncBatchSize `integer`	-resyncbatchsize `integer`	Use this property to specify incoming events batch size during re-sync. The default is 100.
SecurityProtocol `string`	-securityprotocol `string`	Use this property to specify which security protocol the probe uses when SSL encryption is enabled. If no value is set for the SecurityProtocol property, the probe uses the default protocol for the JRE. The default is TLSv1.2.
ServerType `string`	-servertype `string`	Use this property to specify the type of server used for listening for notification events. Valid values are HTTP and HTTPS. The default is HTTP.
TransformerFile `string`	-transformerfile `string`	Use this property to specify the file that contains the transformer properties. The default is: $(OMNIHOME)/java/conf/transformers.xml (UNIX). %OMNIHOME%\java\conf\transformers.xml (Windows).
TrustStore `string`	-truststore `string`	Use this property to specify the file path of the truststore file. The default is "".
TrustStorePassword `string`	-trustedcertsstorepassword `string`	Use this property to specify the password required to access the truststore file containing the trusted certificates. The default is password.

Table 2. Generic Probe Framework Properties
Property name	Command line option	Description
DataBackupFile `string`	-databackupfile `string`	Use this property to specify the path to the file that stores data between probe sessions. The default is "". Note: Specify the path relative to $OMNIHOME/var.
HeartbeatInterval `integer`	-heartbeatinterval `integer`	Use this property to specify the frequency (in seconds) with which the probe checks the status of the host server. The default is 60.
Inactivity `integer`	-inactivity `integer`	Use this property to specify the length of time (in seconds) that the probe allows the port to receive no incoming data before disconnecting. The default is 0 (which instructs the probe to not disconnect during periods of inactivity).
InitialResync `string`	-initialresync `string`	Use this property to specify whether the probe requests all active alarms from the host server on startup. This property takes the following values: false: The probe does not request resynchronization on startup. true: The probe requests resynchronization on startup. For most probes, the default value for this property is false.
MaxEventQueueSize `integer`	-maxeventqueuesize `integer`	Use this property to specify the maximum number of events that can be queued between the non native process and the ObjectServer. The default is 10000. Note: You can increase this number to increase the event throughput when a large number of events is generated.
ResyncInterval `integer`	-resyncinterval `integer`	Use this property to specify the time (in seconds) that the probe waits before resynchronizing with the MTOSI server. The default is 0.
RetryCount `integer`	-retrycount `integer`	Use this property to specify how many times the probe attempts to retry a connection before shutting down. The default is 0 (which instructs the probe to not retry the connection).
RetryInterval `integer`	-retryinterval `integer`	Use this property to specify the length of time (in seconds) that the probe waits between successive connection attempts to the target system. The default is 0 (which instructs the probe to use an exponentially increasing period between successive connection attempts, for example, the probe will wait for 1 second, then 2 seconds, then 4 seconds, and so forth).
RotateEndpoint `string`	-rotateendpoint `string`	Use this property to specify whether the probe attempts to connect to another endpoint if the connection to the first endpoint fails. This property takes the following values: false: The probe does not attempt to connect to another endpoint if the connection to the first endpoint fails. true: The probe attempts to connect to another endpoint if the connection to the first endpoint fails. The default is false.