Properties and command line options
The NCO_GATE.props properties file delivered with the SNMP Writer Gateway is a text file that contains a set of properties and their corresponding values. These properties define the operational environment of the gateway, such as connection details and the location of the other configuration files.
The NCO_GATE.props properties file contains the categories of properties described in the following sections:
For more information about generic and Inter-Process Communication (IPC) properties and command line options, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.
Common Tivoli Netcool/OMNIbus properties
Table 1 describes the available Tivoli Netcool/OMNIbus common properties.
| Property name | Command line option | Description |
|---|---|---|
Help boolean |
-help boolean |
Use this property to instruct the gateway to display application help information on startup and exit. The default is FALSE. |
MaxLogFileSize integer |
-maxlogfilesize integer |
Use this property to specify the size (in bytes) that the gateway allocates for the log file. When the log file reaches this size, the gateway renames the log file by appending the name with the suffix .old and creates a new log file. The default is 1024. |
MessageLevel string |
-messagelevel string |
Use this property to specify the reporting level of the log file messages. The default is warn. |
MessageLog string |
-messagelog string |
Use this property to specify the location and name of the 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 machine, you must use a different name for each instance. The default is NCO_GATE. |
PropsFile string |
-propsfile string |
Use this property to specify the location and name of the gateway properties file. The default is $OMNIHOME/etc/NCO_GATE.props. |
UniqueLog boolean |
-uniquelog boolean |
Use this property to specify whether 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 instruct the gateway to display information about the application version on startup and exit. The default is FALSE. |
Common gateway properties
Table 2 describes the available common gateway properties.
| Property name | Command line option | Description |
|---|---|---|
|
ConfigCryptoAlg string |
-configcryptoalg string |
Use this property to specify the cryptographic algorithm to use when encrypting and decrypting config values and files. The default is AES. |
|
ConfigKeyFile string |
-configkeyfile string |
Use this property to specify the location of the file containing the key for encrypted config values and files. |
|
Gate.CacheHashTblSize integer |
-chashtblsize integer |
Use this property to specify the number of elements (database rows) that the gateway allocates for the hash table cache. The default is 5023. |
Gate.MapFile string |
-gatemap string |
Use this property to specify the location and name of the mapping file. The default is $OMNIHOME/gates/snmp/snmp.map. |
Gate.Mapper.Debug boolean |
-mapperdebug boolean |
Use this property to specify whether or not the gateway includes mapper debug messages in the debug log. The default is TRUE. |
|
Gate.Mapper. |
-mapperforhistdtls boolean |
The default is FALSE. This feature is no longer supported. |
|
Gate.Mapper. |
-mapperforhistjrnl boolean |
The default is FALSE. This feature is no longer supported. |
Gate.NGtkDebug boolean |
-ngtkdebug boolean |
Use this property to specify whether or not the NGTK library logs debug messages. The default is TRUE. |
Gate.PAAware integer |
-paaware integer |
This property indicates whether or not the gateway is Process Agent (PA) aware. The default is 0 (the gateway is not PA-aware). Note: This property is
maintained by the PA server and is included in the properties file
for information only.
|
Gate.PAAwareName string |
-paname string |
This property indicates the name of the PA controlling the gateway. The default is "". Note: This property is maintained by the PA server and is included
in the properties file for information only.
|
Gate.Reader.Debug boolean |
-readerdebug boolean |
Use this property to specify whether the gateway includes gateway reader debug messages in the debug log. The default is TRUE. |
Gate.Reader.Description string |
-readerdescription 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. |
|
Gate.Reader. |
-readerdetailstblname string |
The default is alerts.details. This feature is no longer supported. |
|
Gate.Reader. |
-readerjournaltblname string |
The default is alerts.journal. This feature is no longer supported. |
Gate.Reader. |
-failbackenabled boolean |
Use this property to specify whether or not the gateway attempts to fail back to the primary system following a system failover. The default is TRUE. Note: The gateway attempts to fail back with the frequency specified
by the Gate.Reader. FailbackTimeout property.
|
Gate.Reader. |
-failbacktimeout 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. Note: The gateway attempts to fail back to the primary ObjectServer only
if the Gate.Reader. FailbackEnabled property
is set to TRUE.
|
Gate.Reader.IducFlushRate integer |
-readeriducflushrate integer |
Use this property to specify the frequency (in seconds) at which the gateway reader requests updates from the ObjectServer. 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
greater frequency. See Controlling the frequency at which the gateway requests updates from the ObjectServer for more information.
|
Gate.Reader.LogOSSql boolean |
-readerlogossql 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.Reader.Password string |
-readerpassword string |
Use this property to specify the password associated with the user specified by the Gate.Reader.Username property. The default is "". Note: This password must be
encrypted using the nco_g_crypt utility. For
information about using nco_g_crypt, see the IBM
Tivoli Netcool/OMNIbus Administration Guide, (SC23-6371).
|
Gate.Reader. |
-readerreconntimeout 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. |
Gate.Reader.Server string |
-readerserver string |
Use this property to specify the name of the ObjectServer from which the gateway reads alerts. The default is NCOMS. |
Gate.Reader. |
-readerstatustblname string |
Use this property to specify the name of the status table that the gateway reads. The default is alerts.status. |
Gate.Reader.Tbl ReplicateDefFile string |
-readertblrepdef string |
Use this property to specify the location of the table replication definition file. The default is $OMNIHOME/gates/snmp/snmp.reader.tblrep.def. |
Gate.Reader.Username string |
-readerusername string |
Use this property to specify the user name that is used to authenticate the ObjectServer connection. The default is root. |
Gate.StartupCmdFile string |
-startupcmdfile string |
Use this property to specify the location of the startup command file. The default is $OMNIHOME/gates/snmp/snmp.startup.cmd. |
Gate.Transfer. FailoverSyncRate integer |
-fsyncrate integer |
Use this property to specify the rate (in seconds) of the failover synchronization. The default is 60. |
Gateway-specific properties
Table 3 describes the available properties specific to the SNMP Writer Gateway.
| Property name | Command line option | Description |
|---|---|---|
Gate.SNMP.Community string |
-snmpcommunity string |
Use this property to specify the community string for SNMP traps. The default is public. |
Gate.SNMP.EnableLookup boolean |
-snmpenablelookup boolean |
Use this property to specify the whether or not the lookup of the Node value is enabled. The default is TRUE. |
Gate.SNMP.EngineID string |
-snmpengineid string |
Use this property to specify the engine ID of the gateway. This identifies the gateway as the source of the SNMPv3 traps. The default is 0x0102030405. Note: This property is only used with SNMPv3 traps and must match the engine ID specified in the
configuration file of the receiver.
|
Gate.SNMP.ForwardUpdates boolean |
-snmpforwardupdates boolean |
Use this property to specify whether or not the gateway forwards alert updates to SNMP agent (gateway target). In effect, the original alert is duplicated but will include the updated data. The default is FALSE. |
Gate.SNMP.Gateway string |
-snmpgateway string |
Use this property to specify the IP address and port to which the gateway forwards traps. The default is 127.0.0.1:162. Note:
If you are operating in an IPv4 environment, specify this location in IPv4 format as address:port. For
example: If you are operating in an IPv6 environment, specify this location in IPv6 format, preceded by tcp6 or udp6 (as appropriate), and followed by the port number, as tcp6|udp6:address:port. For
example: |
Gate.SNMP.LocalName string |
-snmplocalname string |
Use this property to specify the sender full qualified domain name or IP address of the override. The default is "". For valid values refer to the Controlling forwarded TCP/IP Source IP Address. |
Gate.SNMP.OID string |
-snmpoid string |
Use this property to specify the object identifier (OID) for traps. The default is 1.3.6.1.4.1.1279 (this is an IANA-registered Private Enterprise Number). Note: This
property can also be defined as
@NodeGroup to forward
the value of the NodeGroup column in the status table. |
| Gate.SNMP.Protocol string | -snmpprotocol string |
Use this property to specify the transport protocol that the gateway uses. This property takes the following values: TCP: The gateway uses Transmission Control Protocol. UDP: The gateway uses User Datagram Protocol. The default is UDP. Note: Store-and-forward
mode is not available when the gateway is using UDP. See Store-and-forward mode for more
information.
|
Gate.SNMP.Retries integer |
-snmpretries integer |
Use this property to specify the number of times that the gateway attempts to retry sending a message on failure. When this number is exceeded, the gateway stops sending the messages to the port. For example: The gateway retries Gate.SNMP.Retries = x + 1 times. Therefore if Gate.SNMP.Retries = 5, the gateway retries 6 times. The default is 5. Note: Retries only apply to situation where Gate.SNMP.Protocol property is set
to 'TCP'.
|
|
Gate.SNMP.RetryInterval integer |
-snmpretryinterval integer |
Use this property to specify how long (in seconds) the gateway waits before retrying sending an SNMP trap following a previous failure. The default is 3. |
Gate.SNMP.SecurityLevel string |
-snmpsecuritylevel string |
Use this property to specify the security level that the gateway uses for SNMPv3 messages. This property takes the following values: AuthnoPriv: The gateway sends the username and password in encrypted format. AuthPriv: The gateway transmits the SNMP traps in encrypted format. noAuthnoPriv: The gateway does not encrypt the username, the password, or the SNMP traps. The default is noAuthnoPriv. Note: This property is only used with SNMPv3 traps.
|
Gate.SNMP.SecurityName string |
-snmpsecurityname string |
Use this property to specify the security name for the gateway as defined in the configuration file of the receiver. The default is netcool. Note: This property is only used with SNMPv3 traps.
|
Gate.SNMP.SecurityAuthProtocol string |
-snmpsecurityauthprotocol string |
Use this property to specify the authentication protocol that the gateway uses. This property takes the following values: MD5: The gateway uses the Message Digest 5 protocol. SHA, SHA1, and SHA256: The gateway uses the Secure Hash Algorithm protocol. The default property value is MD5. If an invalid property value is configured, the gateway will use the SNMP default protocol of SHA1. Note: This property is only used with SNMPv3 traps.
MD5 is not permitted when FIPS mode is enabled in the OMNIbus environment. SHA and SHA1 are equivalent. |
Gate.SNMP.SecurityPrivProtocol string |
-snmpsecurityprivprotocol string |
Use this property to specify the privacy protocol that the gateway uses to encrypt data. This property takes the following values: AES, AES192, and AES256: The gateway uses the Advanced Encryption Standard. DES: The gateway uses the Data Encryption Standard. The default property value is DES. If an invalid property value is configured, the gateway will use the SNMP default protocol of AES. Note: DES is not permitted when FIPS mode is enabled in the OMNIbus
environment.
|
Gate.SNMP.SecurityAuthPassphrase string |
-snmpsecurityauthpassphrase string |
Use this property to specify the password used for authentication. The default is password. Note: The password must be at least eight characters long. This property is only used with SNMPv3
traps.
|
Gate.SNMP.SecurityPrivPassphrase string |
-snmpsecurityprivpassphrase string |
Use this property to specify the password used for privacy. The default is password. Note: This property is only used with SNMPv3 traps.
|
Gate.SNMP.SNMPVersion integer |
-snmpsnmpversion integer |
Use this property to specify the version of the SNMP writer. Note: Only three options are supported:
1 [SNMPv1] 2 [SNMPv2] 3 [SNMPv3] The default is 2. |
Gate.SNMP.Specific string |
-snmpspecific string |
Use this property to specify the trap type value for the specific trap field in forwarded SNMP traps. The default is 1. See Specifying values for the generic and specific fields in SNMP traps for more information. Note: This property can also be defined as
@<column name> to forward the value
of the column name column in the alerts.status table. |
Gate.SNMP.Store AndForward boolean |
-snmpstoreandforward boolean |
The default is FALSE. This feature is no longer supported. |
Gate.SNMP.StoreFile string |
-snmpstorefile string |
The default is $OMNIHOME/var/NCO_GATE_snmp_.store. This feature is no longer supported. |
Gate.SNMP.Timeout integer |
-snmptimeout integer |
Use this property to specify the time (in seconds) that the gateway waits for a connection from an SNMP receiver before timing out. The default is 600. Note: This
property is only used when the Gate.SNMP.Protocol property
is set to TCP.
|
|
Gate.SNMP.Trap string |
-snmptrap string |
Use this property to specify the trap type value of the generic trap field in forwarded SNMP traps. The default is "6". The value is restricted from 0 to 6. See Specifying values for the generic and specific fields in SNMP traps for more information. Note: This
property can also be defined as
@Severity to forward
the value of the Severity column in the alerts.status table. |
Despite their presence in -help and -dumprops output, the
following properties are not used in the gateway:
-snmpfailbackenabled-
-snmpfailbacktimeout -
-snmpreconntimeout -
Gate.SNMP.FailbackEnabled -
Gate.SNMP.FailbackTimeout -
Gate.SNMP.ReconnectTimeout