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 properties and command line options common to all probes, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide. As supplied the location and name of the properties file is $NCHOME/omnibus/probes/arch/opc_ua.props.

Table 1. Properties and command line options
Property name	Command line option	Description
AcknowledgeAlarm `string`	-ackalarm (This is equivalent to AcknowledgeAlarm with a value of true.) -noackalarm (This is equivalent to AcknowledgeAlarm with a value of false.)	Use this property to specify whether the probe should acknowledge alarms that have been received. This property takes the following values: false: The probe does not acknowledge alarms that have been received. true: The probe acknowledges alarms that have been received. The default is false.
Activate SessionLocaleId `string`	-activatesessionlocaleid `string`	Use this property to define the locale id in property order for localized strings used in an ActivateSession request. Use the `;` (semicolon) delimeter to construct a list of locale ids. The default is `en-US`.
DSLLogConfig `string`	-dsllogconfig `string`	Use this property to specify the name of the configuration file for the DSL framework; the framework carries out detailed logging of the probe's components. The location of the configuration file is $NCHOME/omnibus/probes/java or %OMNIHOME%\probes\win32. The default is: opc_ua_dsl_log.properties
EnableSSL `string`	-ssl (This is equivalent to EnableSSL with a value of true.) -nossl (This is equivalent to EnableSSL with a value of false.)	Use this property to specify whether connectivity between the probe and the OPC UA server is enabled. This property takes the following values: false: Disables SSL connectivity between the probe and the OPC UA server. true: Enables SSL connectivity between the probe and the OPC UA server. The default is false.
EnableSSLDebug `string`	-ssldebug (This is equivalent to EnableSSLDebug with a value of true.) -nossldebug (This is equivalent to EnableSSLDebug with a value of false.)	Use this property to specify whether SSL debug messages are enabled. This property takes the following values: false: Disables SSL debug messages. true: Enables SSL debug messages. The default is false.
EndpointHttpHost `string`	-httphost `string`	Use this property to specify the HTTP host name or IP address (IPv4 or IPv6) of the OPC UA server. The default is: localhost.
EndpointHttpPort `integer`	-httpport `integer`	Use this property to specify the port on the HTTP server to use for alarm retrieval. The default is: 51511.
EndpointHttpService `string`	-httpservice `string`	Use this property to specify the name of the OPC UA service name that the probe uses to communicate with the OPC UA server. The property takes the following values: UAService: Use this value when connecting to a server that uses the standard WSDL supplied by the OPC Foundation. SessionEndpoint: Use this value when connecting to one of the sample servers that the OPC Foundation supplies. The default is: UAService.
EndpointHttpTns `string`	-httptns `string`	Use this property to specify the URI of the WSDL file that the probe uses when communicating with the OPC UA server. The property takes the following values: http://opcfoundation.org/UA/2008/02/Endpoints.wsdl: Use this value when connecting to a name space that uses the standard WSDL supplied by the OPC Foundation. http://opcfoundation.org/UA/2008/02/Services.wsdl: Use this value when connecting to one of the sample servers that the OPC Foundation supplies. The default is: http://opcfoundation.org/UA2008/02/Endpoints.wsdl
EndpointSessionService Name `string`	-endpointsessionservice name `string`	Use this property to specify the name of the session on the OPC UA server to use for alarm retrieval. The default is: UAEndpoints
EndpointWsdlLocation `string`	-wsdllocation `string`	Use this property to specify the location of the WSDL file that the probe uses to connect to the OPC UA server. This property can contain the path of a local WSDL file or the URL of a published WSDL file. The default is: "". The following is an example of a URL to specify the location of a local WSDL file: `EndpointWsdlLocation: "file:/C:/wsdl/ Opc.Ua.SessionEndpoint"` The following is an example of a URL to specify the location of a published WSDL file: `EndpointWsdlLocation: "http://opcfoundation.org/UA/ 2008/02/Endpoints?wsdl"`
Inactivity `integer`	-inactivity `integer`	Use this property to specify the length of time (in seconds) that can pass without the probe receiving events. If this time expires, the probe disconnects from the target system and shuts down. A value of 0 means that the probe never shuts down. The default is: 0.
InitialResync `string`	-initialresync `string`	Use this property to specify whether the probe resynchronizes with the target system after you define the items to monitor. The property takes the following values: `true`: After you define the items to monitor, the probe resynchronizes with the target system. `false`: The probe does not resynchronize with the target system. The default is `true`.
KeyStore `string`	-keystore `string`	Use this property to specify the file name (with full path) of the keystore file that contains the client certificate for SSL, if client authentication is required. The default is: `""`.
KeyStore Password `string`	-keystorepassword `string`	Use this property to specify the password required to access the certificate specified by the KeyStore property. The default is: `""`.
KeyStoreType `string`	-keystoretype `string`	Use this property to specify the keystore type obtained from the keystore, for example: `JKS`, `PKCS12`, and so forth. The default is: JKS.
MaxNotificationPer Publish `integer`	-maxnotificationperpublish `integer`	Use this property to specify the maximum number of notifications that the OPC UA server can return in response to a single Publish request. The value of this property is used as a parameter for the OPC UA CreateSubscription service. The default is: 500 notifications.
MaxResponseMessageSize `integer`	-maxresponsemessagesize `integer`	Use this property to specify the maximum size (in bytes) of the body in any SOAP message the OPC UA server sends to the probe. The value of this property is used as a parameter for the OPC UA CreateSession service. The default is: 100000.
MonitoredItemsConfig File `string`	-monitoreditemsconfigfile `string`	Use this property to specify the full path of the XML file that contains information on the items that the probe is to monitor. The information in this file is used in the OPC UA CreateMonitoredItems service. The default value is: $OMNIHOME/var/OpcUaEvent.xml. Note: You need to manually configure this property to the actual path without using the `$OMNIHOME` or `$NCHOME` environment variables.
OPCSessionName `string`	-opcsessionname `string`	Use this property to specify the session name to use when connecting to the OPC UA server. The value of this property is used as a parameter for the OPC UA CreateSubscription service. The default is: OPC client.
PidFile `string`	-pidfile `string`	Use this property to define the file that contains the process ID for the device.
RequestedLifetimeCount `integer`	-lifetimecount `integer`	Use this property to specify the maximum number of times the publishing interval can occur without the server receiving a Publish request from the probe before the server deletes the subscription. The value of this property is used as a parameter for the OPC UA CreateSubscription service. Ensure that the value of this property is three times the value of the RequestedMaxKeepAliveCount parameter. The default is: 300000.
RequestedMaxKeepAlive Count `integer`	-maxkeepalivecount `integer`	When the publishing interval has occurred a set number of times and there are no notifications to publish, the OPC UA server sends a keep-alive message to the probe. Use this property to specify the number of times the publishing interval can occur before sending a keep-alive message. The value of this property is used as a parameter for the OPC UA CreateSubscription service. The default is: 100000.
RequestedPublishing Interval `integer`	-publishinginterval `integer`	For each subscription, the OPC UA server periodically samples the monitored items and generates notifications if necessary. Use this property to define that sample interval (in milliseconds). The value of this property is used as a parameter for the OPC UA CreateSubscription service. The default is: 1000.
RequestedSessionTimeout `integer`	-sessiontimeout `integer`	Use this property to specify how long (in milliseconds) the OPC UA session should remain open when there is no activity. The value of this property is used as a parameter for the OPC UA CreateSession service. The default is: 600000.
RequestHeaderRequest Handle `integer`	-requesthandle `integer`	Use this property to specify the number to use as the request handle in the header of all OPC UA request messages. The default is: 1001
RequestHeaderReturn Diagnostics `integer`	-returndiagnostics `integer`	Use this property to specify the vendor-specific diagnostics that the server is to return in the response header. The value represents a bit mask of 32 bits. Refer to the vendor documentation for the values this property can take. The default is: 64.
RequestHeaderTimeout Hint `integer`	-timeouthint `integer`	Use this property to specify the timeout period (in milliseconds) for all HTTP requests sent to the OPC UA server. A value of 0 indicates that there is no timeout in force. The value of this property is used for the timeoutHint parameter of the Request Header in all SOAP service requests. The default is: 0.
ResyncInterval `integer`	-resyncinterval `integer`	Use this property to specify the time (in seconds) between each resynchronization operation. A value of 0 means that the probe never resynchronizes with the target system. The default is: 60.
RetryCount `integer`	-retrycount `integer`	Use this property to specify the maximum number of times the probe tries to reconnect to the target system following a communications failure. If reconnection does not occur after this number of attempts, the probe shuts down. A value of 0 means that the probe does not try to reconnect to the target but simply shuts down. The default is: 0.
RetryInterval `integer`	-retryinterval `integer`	Use the property to specify the time (in seconds) between each attempt to reconnect to the target system. A value of 0 means that the probe uses an exponentially increasing period between successive connection attempts. For example, the probe waits 1 second, then 2 seconds, then 4 seconds, and so on. The default is: 0.
StreamCapture `integer`	-streamcapture (This is equivalent to StreamCapture with a value of true (1).) -nostreamcapture (This is equivalent to StreamCapture with a value of false (0).)	Use this property to specify whether the stream capture feature is enabled. The property takes the following values: 1: The probe uses the stream capture feature. 0: The probe does not use the stream capture feature. The default is: 0. Note: If you set the value of this property to 1, define a value for the StreamCaptureFilePath property as well.
StreamCaptureFilePath `string`	-streamcapturefilepath `string`	Use this property to specify the directory where the probe stores the input data stream. The default is: "". See Data stream capture for more information on how to use this property.
TrustStore `string`	-truststore `string`	Use this property to specify the file name (with full path) of the truststore file that contains the trusted certificates. The default is: `""`.
TrustStore Password `string`	-truststorepassword `string`	Use this property to specify the password required to access the truststore file containing the trusted certificates. The default is: `""`.
TrustStoreType `string`	-truststoretype `string`	Use this property to specify the truststore type obtained from the truststore, for example: `JKS`, `PKCS12`, and so forth. The default is: JKS.