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
Agentheartbeat `integer`	-agentheartbeat `integer`	Use this property to specify the frequency (in seconds) with which the probe checks the status of the SAM server. The default is 60.
AlarmIrpName `string`	-alarmirpname `string`	Use this property to specify the name of the Alarm IRP object to which the probe sends a resynchronization request. The default is AlarmIRP=1.
CommandPort `integer`	-commandport `integer`	Use this property to specify the port to which users can use Telnet to communicate with the CORBA interface using the Command Line Interface (CLI) supplied with the probe. For details about the CLI, see Sending commands to the CORBA interface using a command line interface. The default is 6970.
CommandPortLimit `integer`	-commandportlimit `integer`	Use this property to specify the maximum number of Telnet connections that the probe can make. The default is 10.
EPIRPFtpCommand `string`	-epirpftpcommand `string`	Use this property to specify the complete FTP command that the probe uses to access the Interoperable Object Reference (IOR) file of the EPIRP object. The default is "". The syntax of the FTP command is ftp://`user`:<password>@`host`/`path`. Enter a valid username, host, and path. If you want to specify the password in encrypted format, leave <password> as it is. The probe retrieves the encrypted password from the FtpPassword property and places it in the command. If you do not want to specify the password in encrypted format, replace <password> with the password.
EPIRPIorFile `string`	-epirpiorfile `string`	Use this property to specify the location of the IOR file of the EPIRP object. The default is /opt/5620sam/server/nms/cnbi/home/ior/EPIRP.ior.
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).
FtpPassword `string`	-ftppassword `string`	Use this property to specify the password that the probe uses with the FTP command submitted by the CLI. The default is "". Note: Enter the password encrypted using nco_aes_crypt.
ManagerIdentifier `string`	-manageridentifier `string`	Use this property to specify the name of the manager that the NotificationIRP object references when events are available for sending. The default is Netcool.
NotificationIrpName `string`	-notificationirpname `string`	Use this property to specify the name of the NotificationIRP object to which the the probe subscribes to receive new alarms as they are created. The default is NotificationIRP=1.
ORBDebug `string`	-orbdebug `string`	Use this property to specify whether or not ORB messages are written to a debug file. This property takes the following values: false: ORB messages are not written to a debug file. true: ORB messages are written in a debug file. The default is false.
ORBDebugFile `string`	-orbdebugfile `string`	Use this property to specify the file in which the ORB will write log messages when the ORBDebug property is set to true. The default is $OMNIHOME/log/orb.debug.
ORBLocalPort `integer`	-orblocalport `integer`	Use this property to specify the local port to which the Object Request Broker (ORB) listens. The default is 0 (ORB selects an available port at random).
ResyncBaseObjectFilter `string`	-resyncbaseobjectfilter `string`	Use this property to specify the base object from which the probe retrieves objects. If you want the probe to receive all alarms on the network, leave this property blank. If you want the probe to receive only those alarms on a given subnetwork, set this property to `SubNetwork=X`, where `X` identifies the subnetwork. If you want the probe to receive only those alarms generated by a specific element on a given subnetwork, set this property to `SubNetwork=X,ManagedElement=Y` where `X` identifies the subnetwork and `Y` identifies the managed element on that subnetwork. The default is "".
ResyncFilter `string`	-resyncfilter `string`	Use this property to specify the filter that the alarm IRP uses to reduce the number of the alarms sent to the probe during resynchronization. The default is "". Note: For details about specifying filtering criteria, see Filtering alarms.
SubscribeFilter `string`	-subscribefilter `string`	Use this property to specify the filter that the notification IRP uses to reduce the number of the new alarms sent to the probe. The default is "". Note: For details about specifying filtering criteria, see Filtering alarms.
SubscribeNotif Categories `string`	-subscribenotifcategories `string`	Use this property to specify the notification categories to which the probe subscribes. You can specify one or more of the following categories: 32.111-3 V8.0 - Alarms 32.663 V8.1 - Kernel events 32.353 V8.0 - Communications surveillance events Separate the notification categories with semicolons: `category1;category2; category3` For example, to subscribe to alarms and kernel events, enter the following categories: `32.111-3 V8.0;32.663 V8.1` The default is "" (which subscribes the probe to all notification categories).
SystemDN `string`	-systemdn `string`	Use this property to specify the distinguished name of the system on which the SAM server is running as defined in the following configuration file: $CNBI_HOME/config/cnbi.properties The default is sam.
SystemId `string`	-systemid `string`	Use this property to specify the system ID to use when acknowledging, clearing, or commenting on alarms within the SAM system. The default is "".
UserId `string`	-userid `string`	Use this property to specify the user ID used to connect to SAM when acknowledging, clearing, or commenting on alarms The default is Netcool.