Property settings for the operational environment of the gateway
You use properties to define the operational environment of the gateway. You can override the default values by using the properties file.
The following table describes the properties defined in the G_SOCKET.props properties file that are most frequently used to configure the Socket Gateway. For more information about generic properties and command line options, and Interprocess Communication (IPC) properties, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.
| Property name | Command line option | Description |
|---|---|---|
Gate.MapFile string |
-mapfile string |
Use this property to specify the mapping file for the gateway to use. The default is $OMNIHOME/gates/socket_java/socket_java.map. |
Gate.G_SOCKET.Debug boolean |
-g_socketdebug TRUE|FALSE |
Use this property to enable the gateway reader/writer debug messages. The default is TRUE. (Debug messages are enabled.) |
Gate.G_SOCKET.Failback Enabled boolean |
-g_socketfailbackenabled TRUE|FALSE |
Use this property to specify whether the gateway fails back to the backup ObjectServer when disconnected from the primary ObjectServer. The default is FALSE. |
Gate.G_SOCKET.Failback Timeout integer |
g_socketfailbacktimeout integer |
Use this property to specify the frequency (in seconds) with which the gateway attempts to fail back to the primary system following a system failover. The default is 30 seconds. |
Gate.RdrWtr.IducFlushRate 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 (zero), the reader gets its updates at the same granular rate as that of the ObjectServer to which it is connected. The default is 0 seconds. Note: If
you set this property to a value greater than 0 seconds,
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.TblReplicate DefFile string |
-rdrwtrtblrepdeffile string |
Use this property to specify the location and name of the table replication definition file. The default location and name are as follows: $OMNIHOME/gates/socket_java/ socket_java.rdrwtr.tblrep. def |
Gate.Socket.BatchName Descriptor string |
-batchnamedescriptor string |
Use this property when processing batch files. The gateway creates a batch file name with the string that you specify in this property. To generate unique names for each batch file, the gateway appends the batch sequence number and event type contained within the batch file. The default name is gw_socket.log. |
Gate.Socket.BatchSize integer |
-batchsize integer |
Use this property to specify the maximum number of events written to an individual batch file. If the Gate.Socket.SendAsBatches property is set to TRUE, the Gate.Socket.BatchSize property determines the maximum number of events that the gateway sends to a target system in a single batch. The default minimum value is 150 events. |
Gate.Socket.DateFormat string |
-dateformat string |
Use this property to specify the date format that the gateway uses for any date fields written to the socket. The default is yyyy-MM-dd\'T\'HH:mm:ssZ. |
Gate.Socket.DeleteHeader string |
-deleteheader string |
Use this property to specify the format of the header added to the start of each delete alert written to the socket. The default is 'DELETE' |
Gate.Socket.DeleteTrailer string |
-deletetrailer string |
Use this property to specify the format of the trailer added to the end of each delete alert written to the socket. The default is '\n'. |
Gate.Socket.DoTimestamp boolean |
-dotimestamp TRUE|FALSE |
Use this property to specify whether the gateway prefixes each event with the date and time of its arrival. The default is FALSE (the gateway does not prefix each event with the date and time of its arrival). |
Gate.Socket.EnableAcks boolean |
-acks : Set to TRUE or FALSE to enable or disable application level acknowledgments. -enableacks : Sets the value to TRUE to enable message or batch acknowledgements. -disableacks : Sets the value to FALSE to disable message or batch acknowledgements. |
Use this property to enable message or batch acknowledgements and application level acknowledgements. The default is FALSE (the gateway disables message or batch acknowledgements). |
Gate.Socket.EndString string |
-endstring string |
Use this property to specify the value to be added at the end of each string to be written to the socket. The default is '"'. |
Gate.Socket.Host string |
-host string |
Use this property to specify the name of the host to which the TCP connection is made. The default is localhost. |
Gate.Socket.InsertHeader string |
-insertheader string |
Use this property to specify the format of the header added to the start of each insert alert written to the socket. The default is 'INSERT'. Note: Although the command
line option is available to set the value for this property, it is
recommended that you set the value of this property in the G_SOCKET.props properties
file.
|
Gate.Socket.InsertTrailer string |
-inserttrailer string |
Use this property to specify the format of the trailer added to the end of each insert alert written to the socket. The default is '\n'. Note: Although the command
line option is available to set the value for this property, it is
recommended that you set the value of this property in the G_SOCKET.props properties
file.
|
Gate.Socket.KeepAlive string |
-keepalive string |
Use this property to specify whether the gateway keeps TCP sockets open when not in use. The default is FALSE (the gateway does not keep TCP sockets open when not in use). Important: To ensure that a firewall
does not timeout TCP connections, you must set the value to TRUE.
|
Gate.Socket.MaxBatchFiles integer |
-maxbatchfiles integer |
Use this property to specify the maximum number of batch files the gateway stores. If the number of events that the gateway can store exceeds the capacity before they are sent to a socket using a TCP connection, the gateway will ignore subsequent events (that is, the gateway creates no additional batch files). The default is 1000 batch files. |
Gate.Socket.Port integer |
-port integer |
Use this property to specify the TCP port to which the gateway connects. The default is 1234. |
Gate.Socket.ReconnectTime out integer |
-reconnecttimeout integer |
Use this property to specify the time (in seconds) the gateway waits before trying to reconnect to the socket after a connection failure. The default is 15 seconds. |
Gate.Socket.RetryAttempts DueToConnectionFailures integer |
-retryattempts_connectio nfailure integer |
Use this property to specify how many times the gateway tries to send an event or batch file when there is a socket connection failure. For example, if set to 1, the event or batch file will be dropped if a connection failure occurs after the first attempt to send it. The default is 0 (the gateway does not stop trying to send an event or batch file when there is a socket connection failure). |
Gate.Socket.RetryAttempts DueToTimeouts integer |
-retryattempts_timeouts integer |
Use this property to specify how many times the gateway tries to send an event when the socket operation times out. The default is 5 (that is, the gateway drops the event after trying to send it five times). |
Gate.Socket.SAF boolean |
-socketsaf : Set to TRUE or FALSE to enable or disable the store and forward feature. -safenabled : This sets the property to TRUE (store and forward feature is enabled). -safdisabled : This sets the property to FALSE (store and forward feature is disabled). |
Use this property to specify whether the gateway uses the store and forward feature. The default is FALSE (the store and forward feature is not enabled). For more information on the store and forward feature, see Socket Gateway Store and Forward. |
Gate.Socket.SendAsBatches boolean |
-sendasbatches : This sets the property to TRUE. -sendsingleevents : This sets the property to FALSE. |
Use this property to specify whether the gateway sends events to the target device in batches or as single events. The default is FALSE (the gateway sends events to the target device as single events). Note: You should never alter
a batch file. Batch files are internally generated by the gateway
and altering them can cause major issues.
|
Gate.Socket.Separator string |
-separator string |
Use this property to specify the character to be inserted between the fields written to the socket. The default is ';' (semicolon). |
Gate.Socket.Shutdown OnConnectionError boolean |
-shutdownon connection error: Set to TRUE or FALSE to cause the gateway to shutdown or not shutdown upon encountering a socket connection error. |
Use this property to cause the gateway to shutdown upon encountering a socket connection error. The default is FALSE (the gateway does not shutdown on encountering a socket connection error). Note: It
is expected that the Gate.Socket.SAF property
would be set to FALSE whenever this property is set
to TRUE. On shutdown one or more unprocessed events
may remain in the batch files and these would be deleted automatically
on the next gateway startup, provided SAF is disabled.
|
Gate.Socket.StartString string |
-startstring string |
Use this property to specify the value to be added at the start of each string to be written to the socket. The default is '"'. |
Gate.Socket.Timeout integer |
-timeout integer |
Use this property to specify the period (in seconds) that the gateway waits for data to be sent over the socket connection. The default is 15 seconds. |
Gate.Socket.UpdateHeader string |
-updateheader string |
Use this property to specify the value to be added to the start of each update alert written to the socket. The default is 'UPDATE'. Note: Although the command
line option is available to set the value for this property, it is
recommended that you set the value of this property in the G_SOCKET.props properties
file.
|
Gate.Socket.UpdateTrailer string |
-updatetrailer string |
Use this property to specify the value to be added to the end of each update alert written to the socket. The default is '\n'. Note: Although the command
line option is available to set the value for this property, it is
recommended that you set the value of this property in the G_SOCKET.props properties
file.
|
Java properties
The following table describes the available Java properties.
| Property name | Command line option | Description |
|---|---|---|
Gate.Java.Arguments string |
-javaargs string |
Use this property to specify the arguments to use when starting Java™. The default is "". |
Gate.Java.ClassPath string |
-javacpath string |
Use this property to specify the environment variable used to store the location of the Java libraries. The default is the value of the $CLASSPATH environment variable on the machine. |
Gate.Java.Debug boolean |
-javadebug boolean |
Use this property to enable the logging of Java debug messages. The default is TRUE (enable the logging of Java debug messages). |
Gate.Java.LibraryPath string |
-javalibpath string |
Use this property to specify the location of the Java libraries that will be set in the environment variable specified by the Gate.Java.ClassPath property. |