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 information about default properties and command line options, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide, (SC14-7530).

Table 1. Properties and command line options

Property name

Command line option

Description

AlarmIndexIsOID boolean

-alarmindexlsoid boolean

Use this property to specify whether the probe treats the resource identifier in the resynchronization table as an object identifier (OID).

0: The probe does not treat the resource identifier in the resynchronization table as an OID.

1: The probe treats the resource identifier in the resynchronization table as an OID.

The default is 0.

Note: This property is only used when the GenbandCVMVersion property is set to a value lower than 14. For GenbandCVMVersion versions 14 and above, the probe always treats alarm resource IDs as an OID.

BindAddress string

-bindaddress string

Use this property to specify the IP address to which the socket is bound.

The default is "".

ConfPath string

-confpath string

Use this property to specify a colon separated list of the paths that contain configuration files for the SNMP probe engine.

The default is '$OMNIHOME/probes/arch:/export/build/tmp/${USERNAME}'

DisableResynch integer

-disableresynch integer

By default the probe performs a full resynchronization at startup, use this property to disable this automatic resynchronization. This property takes the following values:

0: The probe preforms a full resynchronization at startup.

1: The probe does not perform synchronization on startup.

The default is 0.

FlushBufferInterval integer

-flushbufferinterval integer

Use this property to specify how often (in seconds) the probe flushes all alerts in the buffer to the ObjectServer.

The default is 0 (which instructs the probe to never flush the alerts to the ObjectServer).

GenbandCVMVersion integer

-genbandcvmversion integer

Use this property to specify the version of Genband CVM to which the probe is connected.

The default is 14.

GenbandEMSCommunity string

-genbandemscommunity string

Use this property to specify the SNMP community string for Genband IEMS.

The default is 'public'.

GenbandEMSHostName integer

-genbandemshostname integer

Use this property to specify the IP address of the host running Genband IEMS to which the probe connects.

The default is 127.0.0.1.

GenbandEMSPort integer

-genbandemsport integer

Use this property to specify the port number of the Genband IEMS host to which the probe connects.

The default is 8001.

Heartbeat integer

-heartbeat integer

Use this property to specify the frequency (in seconds) that the probe ends a heartbeat message to the Genband IEMS server to check if Genband IEMS is still running.

The default is 60.

MIBDirs string

-mibdirs string

Use this property to specify a colon-separated list of directories in which the probe searches for MIB modules.

The default is '$OMNIHOME/common/mibs'.

MIBFiles string

-mibfiles string

Use this property to specify the name of the MIB file.

The default is '$OMNIHOME/probes/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 a colon-separated list of the MIB modules that the probe loads.

The default is 'ALL' (which instructs the probe to load all modules available in the directories specified by the MIBDirs property).

NlmConfigGlobal EntryLimit integer

-nlmconfigglobal entrylimit integer

Use this property to specify the maximum number of alarms that Genband IEMS stores in its cache of most recently generated alarms. This is effectively the number of consecutive missed events that the probe allows before it performs a full resynchronization. Otherwise, the probe performs an incremental resynchronization.

The default is 25.

NoNameResolution boolean

-nonameresolution boolean

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 0.

NonPrintableAsHex boolean

-nonprintableashex boolean

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.

Note: This property only effects varbinds of octet string type. If this property is set to 1 it will assign event tokens with the hexadecimal value of non-printable characters, but the probe does not have this functionality.

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)
  • -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. If the probe is running in an IPv4 environment, specify one of the following values:
  • UDP
  • TCP
  • ALL
  • ANY

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

Currently, only the Solaris version of the probe supports IPv6.

The default is "UDP"

QuietOutput boolean

-quietoutput boolean

Use this property to specify whether the probe outputs tokens that correspond to an OID with symbolic OID expansion. Possible values are:

0: The probe outputs tokens with symbolic OID expansion.

1: The probe outputs tokens without symbolic OID expansion.

The default is 1.

Note: When the QuiteOutput property is set to 0 alarm resynchronization will fail because the probe will be unable to read OIDs with expanded symbols.

RedoResynch boolean

-redoresynch boolean

Use this property to specify whether the probe reattempts a full resynchronization if it previously failed.

0: The probe does not attempt to do a full resynchronization if it previously failed.

1: The probe attempts to do a full resynchronization if it previously failed.

The default is 0.

ResynchAttempt integer

-resynchattempt integer

Use this property to specify the number of full resynchronization attempts that the probe makes.

The default is 0.

SleepTime integer

-sleeptime integer

Use this property to specify the polling interval (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.

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 improves performance. The minimum value is 128.

The default is 8192.

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.