Properties and command line options

The properties file specifies how the gateway interacts with the device. You can override the default values by changing the default values in the properties file or by using the command line options. The properties file for the Gateway for Tivoli EIF is NCO_GATE.props.

Table 1 describes the properties and command line options for the properties defined in the NCO_GATE.props properties file.

Note: For information about the common Tivoli Netcool/OMNIbus properties, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

For information about the Interprocess Communication (IPC) properties, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 1. Properties and command line options
Property name	Command line option	Description
Gate.CacheHashTbl Size `integer`	-chashtblsize `integer`	Use this property to specify the number of elements that the gateway allocates for the hash table cache. The default is 5023 elements.
Gate.MapFile `string`	-mapfile `string`	Use this property to specify the location and name of the map definition file. For details of the format of this file, see Mapping data using the map definition file. On UNIX and Linux operating systems, the default is $OMNIHOME/gates/tivoli_eif/tivoli_eif.map. On Windows operating systems, the default is %OMNIHOME%\gates\tivoli_eif\tivoli_eif.map.
Gate.NGtkDebug `boolean`	-ngtkdebug `boolean`	Use this property to specify whether the NGTK library should log debug messages. The default is TRUE. Note: You can specify which debug messages are included in the debug log file using the Gate.Mapper.Debug and Gate.RDRWTR.Debug properties.
Gate.PAAware `integer`	-paaware `integer`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property.
Gate.PAAwareName `string`	-paname `string`	See the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide for information on this property.
Gate.StartupCmd File `string`	-startupcmdfile `string`	Use this property to specify the location and name of the startup command file. For details of the format of the this file, see Startup command file. On UNIX and Linux operating systems, the default is $OMNIHOME/gates/tivoli_eif/ tivoli_eif.startup.cmd. On Windows operating systems, the default is %OMNIHOME%\gates\tivoli_eif\tivoli_eif.startup.cmd.
Gate.Transfer. FailoverSyncRate `string`	-transferfailover syncrate `string`	Use this property to specify the rate (in seconds) at which the re-synchronization takes place on failover. The default is 60 seconds.
Gate.RDRWTR.Buffer Size `integer`	-rdrwtrbufsize `integer`	Use this property to specify the number of entries that the gateway stores in the buffer before flushing, if buffering is enabled. This property can be used to fine-tune the efficiency of the gateway. For details, see Understanding how the gateway controls buffer size. The default is 25. Note: The gateway flushes the buffer when the end of a batch of SQL statements has been reached regardless of the buffer size.
Gate.RDRWTR.Debug `boolean`	-rdrwtrdebug `boolean`	Use this property to specify whether the gateway includes gateway reader debug messages in the debug log. The default is TRUE.
Gate.RDRWTR. DeleteIfNoDedup `string`	-rdrwtrdeleteifnodedup `string`	Use this property to specify whether the Tivoli EIF deletes duplicate events. The default is FALSE.
Gate.RDRWTR. Description `string`	-rdrwtrdescription `string`	Use this property to specify the application description for the reader connection. This description is used in triggers and allows you to determine which component of the gateway attempted to perform an action. The default is Gateway Reader/Writer.
Gate.RDRWTR.Fail backEnabled `boolean`	-rdrwtrfailbackenabled `boolean`	Use this property to enable failback to a primary system. For details about failback functionality, see Understanding how the gateway handles failback. The default is FALSE.
Gate.RDRWTR.Fail backTimeout `integer`	-rdrwtrfailbacktimeout `integer`	Use this property to specify the time (in seconds) that the gateway allows before entering failback mode. The default is 30 seconds.
Gate.RDRWTR.Iduc FlushRate `integer`	-rdrwtriducflushrate `integer`	Use this property to specify the rate (in seconds) of the granularity of the reader. If you set this property to 0, the reader gets its updates at the same granular rate as that of the ObjectServer to which it is connected. The default 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 frequency. 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.LogOS Sql `boolean`	-rdrwtrlogossql `boolean`	Use this property to specify whether the gateway logs all SQL commands sent to the ObjectServer in debug mode. The default is FALSE.
Gate.RDRWTR.Pass word `string`	-rdrwtrpassword `string`	Use this property to specify the password associated with the user specified by the Gate.RDRWTR.Username property. The default is "". If the ObjectServer from which the gateway reads alerts is running on Tivoli Netcool/OMNIbus V7.2, or V7.2.1 this password must be encrypted by the nco_g_crypt utility. If the ObjectServer from which the gateway reads alerts is running on Tivoli Netcool/OMNIbus V7.2.1 in FIPS 140-2 mode, this password must be either plain text or encrypted using the nco_aes_crypt utility. Note: For details about the `nco_g_crypt` and nco_aes_crypt encryption utilities, see the IBM Tivoli Netcool/OMNIbus Administration Guide.
Gate.RDRWTR.Re connectTimeout `integer`	-rdrwtrreconntime out `integer`	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 is 30 seconds.
Gate.RDRWTR. RefreshCacheOn Update `integer`	-rdrwtrrefresh cacheonupdate `integer`	Use this property to specify whether the Tivoli EIF refreshes cache on each update. The default is FALSE.
Gate.RDRWTR.Server `string`	-rdrwtrserver `string`	Use this property to specify the name of the ObjectServer from which the gateway reads alerts The default is NCOMS.
Gate.RDRWTR.Status TableName `string`	-rdrwtrstatustbl name `string`	Use this property to specify the name of the status table that the gateway reads. The default is alerts.status.
Gate.RDRWTR.Tbl ReplicateDefFile `string`	-rdrwtrtblrepdef file `string`	Use this property to specify the location and name of the table replication definition file. On UNIX and Linux operating systems, the default is $OMNIHOME/gates/tivoli_eif/ tivoli_eif.rdrwtr.tblrep.def. On Windows operating systems, the default is %OMNIHOME%\gates\tivoli_eif\tivoli_eif.rdrwtr.tblrep.def.
Gate.RDRWTR.Use BulkInsCmd `boolean`	-rdrwtrnobulk inscmd `boolean`	Use this property to specify whether the gateway uses the bulk insert SQL command. The default is FALSE.
Gate.RDRWTR.User name `string`	-rdrwtrusername `string`	Use this property to specify the username used to authenticate the ObjectServer connection. The default is root.
Gate.TIVOLI_EIF. ConfigFile `string`	-tivoli_eifconfig `string`	Use this property to specify the location and name of the Tivoli EIF configuration file. On UNIX and Linux operating systems, the default is $OMNIHOME/gates/tivoli_eif/ tivoli_eif_config. On Windows operating systems, the default is %OMNIHOME%\gates\tivoli_eif\tivoli_eif_config.
Gate.TIVOLI_EIF. DeleteClass `string`	-tivoli_eif delclass `string`	Use this property to specify the Tivoli EIF delete event class name. The default is OMNIbus_Update.
Gate.TIVOLI_EIF. FullResync `boolean`	-tivoli_eiffull resync `boolean`	Use this property to specify whether the gateway performs a full resynchronization on startup. The default is FALSE.
Gate.TIVOLI_EIF. GWInstanceName `string`	-tivoli_eifin stname `string`	Use this property to specify the name of the gateway instance. The default is EIFGW. Note: You must use a different value for each Tivoli EIF gateway that you are running. This value is used for resynchronization to allow Tivoli EIF to identify from which gateway each event originates.
Gate.TIVOLI_EIF. InsertClass `string`	-tivoli_eifins class `string`	Use this property to specify the Tivoli EIF insert event class name. The default is OMNIbus.
Gate.TIVOLI_EIF. LastState changeFile `string`	-tivoli_eiflast state changefile `string`	Use this property to specify the name (not the location) of the file that contains the last state change value. The default name of the file that contains the last state change value is last_statechange.txt. Note: The directory that contains the last_statechange.txt file is $OMNIHOME/var/Gate.TIVOLI_EIF.`GWInstanceName` `string`.
Gate.TIVOLI_EIF. MaxEventSize `integer`	-tivoli_eifmax eventsize `integer`	Use this property to specify the maximum size, in bytes, of a Tivoli Netcool/OMNIbus event that the gateway will attempt to forward to the EIF receiver. The default value is `4096` bytes. The recommended maximum size is `16128` bytes if EIF event buffering is configured or `32512` bytes if EIF event buffering is not configured.
Gate.TIVOLI_EIF. MaxIDListSize `integer`	-tivoli_eifmax idlistsize `integer`	Use this property to specify the maximum size, in bytes, of each Identifier list sent during incremental resynchronization operations. The default value is `4096` bytes. The maximum size is `16128` bytes.
Gate.TIVOLI_EIF. MinimumSeverity `integer`	-tivoli_eifminsev idlistsize `integer`	Use this property to pass inserts only for alerts whose severity is greater than or equal to the value specified in this property. The default value is 3 (Minor).
Gate.TIVOLI_EIF. ReconnectTimeout `integer`	-tivoli_eifre conntimeout `integer`	Use this property to specify the time (in seconds) between each reconnection poll attempt if the connection to Tivoli EIF is lost. The default is 30 seconds.
Gate.TIVOLI_EIF. Resync `boolean`	-tivoli_eif noresync `boolean`	Use this property to specify whether the gateway performs resynchronization on startup. The default is TRUE (the gateway performs resynchronization on startup).
Gate.TIVOLI_EIF. RsyncDelClass `string`	-tivoli_eifrsyncdel class `string`	Use this property to specify the Tivoli EIF resync delete class name. The default is OMNIbus_Delete.
Gate.TIVOLI_EIF. RsyncDelEndClass `string`	-tivoli_eifrsync delendclass `string`	Use this property to specify the Tivoli EIF resync delete end class name. The default is OMNIbus_Delete_End.
Gate.TIVOLI_EIF.R syncDelStartClass `string`	-tivoli_eifrsyncdel startclass `string`	Use this property to specify the Tivoli EIF resync delete start class name. The default is OMNIbus_Delete_Start.
Gate.TIVOLI_EIF. RsyncGWStartClass `string`	-tivoli_eifrsync startclass `string`	Use this property to specify the Tivoli EIF resync gateway start class name. The default is OMNIbus_Gateway_Start.
Gate.TIVOLI_EIF Simulator `boolean`	-tivoli_eif simulator `boolean`	Use this property to specify whether the gateway writes events to a file instead of to Tivoli EIF. The default is FALSE. Note: If this property is set to TRUE, the gateway writes events to the file tivoli_eif_simulator.txt.
Gate.TIVOLI_EIF. UpdateClass `boolean`	-tivoli_eif updateclass `boolean`	Use this property to specify the Tivoli EIF update class name. The default is OMNIbus_Update.
N/A	-utf8enabled `string`	Use this command line option to control the encoding of data that is passed into, or generated by, the Windows version of the probe. Set this command line option to TRUE to run the probe in UTF-8 mode. The default is FALSE (which instructs the probe to use the default system code page).