Properties and command line options

The following tables describe the properties and command line options that are applicable to the IBM Tivoli Netcool/OMNIbus Gateway for Cloud Event Management. They cover the properties specific to the gateway and those provided by the gateway's operational environment. Specifically, the tables provide these categories of properties: properties specific to the Gateway for CEM, gateway framework properties, and generic Tivoli Netcool/OMNIbus properties.

Table 1 lists and describes the properties specific to the Gateway for CEM that are defined in the G_CEM.props properties file. The default values in Table 1 are the default values as specified in the G_CEM.props properties file.

See Gateway operation for more details on the properties specific to the Gateway for CEM properties. The details include how the properties specific to the Gateway for CEM relate to each other, depending on the values specified.

The descriptions that follow make use of the following terms:

Outbound -- Specifies the data flow sent from the gateway to the CEM.
Inbound -- Specifies the data flow received by the gateway from the CEM.

Table 1. Gateway specific properties
Property name	Command Line option	Description
Gate.CEM.Connections `integer`	-`cemconnections` `integer`	Use this property to set the number of simultaneous connections the gateway makes with the Cloud Event Management. The default value is `3`.
Gate.CEM. ConnectionTimeout `integer`	-`cemconnectiontimeout` `integer`	Use this property to specify the interval (in seconds) that the gateway allows for HTTP connections and responses to HTTP requests. The default is `15`.
Gate.CEM.ErrorCodeColumn `string`	-`cemerrorcodecolumn` `string`	Use this property to specify the name of the column in the alerts.status table that stores gateway error codes. The default name of the column is `CEMErrorCode`.
Gate.CEM.EventIdField `string`	-`cemeventidfield` `string`	Use this property to specify the name of the data field returned from the Cloud Event Management after successfully processing an alert. The gateway stores the data field value in the column specified by the Gate.TargetidField property, which by default is `CEMEventId`. The default is `eventid`.
Gate.CEM.KeyStoreFile `string`	-`cemkeystorefile` `string`	Use this property to specify the path to the keystore file in jks format. The keystore must contain the certification obtained from the same host specified by the Gate.CEM.WebhookURL property. The default is `${NCHOME}/platform/solaris2/ jre_1.7.0/jre/lib/security/ cacert`.
Gate.CEM.KeyStorePassword `string`	-`cemkeystorepassword` `string`	Use this property to specify the password used to access the keystore file specified by the Gate.CEM.KeyStoreFile property. The default is `changeit`.
Gate.CEM.RetryLimit `integer`	-`cemretrylimit` `integer`	Use this property to specify the maximum number of retries the gateway should make on an operation (for example, forwarding an event to the Event Source instance) that failed. The default value is `0` (zero), which means there is no limit to the number of retries that the gateway makes on a failed operation. The operation will be resent to CEM until successful.
Gate.CEM.Proxy `string`	-`cemproxy` `string`	Use this property to specify the proxy information that the gateway sends with HTTPS requests to CEM through the HTTP proxy server. There are four ways to configure the property: Gate.CEM.Proxy : '`hostname'` (Specifying the hostname only, the port will be `80`.) Gate.CEM.Proxy : `'hostname:port'` (Specifying the hostname and port.) Gate.CEM.Proxy : `'user:password@hostname'` (Specifying the hostname and authentication.) Gate.CEM.Proxy : `'user:password@hostname:port'` (Specifying the hostname, authentication and port.)
Gate.CEM.RetryWait `integer`	-`cemretrywait` `integer`	Use this property to specify the number of seconds the gateway should wait before retrying an operation (for example, forwarding an event to the Event Source instance) that failed. The default value is `7` seconds.
Gate.CEM.WebhookURL `string`	-`cemwebhookurl` `string`	Use this property to specify a URL of the Cloud Event Management. The URL must be in the following format: https://<host>/<uri> The default is `""`. Note: You must log into CEM to create the Cloud Event Management. This generates the webhook URL.

Table 2 lists and describes the properties provided by the gateway framework.

Table 2. Gateway framework properties
Property name	Command Line option	Description
Gate.Cache.NotificationMap `string`	-`cachenotificationmap` `string`	Use this property to specify the JavaScript file. The JavaScript specified does not have any effect on processing, but a JavaScript file (empty or otherwise) must exist in the directory for the gateway to start up. The default value is "".
Gate.Cache.ResyncMode `string`	-`cacheresyncmode` `string`	Use this property to specify a resynchronization mode for the gateway. This property takes the following value: `UNI`: The gateway performs a resynchronize operation from Tivoli Netcool/OMNIbus to Cloud Event Management. The default value is `UNI`. The gateway does not currently support the values `BI` and `AUTO`.
Gate.Cache. ResyncSuppressDeletes`string`	-`cacheresyncsuppressdeletes` `string`	Use this property to suppress all resynchronization deletes. This property takes the following values: `TRUE`: Suppresses all resynchronization deletes. `FALSE`: Does not suppress all resynchronization deletes. The default value is `FALSE`.
Gate.Cache.ResyncSuppressInitialDeletes `string`	-`cacheresyncsuppressinitialdeletes` `string`	Use this property to suppress initial (gateway startup) resynchronization deletes. This property takes the following values: `TRUE`: Suppresses initial (gateway startup) resynchronization deletes. `FALSE`: Does not suppress initial (gateway startup) resynchronization deletes. The default value is `FALSE`.
Gate.ConversionsDirection `string`	-`conversionsdirection` `string`	Use this property to specify how the gateway converts field values. This property takes the following values: `BOTH`: The gateway converts in both forward and reverse directions. Conversions generally convert integer ObjectServer values to and from target specific string values, typically converting Severity ("Clear", "Indeterminate", "Warning", "Minor", "Major", "Critical") from its integer representation to a string. `FORWARD`: The gateway only converts from OMNIbus integers to target string. `REVERSE`: The gateway only converts from target strings to OMNIbus integers. The default value is `REVERSE`. Note: The gateway does not supply a conversion table. However, you can create a conversion table to make use of this property.
Gate.MapFile `string`	-`mapfile` `string`	Use this property to specify the map definition file for the gateway to use. The default value is $OMNIHOME/gates/cem/ cem.map.
Gate.PackageBase `string`	-`packagebase` `string`	Use this property to specify the Java gateway package. The default value is com.ibm.tivoli.netcool. integrations.gateway. Note: This is an internal property and its value should not be changed.
Gate.RdrWtr.DetailsTableName `string`	-`detailstablename` `string`	The gateway does not currently support this property.
Gate.RdrWtr.IducFlushRate `integer`	-`iducflushrate` `integer`	Use this property to specify the rate (in seconds) of the granularity of the gateway's reader. If you set this property to 0 (zero), the reader gets its updates at the same granular rate as that of the ObjectServer to which it is connected. The default value is 0. Note: If you set this property to a value greater than 0, the reader issues automatic IDUC flush requests to the ObjectServer with this period. This enables the reader to run at a faster granularity than that of the ObjectServer, thus enabling the gateway to capture more detailed event changes in systems where the ObjectServer itself has high granularity settings.
Gate.RdrWtr.JournalTable Name `string`	-`journaltablename` `string`	Use this property to specify the name of the journal table that the gateway reads. The default value is alerts.journal. Note: The value for this property must be alerts.journal and should not be changed.
Gate.RdrWtr.Password `string`	-`password` `string`	Use this property to specify the login password for the ObjectServer. The Gate.RdrWtr.Password is associated with the user specified by the Gate.RdrWtr.Username property. The default value is "". Note: The gateway uses this property only when the ObjectServer runs in secure mode.
Gate. RdrWtr.ReconnectTimeout `integer`	-`reconnecttimeout` `value` -`noreconnecttimeout`	Use this property to specify the time (in seconds) between each reconnection poll attempt that the gateway makes if the connection to the ObjectServer is lost. The default value is `30` seconds. You can use `-noreconnecttimeout` to set the value to `0` (zero) to indicate that the gateway does not try to reconnect.
Gate.RdrWtr.Server `string`	-`server` `string`	Use this property to specify the name of the ObjectServer from which the gateway reads alerts. The name can either be an interface name (for example, `NCOMS`) or the `<host>:<port>` details of the ObjectServer. The default value is localhost:4100.
Gate.RdrWtr.StatusTableName `string`	-`statustablename` `string`	Use this property to specify the name of the status table to which the gateway reads and writes. The default value is alerts.status.
Gate.RdrWtr.TblReplicate DefFile `string`	-`tblrepfile` `string`	Use this property to specify the path to the table replication definition file. The path includes the name of the table replication definition file. The default value (including the name of the table replication definition file supplied with the gateway) is $OMNIHOME/gates/cem/ cem.rdrwtr. tblrep.def.
Gate.RdrWtr.Username `string`	-`username` `string`	Use this property to specify the username used to authenticate the ObjectServer connection. The default value is root. Note: The gateway uses this property only when the ObjectServer runs in secure mode.
Gate.TargetIdField `string`	-`targetidfield` `string`	Use this property to specify the `alerts.status` column to use for target identifier tracking (that is, the identifier in Cloud Event Management). The default value is CEMEventId. Note: The identifier is the globally unique identifier (GUID) for each Cloud Event Management ticket.
Gate.TraceFile `string`	-`tracefile` `string`	Use this property to specify the path of the file used to store trace information. The default value is "". Note: Typically, this property is used by IBM support to debug any issues with gateway operations.
Gate.TraceMode `string`	-`tracemode` `string` -`traceread` -`tracewrite` -`tracenone`	Use this property to specify the gateway trace mode. This property takes the following values: `READ`: Enables trace reading. `WRITE`: Enables trace writing. `NONE`: Does not enable trace reading or writing. The default value is `NONE`. Note: Typically, this property is used by IBM support to debug any issues with gateway operations. You can use the command line options `-traceread`, `-tracewrite`, or `-tracenone` to set the value to `READ`, `WRITE`, or `NONE`, respectively.
Gate.Type `string`	-`type` `string`	Use this property to specify the gateway type. The default value is cem. Note: The value for this property must be cem and should not be changed.

Table 3 lists and describes the generic Tivoli Netcool/OMNIbus properties that the gateway uses. For details on these properties, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 3. Generic OMNIbus properties
Property name	Command Line option	Description
ConfigKeyFile	-`messagelevel` `string`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property.
MaxLogFileSize	-`maxlogfilesize` `integer`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property. Note: The default maximum size for the message log file is 0 (meaning that the file size is limitless).
MessageLevel `string`	-`messagelevel` `string`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property. Note: The default message level is warn:debug.
MessageLog `string`	-`messagelog` `string`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property. Note: The default message log file is $OMNIHOME/ log/G_CEM.log.
MessageLogRolltime `string`	-`messagelogrolltime` `string`	Use this property to specify at what time a daily log file should roll. Typically, this is done at midnight, to generate daily logs. However, you can specify any time. Specify the time in `HHMM` format. Where: `HH` specifies the hour and `MM` specifies the minutes of the time you want to roll the daily log. For example, the value `'0000'` specifies that the log file rolls at midnight. The value `'0430'` specifies that the log file rolls at 04:30. The default daily log file roll time is "".
Name `string`	-`name` `string`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property. Note: The default name of the current gateway instance is cem.
Props.AllowUnknown `boolean`	-`propsallowunknown` `boolean`	Use this property to instruct the gateway on how to handle unknown properties in the properties file. Specify one of the following values: true: Instructs the gateway to allow unknown properties in the properties file and to ignore these unknown properties. false: Instructs the gateway to generate an error if there are unknown properties in the properties file. Use this setting to catch such errors as typos in property names and to avoid the diagnostics that follow typographical related errors. The default value is `false`.
PropsFile `string`	-`propsfile` `string`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property. Note: The default location and name is $OMNIHOME/etc/G_CEM.props.