Common gateway properties and command-line options
Gateways have a number of common properties and associated command-line options. Properties define settings for generic functions, such as message logging, for inter-process communication (IPC), and for common gateway settings, such as specifying map definition files. You can override the default property values by editing the properties file or by using the command-line options when you start the gateway.
The following table lists the available common gateway properties and command-line options. Not all gateways use all of the properties that are listed here. See the individual gateway reference documentation for gateway-specific property information.
| Property name | Command-line option | Description |
|---|---|---|
ConfigCryptoAlg string |
-configcryptoalg string |
Use this property to specify the encryption algorithm that the gateway uses. Use this property with the ConfigKeyFile property and the nco_aes_crypt utility that is supplied with Netcool/OMNIbus. The default is AES_FIPS. |
ConfigKeyFile string |
-configkeyfile string |
Use this property to specify the encryption key that is used to encrypt data. Use this property with the ConfigCryptoAlg property and the nco_aes_crypt utility that is supplied with Netcool/OMNIbus. The default is "". |
Connections integer |
-connections integer |
Use this property to specify the maximum number of client connections that can be made to the gateway server. The default is 30. |
| Gate.CacheHashTblSize integer | -cachehtblsize integer | Use this property to specify the number of elements that the gateway allocates for the hash table cache. The default is 5023. |
| Gate.MapFile string | -mapfile string | Use this property to specify the mapping file that the gateway uses. The default is $OMNIHOME/gates/gateway_name/gateway_name.map. |
| Gate.NGtkDebug boolean | -ngtkdebug boolean | Use this property to enable the logging of NGTK library debug messages. The default is TRUE. |
| Gate.PAAware integer | -paaware integer | This property indicates whether the gateway is process agent (PA) aware. This property is maintained by the PA server and is included in the properties file for information only. The default is 0 (not PA aware). |
| Gate.PAAwareName string | -paname string | This property indicates the name of the process agent (PA) controlling the gateway. This property is maintained by the PA server and is included in the properties file for information only. The default is "". |
| Gate.StartupCmdFile string | -startupcmdfile string | Use this property to specify the location of the startup command file. The default is $OMNIHOME/gates/gateway_name/gateway_name.startup.cmd. |
| Gate.Transfer. FailoverSyncRate integer | -fsyncrate integer | Use this property to specify the rate (in seconds) of failover synchronization. The default is 60. |
| Gate.UnixAdminGrp string | -unixadmingrp string | Use this property to specify the administration group to which the gateway user account belongs when standard UNIX authentication is used. The default is ncoadmin. |
| Gate.UsePamAuth boolean | -usepamauth boolean | Use this property to specify whether PAM authentication is used. To run the gateway in FIPS 140-2 mode, set this property to TRUE. The default is FALSE. |
Help boolean |
-help boolean |
Use this property to specify that the gateway displays help information when it starts and shuts down. The default is FALSE. |
Ipc.Timeout integer |
-ipctimeout integer |
Use this property to specify the length of time (in seconds) that the client waits for the server to respond. If this time is exceeded, an error is logged. The default is 60. |
MaxLogFileSize integer |
-maxlogfilesize integer |
Use this property to specify the maximum size (in bytes) that the gateway allocates for the log file. The default is 1024. |
MessageLevel string |
-messagelevel string |
Use this property to specify the reporting level for gateway log file messages. The default is warn. |
MessageLog string |
-messagelog string |
Use this property to specify the location of the gateway message log file. The default is $OMNIHOME/log/NCO_GATE.log. |
Name string |
-name string |
Use this property to specify the name of the current gateway instance. If you want to run multiple gateways on one computer, you must use a different name for each instance. The default is NCO_GATE. |
Props.CheckNames boolean |
N/A |
Use this property to instruct the gateway to shut down if any property in the properties file is set to an invalid value. The default is TRUE. |
PropsFile string |
-propsfile string |
Use this property to specify the location of the gateway properties file. The default is $OMNIHOME/etc/NCO_GATE.props. |
|
|
-propslive boolean |
Enables dynamic update of properties using the properties file. When set to TRUE, the process monitors the properties file for any updates and rereads and consumes any modified property values. The default setting is FALSE. Whether a property value becomes effective depends on what the
property controls and also on how it is processed internally by the application. The value of a
particular property in the properties file is ignored when the value of the property was originally
set on the command line of the process. The value of a property is also ignored after it has been
altered by an |
UniqueLog boolean |
-uniquelog boolean |
Use this property to specify that log file names are made unique by adding the Process ID (PID) of the gateway to the file name. The default is FALSE. |
Version boolean |
-version boolean |
Use this property to specify that the gateway displays version information when it starts and shuts down. The default is FALSE. |
