Properties and command line options

You use properties to specify how the probe interacts with the device. You can override the default values by using the properties file or the command line options.

The following table describes the properties and command line options specific to this probe. For more information about generic Netcool/OMNIbus properties and command line options, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 1. Properties and command line options
Property name	Command line option	Description
ActiveHostnameDuration `integer`	-activehostname duration `integer`	Use this property to specify how long (in minutes) an ip-host name value pair stays in the table. When this length of time since the probe last visited the element has elapsed, the probe removes it from the table held in memory and writes the details to the flat file for discarded IP address-host name pairs. You must specify a value between 5 and 10080 minutes. The default is 30.
BindAddress `string`	-bindaddress `string`	Use this property to specify the IP address to which the probe binds. The default is " ". Note: The IP address can be in either IPv4 or IPv6 format depending on the setting of the Protocol property.
ConfPath `string`	-snmpconfpath `string`	Use this property to specify the path of directories that contain configuration information for the SNMP probe engine. The default is $OMNIHOME/probes/`arch`/$OMNIHOME/var or `${LOGNAME}` /solaris/Omnibus36/var. Note: The directories specified using this property must be separated by a colon (:) on UNIX and Linux® or a semi-colon (;) on Windows. The configuration file is named mttrapd.conf.
ConfigCryptoAlgo `string`	-configcryptoalgo `string`	Use this property to specify the cipher algorithm used in crypto configuration processing. This property takes the following values: AES_FIPS AES The default is "".
ConfigCryptoKeyFile `string`	-configcryptokeyfile `string`	Use this property to specify the keyfile used in crypto configuration processing. Use the nco_keygen tool to generate the keyfile which will be used to encrypt the mttrapd.conf file. The default is "".
DSALog `integer`	-dsalog `integer`	Use this property to specify whether the probe logs traps that are lost because the trap queue has become full: 0: The probe does not log traps that are lost. 1: The probe logs traps that are lost. The default is 0.
DSAPeriod `integer`	-dsaperiod `integer`	Use this property to specify the time, in seconds, that traps are logged when the DSALog property has a value of 1. The default is 30.
EnableCryptoConfig `integer`	-enablecryptoconfig `integer`	Use this property to enable crypto processing on the SNMP configuration file (mttrapd.conf). This property takes the following values: 0: The probe does not perform crypto processing. 1: The probe performs the following crypto processing: a) The probe validates the values specified by the ConfigCryptoAlgo and ConfigCryptoKeyFile properties during startup b) The probe processes the encrypted mttrapd.conf file in the ConfPath directory using the cipher algorithm specified by the ConfigCryptoAlgo property and the key specified by the ConfigCryptoKeyFile property to extract the SNMP configuration contents. c) The probe produces the <PersistentDir>/mttrapd.conf file in encrypted format. 2: The probe performs the following crypto processing: a) The probe validates the values specified by the ConfigCryptoAlgo and ConfigCryptoKeyFile properties during startup b) The probe runs the decryption test on any configurations files found in the ConfPath and PersistentDir directories. The probe will exit if the test fails. c) The probe processes the encrypted mttrapd.conf file in the ConfPath directory using the cipher algorithm specified by the ConfigCryptoAlgo property and the key specified by the ConfigCryptoKeyFile property to extract the SNMP configuration contents. d) The probe produces the <PersistentDir>/mttrapd.conf file in encrypted format. The default is 0.
EngineInfoProbeWatch `integer`	-engineinfoprobewatch `integer`	Use this property to enable the probe to generate ProbeWatch messages related to engine information. This property takes the following values: 0: The probe does not send ProbeWatch messages related to engine information. 1: The probe sends a ProbeWatch message when engine inconsistencies are detected. The default is 0. Note: For details about ProbeWatch messages related to SNMP engine information, see SNMP engine update automation processing.
FlushBufferInterval `integer`	-flushbufferinterval `integer`	Use this property to specify the interval (in seconds) that the probe waits before flushing the buffer contents to the ObjectServer. The default is 0.
Heartbeat `integer`	-heartbeat `integer`	Use this property to specify the length (in seconds) of the heartbeat period. If the probe receives no traps for this length of time, it sends a heartbeat ProbeWatch message to the ObjectServer. The default is 60.
HostnameTableSize `integer`	-hostnametablesize `integer`	Use this property to specify the maximum number of IP address-host name pairs that the probe writes to a table in memory. If the table exceeds this size, the probe creates no new IP node entries in the table and writes an error message to its log. You must specify a value between 50 and 50000 entries. The default is 20000.
LogStatisticsInterval `integer`	-logstatisticsinterval `integer`	Use this property to specify the interval (in seconds) at which the probe logs internal probe statistics. The statistics reported include the following: Size of the trap queue and the inform queue Number of traps read since the last rollover Number of traps processed since the last rollover The default is 0 (does not log the internal statistics).
MIBDirs `string`	-mibdirs `string`	Use this property to specify where the probe searches for MIB modules. This is in the form of a colon-separated list of directories. The default is $OMNIHOME/common/mibs. Note: The directories specified using this property must be separated by a colon (:) on UNIX or a semicolon (;) on Windows.
MIBFile `string`	-mibfile `string`	Use this property to specify the name of the MIB file. The default is $OMNIHOME/probes/`arch`/mib.txt. Note: If you are using a rules file generated by the trapd converter, you must set this property to point to an empty file; for example, /dev/null.
MIBs `string`	-mibs `string`	Use this property to specify which MIB modules the probe loads. Your entry should be in the form of a colon-separated list of modules. The default is ALL (this instructs the probe to load all modules available in the list of directories specified by the MIBDirs property).
NoNameResolution `integer`	-nonameresolution (This is equivalent to NoNameResolution with a value of 1 -nameresolution (This is equivalent to NoNameResolution with a value of 0	Use this property to specify whether the probe performs name resolution on IP addresses: 0: The probe performs name resolution. 1: The probe does not perform name resolution. The default is 1.
NoNetbiosLookups `integer`	-nonetbioslookups `integer` (This is equivalent to NoNetbiosLookups with a value of 1.) -usenetbioslookups `integer` (This is equivalent to NoNetbiosLookups with a value of 0.)	Use this property to specify whether the probe performs netbios lookups during DNS queries: 0: The probe performs lookups 1: The probe does not perform netbios lookups The default is 0. Note: This property is only available on Windows operating systems.
NonPrintableAsHex `integer`	-nonprintableashex `integer`	Use this property to specify whether the probe sets non-printable characters to their hexadecimal values: 0: The probe does not set non-printable characters to their hexadecimal values 1: The probe sets non-printable characters to their hexadecimal values The default is 0.
PersistentDir `string`	-persistentdir `string`	Use this property to specify where the persistent configuration information is stored. The default is $OMNIHOME/var.
Port `integer`	-port `integer`	Use this property to specify the port to which the probe listens for SNMP traffic. The default is 162.
Protocol `string`	-protocol string -udp (This is equivalent to Protocol with a value of UDP or -protocol UDP.) -tcp (This is equivalent to Protocol with a value of TCP or -protocol TCP.) -all (This is equivalent to Protocol with a value of ALL or -protocol ALL.) -any (This is equivalent to Protocol with a value of ANY or -protocol ANY.) -udp6 (This is equivalent to Protocol with a value of UDPIPV6 or -protocol UDPIPV6.) -tcp6 (This is equivalent to Protocol with a value of TCPIPV6 or -protocol TCPIPV6.) -allipv6 (This is equivalent to Protocol with a value of TCPIPV6 and UDPIPV6 or -protocol ALLIPV6.)	Use this property to specify the network protocol that the probe uses. The default is UDP. If the probe is running in an IPv4 environment, specify one of the following values: UDP TCP ALL ANY Note: The values ANY and ALL are interchangeable. If the probe is running in an IPv6 environment, specify one of the following values: UDPV6 TCPV6 ALLIPV6
QuietOutput `integer`	-quietoutput (This is equivalent to QuietOutput with a value of 1.) -noquietoutput (This is equivalent to QuietOutput with a value of 0.)	Use this property to specify whether the probe outputs tokens that correspond to an OID with symbolic OID expansion: 0: The probe outputs tokens with symbolic OID expansion 1: The probe outputs tokens without symbolic OID expansion The default is 1.
RefreshHostname Interval `integer`	-refreshhostname interval `integer`	Use this property to specify the interval (in minutes) that the probe leaves between successive DNS queries to the resolve the host name of an IP. You must specify a value between 15 and 10080 minutes. The default is 60.
ReuseEngineBoots `integer`	-reuseengineboots (This is equivalent to ReuseEngineBoots with a value of 1. ) -noreuseengineboots (This is equivalent to ReuseEngineBoots with a value of 0. )	Use this property to specify whether the probe reuses the engine ID and the number of SNMP engine boots specified in the mttrapd.conf file. The property takes the following values: 0: The probe does not reuse the engine ID and number of SNMP boots. 1: The probe reuses the engine ID and the number of SNMP boots. The default is 1.
SleepTime `integer`	-sleeptime `integer`	Use this property to specify the poll time (in seconds) of the trap list. If there are no traps to be processed, the probe sleeps for this amount of time before polling the trap queue again. The default is 1.
SnmpConfigChange DetectionInterval `integer`	-snmpconfigchange detectioninterval `integer`	Use this property to specify the frequency (in minutes) that the probe checks for changes to the mttrapd.conf configuration file. If the file has changed, the probe loads its contents. The value of this property can be between 0 and 10080 (equivalent to 1 week). A value of 0 turns off the automatic detection and loading of a changed configuration file. Any other value specifies the frequency that the probe checks for changes to the file. The default is: 1 Note: The mttrapd.conf file is specified by the ConfPath property. If ConfPath is not set, the automatic detection facility will be disabled.
snmpv3MinSecurity Level `string`	-snmpv3minsecurity level `string`	Use this property to specify which SNMPv3 traps the SNMP Probe processes. By default the probe processes SNMPv3 traps of all security levels. Traps and informs have the following levels of security: NoAuth - No authorization and no privacy AuthNoPriv - Authorization, but no privacy AuthPriv - Authorization and privacy This property takes the following values: 1: The probe processes SNMP V3 Traps/Inform PDUs of security level NoAuth, AuthNoPriv, or AuthPriv. 2: The probe processes SNMP V3 Traps/Inform PDUs of security level AuthNoPriv or AuthPriv. 3: The probe processes SNMP V3 Traps/Inform PDUs of security level AuthPriv. The default is 1.
snmpv3ONLY `integer`	-snmpv3only (This is equivalent to snmpv3ONLY with a value of 1.) -nosnmpv3only (This is equivalent to snmpv3ONLY with a value of 0.)	Use this property to specify that the probe only processes SNMPv3 traps and informs. This allows you to limit event processing. This property takes the following values: 0: The probe processes all types of SNMP traps. 1: The probe only processes SNMPv3 traps. The default is 0.
SocketSize `integer`	-socketsize `integer`	Use this property to specify the size (in bytes) of the kernel buffer on the socket being used. This is set on a per-socket basis. A higher value increases the number of traps that the probe can handle. For UDP traps, this may improve performance. The default is 8192. Note: The minimum value for the SocketSize property is 128 bytes; the default is 8192 bytes. In the majority of cases, the default size is recommended.
TrapQueueMax `integer`	-trapqueuemax `integer`	Use this property to specify the maximum number of traps that can be queued for processing at any one time. The probe discards any traps received while the buffer is full. The default is 20000.
TrapStat `integer`	-trapstat `integer`	Use this property to enable trap statistics collection and the following custom rule functions used in the mttrapd_flood_control.rules file: `drop_list_contains()` `drop_list_remove()` `drop_list_add()` `read_trap_count()` `read_drop_count()` `get_queue_size()` 0: The probe does not collect trap statistics. 1: The probe collects trap statistics. The default is 0.
UsmUserBase `integer`	-usmuserbase `integer`	Use this property to specify whether the probe reads the mttrapd.conf file in the directory specified by the PeristentDir property or the ConfPath property or both of those directories. The property takes the following values: 0: The probe uses the file in ConfPath directory. 1: The probe uses the file in the PersistentDir directory. 2: The probe uses the files in both the PeristentDir and ConfPath directories. The default is 2.