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 common 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
Filter `string`	-filter `string`	Use this property to specify what emails the probe processes by defining a matching expression to match the email field content against a pattern. Emails that match the filtering expression will be processed by probe, otherwise they will be ignored. The default is Subject LIKE \'#NETCOOL.*\' (which instructs the probe to process all emails that have `#NETCOOL` in the `Subject` field). Note: The probe will not retrieve again those emails that have already been retrieved or filtered. To reset the retrieval history and thus allow probe retrieve everything currently in mailbox again, you can manually delete the file specified by RecoveryFile property while probe is stopped and then restart the probe.
FolderName `string`	-foldername `string`	Use this property to specify the name of the Exchange folder from which the probe retrieves emails. If you want to change the currently monitored folder, you should stop the probe before changing this property value so that the new folder can take effect on probe startup. The default is Inbox. Note: This property supports the specification of a subfolder under a parent folder, for example: Inbox\\All Mails From John Smith
KeyStore `string`	-keystorefile `string`	Use this property to specify the location of the keystore file that contains the Netcool/OMNIbus probe SSL certificate and corresponding private key which represents a user of the Exchange mailbox. This keystore should contain only one key entry. The default is "". Note: You only need to configure this property if Exchange is specially configured to enable certificate-based client authentication.
KeyStorePassword `string`	-keystorepassword `string`	Use this property to specify the password required to access the keystore specified by the KeyStore property. The default is "".
KeyStoreType `string`	-keystoretype `string`	Use this property to specify the type of the keystore specified by KeyStore property. Available options are: `JKS`, `PKCS12`, and any other keystore type supported by JRE. The default is JKS.
MultiLineFormat `string`	-multilineformat `string`	Use this property to specify the format of the element name that the probe uses to build multiline elements from `$Header` and `$Body`. The default is %s_%d.
ParserAlarmEnd `string`	-parseralarmend `string`	Use this property to specify the regular expression that indicates the footer of an event. The default is "". Note: When the ParserAlarmStart and ParserAlarmEnd properties are specified, then the ParserNextAlarmDelimiter property is ignored.
ParserAlarmHeader `string`	-parseralarmheader `string`	Use this property to specify the alarm header regular expression to be extracted. This property is used in conjunction with the ParserAlarmStart and ParserAlarmEnd properties. The default is "".
ParserAlarmStart `string`	-parseralarmstart `string`	Use this property to specify the regular expression that indicates the header of an event. The default is "". Note: When the ParserAlarmStart and ParserAlarmEnd properties are specified, then the ParserNextAlarmDelimiter property is ignored.
ParserElementDelimiter `string`	-parserelementdelimiter `string`	Use this property to specify the Java regular expression that indicates the delimiter for individual token in a line. The default is "" (blank) which disables tokenization and therefore whole line is treated as a token. Note: You must use a Java regular expression to specify a value for this property. For example: `[ \|\\t]` would delimit by either a space, pipe character, or a tab.
ParserIgnoreEmptyFields `string`	-parserignoreemptyfields `string`	Use this property to specify whether the probe discards tokens that contain no content. This property takes the following values: false: The probe does not discard tokens that contain no content. true: The probe discards tokens that contain no content. The default is true. Note: Discarded tokens are not visible in the rules file.
ParserNVPDelimiter `string`	-parsernvpdelimiter `string`	Use this property to specify the string that indicates the delimiter that separates the token name from the token value in the name-value pairs of an event attribute. The default is =.
ParserNextAlarmDelimiter `string`	-parsernextalarm delimiter `string`	Use this property to specify the string that indicates the end of an event. The default is <EVENT_DELIMITER>. Note: The probe ignores this property when values are specified for the ParserAlarmStart and ParserAlarmEnd properties .
ParserParseAsLines `string`	-parserparseaslines `string`	Use this property to specify whether the probe parses all entries between the alarm start and the alarm end one line at a time as individual elements. The default is false. Note: Use this property only if the ParserAlarmStart and ParserAlarmEnd properties are specified.
ParserPreserveLines `string`	-parserpreservelines `string`	Use this property to specify whether the probe should preserve the lines created by consecutive unquoted white spaces (rather than reducing them to a single space). The default is false (which instructs the probe to reduce them to a single space).
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 """.
ParserReplaceStrip CharWith `string`	-parserreplacestrip charwith `string`	Use this property to specify the character to replace the strip character set by 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. The default is false. Note: When this property is set to true, the following properties for multiple-line parsing are ignored: ParserNextAlarmDelimiter, ParserAlarmStart, ParserAlarmEnd and ParserAlarmHeader.
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. The default is true.
Password `string`	-password `string`	Use this property to specify the password for the probe mail account specified by Username property. The default is "".
PostProcessingAction `string`	-postprocessingaction `string`	Use this property to specify the kind of action that the probe performs on an email that is retrieved and processed by probe. This property takes the following values: DELETE: The probe moves the email to the Deleted Items folder. HARD_DELETE: The probe deletes the email from mail server. RELOCATE: The probe moves the email to the folder in mail box specified by the RelocationFolder property. The default is "" (which instructs the probe to take no action, which leaves the email as it is on server). Note: Regardless of how this property is configured, no action is taken on those emails not matching the expression specified by the Filter property.
ProxyDomain `string`	-proxydomain `string`	Use this property to specify the domain of the HTTP proxy server. The default is "".
ProxyHost `string`	-proxyhost `string`	Use this property to specify the HTTP proxy server address when its usage is required. The default is "".
ProxyPassword `string`	-proxypassword `string`	Use this property to specify the password for the HTTP proxy credential. The default is "".
ProxyPort `integer`	-proxyport `integer`	Use this property to specify the port number to use in the HTTP proxy server. Default is `80`.
ProxyUserName `string`	-proxyusername `string`	Use this property to specify the username for the HTTP proxy credential. The default is "".
RecoveryFile `string`	-recoveryfile `string`	Use this property to specify the location of the path to the probe session data file that preserves necessary data to allow the probe to recover from a previous shutdown and to continue from the previous session with EWS. The default is $OMNIHOME/var/ews.recovery.
ReloctionFolder `string`	-reloctionfolder `string`	When the PostProcessingAction property is set to RELOCATE, use this property specify the destination folder for emails moved after processing. The default is "".
ServiceURL `string`	-serviceurl `string`	Use this property to specify the URL that the probe uses to communicate with Exchange Web Services (EWS). This URL on the Microsoft Exchange Client Access Server represents the EWS endpoint that services your mailbox. The scheme in this URL (HTTP or HTTPS) dictates whether TLS is enabled in the establishment of the connection; for example, HTTPS enables TLS. An example value for this property is: https://outlook.office365.com/EWS/Exchange.asmx The default is "" which causes the probe to consult the Autodiscover service during the connection process to determine the service URL. The probe consults the Autodiscover service at one of the following expected URLs: https://<email_domain>/autodiscover/autodiscover.xml https://autodiscover.<email_domain>/autodiscover/autodiscover.xml http://autodiscover.<email_domain>/autodiscover/autodiscover.xml (typically for redirection) For example, if the Username property is set to johnsmith@my.company.com, the probe will try to access the Autodiscover service at https://autodiscover.my.company.com/autodiscover/autodiscover.xml. If the Autodiscover server uses a certificate which is not issued by a well-known Certificate Authority (CA), then its certificate must be imported into the store specified by the TrustStore property.
ServiceURL `string` (description continued)	-serviceurl `string`	With the availability of the Exchange Autodiscover server in a deployed environment, you should use auto discovery configuration for better resilience, because the service URL can change if the mailbox is migrated to another server in a large forest of servers, or if administrators deploy new Client Access servers. Note: By going through the Autodiscover process, the establishment of the connection to Exchange takes about 10 seconds longer.
SOCKSProxyHost `string`	-socksproxyhost `string`	Use this property to specify the SOCKS proxy server address when its usage is required. The default is "".
SOCKSProxyPassword `string`	-sockspassword `string`	Use this property to specify the password for the SOCKS proxy credential. The default is "".
SOCKSProxyPort `integer`	-socksport `integer`	Use this property to specify the port number to use in the SOCKS proxy server. Default is `1080`.
SOCKSProxyUserName `string`	-socksproxyusername `string`	Use this property to specify the username for the SOCKS proxy credential. The default is "".
StreamCaptureFile `string`	-streamcapturefile `string`	Use this property to specify the full path of the destination log file where captured EWS messages are stored. The default is "", which disables the stream capture feature. Note: Stream capture is enabled only when there is a value specified for this property. You should only using this property for temporary troubleshooting purposes because the stream capture file generated is not rotated with file size considerations during probe execution, and it is always emptied at probe startup.
TrustStore `string`	-truststore `string`	Use this property to specify a file name (with full path) of a truststore file that contains trusted certificates including certificates of Exchange server, Certificate Authority (CA), and certificates of the Autodiscover server. The default value is blank (empty string) which means the probe uses JRE-bundled trust store typically located at <java-home>/lib/security/cacerts in order to verify the Exchange server certificate. For tight control, you should use a custom truststore to limit on the certificates that probe can accept. The default is "".
TrustStorePassword `string`	-truststorepassword `string`	Use this property to specify the password required to access the truststore file specified by the TrustStore property.
TrustStoreType `string`	-truststoretype `string`	Use this property to specify the type of truststore specified by the TrustStore property. Available options are: `JKS`, `PKCS12`, and any other keystore type supported by JRE. The default is JKS.
Username `string`	-username `string`	Use this property to specify the email address of a mail account created in Exchange for the probe to retrieve emails. Note: The probe expects that the SMTP domain of this email address is the same as the User Principal Name (UPN) suffix of the associated user for this mail account in Active Directory. If they are different, you can consider adding an alternative UPN suffix of the same value as SMTP domain using the Active Directory administrative tools. The default is "".
AuthenticationType `string`	-authenticationtype `string`	Use this property to specify the authentication type to be used. This property takes the following values: Basic: Basic authentication OAuth2: OAuth authentication The default is Basic.
Authority `string`	-authority `string`	Use this property to specify the URL to the authority that will authenticate the probe to connect with Exchange Online. This is in the format: `https://login.microsoftonline.com/<Tenant Domain or Tenant Id>` The `Tenant Id` can be obtained from the Azure Active Directory Admin Center by navigating to the Properties section of the dashboard of the tenant. This property applies to OAuth authentication only. The default is "".
Scope `string`	-scope `string`	Use this property to specify the scope of the authentication request. This property applies to OAuth authentication only. The default is https://outlook.office.com/.default.
ClientId `string`	-clientid `string`	Use this property to specify the Application (client) ID of the application registered in Azure Active Directory that represents the probe. This property applies to OAuth authentication only. The default is "".
ClientSecret `string`	-clientsecret `string`	Use this property to specify the secret string used by the probe to authenticate with Azure when requesting a token. If not specified, the probe will use `ClientCertificate` to authenticate. The default is "".
ClientCertificate `string`	-clientcertificate `string`	Use this property to specify the full path to the keystore in the PKCS12 format that stores the probe server certificates (private and public keys). The public key in this keystore is the same as the one that was uploaded to Azure Active Directory earlier. The default is "".
ClientCertificatePassword `string`	-clientcertificatepassword `string`	Use this property to specify the password to access the PKCS12 keystore specified as `ClientCertificate`. The default is "".