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.

Table 1. Probe 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 restWebSocketTransport.properties file. You can specify multiple values for this property by separating each string with a comma (,).

The default is "".

The XML or JSON 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 restWebSocketTransport.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 between the probe and the EMS server is enabled or disabled. This property takes the following values:

false: SSL connectivity between the probe and the EMS server is disabled.

true: SSL connectivity between the probe and the EMS server is enabled.

The default is false.

Note: This property is only used by the probe if you are using the WebSocket TransportType.

Host string

-host string

Use this property to specify the host name or IP address of the instance of the XML or JSON event source to which the probe connects.

This property is only used by the probe if you are using the WebSocket, Webhook, or WebhookV2 TransportType.

The default is "".

Note: The probe also uses this value to replace the ++Host++ token in the restWebSocketTransport.properties file.

JsonMessageDepth integer

-jsonmessagedepth integer

Use this property to specify the number of levels in the message to traverse during parsing. This enables you to prevent the probe from having to traverse all sub-trees exhaustively.

The default is 3.

JsonNestedHeader string

-jsonnestedheader string

Use this property to specify either XML or the JSON tree structure to the nested message header.

Note: The message header is included in the events generated by the probe.

The default is "".

JsonNestedPayload string

-jsonnestedpayload string

Use this property to specify whether nested parsing on JSON data is enabled. To enable, specify either XML or JSON tree structure to the nested message payload in the JSON string values in the JSON array as specified by the MessagePayload property. This property has the same semantics as MessagePayload except that the default value is blank (an empty string), which turns off nested parsing.

The default is "".

JsonParserName string

-jsonparsername string

Use this property to specify the parser type. This property takes the following values:

DEFAULT: Generic parser for all target systems.

AWS: Specific parser for the AWS integration.

The default is "DEFAULT".

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.

MessageHeader string

-messageheader string

Use this property to specify either XML or the JSON tree structure to the message header.

Note: The message header is included in the events generated by the probe.

The default is "".

MessagePayload string

-messagepayload string

Use this property to specify either XML or the JSON tree structure to the message payload.

The default is xml.

If this property is set to xml, the TransformerFile property must be set to the XML data transformer configuration file. For JSON object parsing, consider migrating to use the new JSON parser configuration file.

Note: If you specify a JSON tree structure, it must start with json to indicate that the message is a JSON object. A probe event is derived from a JSON object pointed by message payload. The message payload object consists of name-value data pairs. The probe processes the message payload object to generate probe name-value pair elements.

PartialResync string

-partialresync string

Use this property to specify that the probe performs a partial resync on startup.

If this property is set to true, the probe performs a partial resync based on the last event received timestamp stored in a persistent file.

The default is false.

Note: This property is only for use with the Probe Integration for Nokia Network Services Platform.

Password string

-password string

Use this property to specify the password associated with the Username property for logging into the XML or JSON event source.

The default is "".

Note: The probe uses this value to replace the ++Password++ token (if it is specified) in the restWebSocketTransport.properties file or in the restWebHookTransport.properties file.

Port

integer

-port

integer

Use this property to specify the host port of the instance of the XML or JSON event source to which the probe connects.

This property is only used by the probe if you are using the WebSocket, Webhook, or WebhookV2 TransportType.

The default is 0.

Note: The probe also uses this value to replace the ++Port++ token in the restWebSocketTransport.properties file.

RecordData string

-recorddata string

Use this property to specify a comma-separated list of attributes from the event to be recorded in the file specified by the DataBackupFile property.

The data recorded can be used by the probe to resolve transport properties using tokens with the prefix "RecordData.". For example, if the event generated by the probe has a URL attribute that should be recorded, set the RecordData property to URL.

To use this attribute to resolve a property in the probe's transport property file, set the property with the following token: WebSocketURL=++URL++

StreamCapture string

-streamcapture string

Use this property to specify whether or not the probe stores the XML or JSON 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.

On UNIX and Linux® operating systems, the default is $OMNIHOME/var/ message_bus.stream.

On Windows operating systems, you must specify the full directory path to the file. For example: C:\\IBM\\Tivoli\\Netcool\\omnibus\\var\\ message_bus.stream

TransformerFile string

-transformerfile string

Use this property to specify the location of the transformer properties file.

This property can be used to specify the transformer configuration file for XML event data transformation, or the JSON parser configuration file for parsing different JSON object structures.

On UNIX and Linux operating systems, the default is $OMNIHOME/java/conf/transformers.xml.

On Windows operating systems, you must specify the full directory path to the file. For example: 'C:\\IBM\\Tivoli\\Netcool\\omnibus\\java\\conf\\transformers.xml'

TransportFile string

-transportfile string

Use this property to specify the location of the transport properties file.

On UNIX and Linux operating systems, the default is $OMNIHOME/java/conf/jmsTransport.properties.

On Windows operating systems, you must specify the full directory path to the file. For example: 'C:\\IBM\\Tivoli\\Netcool\\omnibus\\java\\conf\\jmsTransport.properties'

TransportQueueSize integer

-transportqueuesize integer

Use this property to increase the queue size for raw events to prevent events from being discarded due to a full queue.

The default is 2000.

TransportType string

-transporttype string

Use this property to either specify the transport method to be used or to define the name of the transport module class to use. This property takes the following values:

  • EventSource
  • File
  • HTTP
  • JMS
  • KAFKA
  • MQTT
  • PULSAR
  • Socket
  • Webhook
  • WebhookV2
  • WebSocket

The default is JMS.

Username string

-username string

Use this property to specify the user account for logging into the XML or JSON event source.

This property is only used by the probe if you are using the WebSocket TransportType.

The default is "".

Note: The probe uses this value to replace the ++Username++ token (if it is specified) in the restWebSocketTransport.properties file or in the restWebHookTransport.properties file.