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

AckSystemId string

-acksystemid string

Use this property to specify the system identifier to use when acknowledging and deacknowledging alarms using the CLI.

The default is "".

AckUserId string

-ackuserid string

Use this property to specify the user ID to use when acknowledging and deacknowledging alarms using the CLI.

The default is "".

Agentheartbeat integer

-agentheartbeat integer

Use this property to specify the frequency (in seconds) with which the probe checks the status of the IRP Agent.

The default is 60.

AlarmFilter string

-alarmfilter string

Use this property to specify the filter that the Alarm IRP point uses to limit the alarms sent to the probe.

The default is "".

AlarmIrpFile string

-alarmirpfile string

Use this property to specify the location of the file that contains the IOR of the AlarmIRP object.

The default is "".

AlarmIrpName string

-alarmirpiorfilename string

Use this property to specify the name of the Alarm IRP Agent.

The default is 1.SubNetwork/1.Management Node/1.IrpAgent/A0.AlarmIRP/Object.

BeatInterval integer

-beatinterval integer

Use this property to specify the heartbeat interval (in seconds) for peer-to-peer failover.

The default is 2.

ClearSystemId string

-clearsystemid string

Use this property to specify the system identifier to use when clearing alarms using the CLI.

The default is "".

ClearUserId string

-clearuserid string

Use this property to specify the user ID to use when clearing alarms using the CLI.

The default is "".

CommandPort integer

-commandport string

Use this property to specify the port through which you will send commands using the CLI.

The default is 6970.

CommandPortLimit integer

-commandportlimit integer

Use this property to specify the maximum number of Telnet connections that the probe can make using the command port.

The default is 10.

EntryPointIrpFile string

-entrypointirpfile string

Use this property to specify the location of the file containing the IOR of the Entry Point IRP object.

The default is "".

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

Mode string

-master (This is equivalent to Mode with a value of master.)

-slave (This is equivalent to Mode with a value of slave.)

Use this property to specify the mode of operation of a probe instance in a peer-to-peer failover relationship. This property takes the following values:

master: The probe is the master probe in the failover relationship.

slave: The probe is the slave probe in the failover relationship.

standard: There is no failover relationship.

The default is standard.

NamingServiceHost string

-namingservicehost string

Use this property to specify the name of the host where the Naming Service is available.

The default is localhost.

NamingServicePort string

-namingserviceport string

Use this property to specify the port on which the Naming Service listens on.

The default is 5001.

NonFilterableEvent BodyResynchParse string

-nonfilterableevent bodyresynchparse (This is equivalent to NonFilterableEvent BodyResynchParse with a value of true.)

-nononfilterableevent bodyresynchparse (This is equivalent to NonFilterableEvent BodyResynchParse with a value of false.)

Use this property to specify whether the probe parses the NonFilterableEventBody structure during resynchronization.

The default is true.

NotificationCategories string

-notificationcategories string

Use this property to specify the notification categories to which the probe subscribes.

To specify multiple categories, separate them using semicolons in the following format:

category1;category2;categoryn

The default is "" (the probe subscribes to all available notification categories).

NotificationFilter string

-notificationfilter string

Use this property to specify the filter that the Notification IRP point uses to limit the notifications sent to the probe.

The default is "".

NotificationIrpFile string

-notificationirpfile string

Use this property to specify the location of the file that contains the IOR of the NotificationIRP object.

The default is "".

NotificationIrpName string

-notificationirpname string

Use this property to specify the name of the Notification IRP Agent.

The default is 1.SubNetwork/1.Management Node/1.IrpAgent/N0.NotificationIRP/Object.

NotificationIrpVersion string

-notificationirpversion string

Use this property to specify the Notification IRP version.

The version specified must be use the format \"32.303 VN.n\", where N is the major version number and n is the minor version number. For example: 32.303 V6.4

The default is "".

ORBCharEncoding string

-orbcharencoding string

Use this property to specify the native character encoding set used by the Object Request Broker (ORB) for character data.

The default is ISO8859_1.

ORBLocalPort integer

-orblocalport integer

Use this property to specify the local port to which the ORB listens.

The default is 0 (the ORB selects an available port at random).

ORBLocalHostName string

-orblocalhostname string

Use this property to specify the local host used by the server-side ORB to place the server's host name into the IOR of a remote object.

The default is "".

ORBWCharDefault string

-orbwchardefault string

Use this property to specify what wide character (wchar) set the IBM ORB uses when communicating with other ORBs that do not publish a wchar set.

The default is UTF16.

PeerHost string

-peerhost string

Use this property to specify the host name of the network element acting as the counterpart to this probe instance in a peer-to-peer failover relationship.

The default is localhost.

PeerPort integer

-peerport integer

Use this property to specify the port through which the master and slave probes communicate in a peer-to-peer failover relationship.

The default is 9999.

Resynch string

-noresynch (This is equivalent to Resynch with a value of false.)

-resynch (This is equivalent to Resynch with a value of true.)

Use this property to specify whether the probe attempts to resynchronize existing alarms before retrieving new alarms. This property takes the following values:

false : The probe does not attempt to resynchronize the alarms.

true : The probe attempts to resynchronize the alarms.

The default is false.

Retry string

-noretry (This is equivalent to Retry with a value of false.)

-retry (This is equivalent to Retry with a value of true.)

Use this property to specify whether or not the probe attempts to reconnect to the CORBA interface following a time out. This property takes the following values:

false : The probe does not attempt to reconnect to the CORBA interface.

true : The probe attempts to reconnect to the CORBA interface.

The default is false.

Timeout integer

-timeout integer

Use this property to specify the length of time (in seconds) that the probe waits to receive events before disconnecting from the Notification Service and shutting down.

The default is 0 (the probe never times out).

TimeTick integer

-timetick integer

Use this property to specify the duration (in minutes) of the subscription to the target.

The default is 0.