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

DateStreamCapture integer

-datestreamcapture integer

Use this property to specify whether the probe uses the stream capture feature. This property takes the following values:

0: The probe does not use the stream capture feature.

1: The probe uses the stream capture feature.

The default is 0.

Faults string

-faults string

Use this property to specify the type of fault that the probe requests from the fault adapter. This property takes the following values:

normal: The probe acquires an abbreviated definition of the faults.

extended: The probe acquires an extended definition of the faults.

The default is extended.

HeartbeatInterval integer

-heartbeatinterval integer

Use this property to specify the time (in seconds) that the probe waits to receive data before pinging the device.

When heartbeating is in use, set the value of this property to an exact multiple of the value of the ReadTimeout property, and ensure that it is greater than the value of the HeartbeatTimeout property (see Heartbeating).

The default is 0.

HeartbeatRetryCount integer

-heartbeatretrycount integer

Use this property to specify the maximum number of consecutive ping messages the probe sends to the device before closing the connection.

The default is 10.

HeartbeatTimeout integer

-heartbeattimeout integer

Use this property to specify the time (in seconds) that the probe waits for a response to a ping. If the probe does not receive a response, it sends another ping.

To disable the heartbeating feature, set the value of this property to 0.

To use the heartbeating feature, make the value of this property a positive integer that is greater than the value of the ReadTimeout property and less than the value of the HeartbeatInterval property (see Heartbeating).

The default is 0 (heartbeating is disabled).

Host string

-host string

Use this property to specify the name of the host to which the probe connects.

The default is localhost.

MaxStreamCapFileSize integer

-maxstreamcapfilesize integer

Use this property to specify the maximum size (in bytes) of the stream capture file. When this limit is reached, the probe creates a new file.

The default is 0.

Note: If the probe reads a stream whose size exceeds the remaining allowable space in the file, it creates a new file in which it can store the whole stream.

Port integer

-port integer

Use this property to specify the port to which the probe connects.

The default is 2461.

ReadTimeout integer

-readtimeout integer

Use this property to specify the time (in milliseconds) that the probe allows the socket to be silent. If this time is exceeded, it assumes that the connection is dead and disconnects.

The default is 100.

ReconnectionInterval integer

-reconnectioninterval integer

Use this property to specify the interval (in seconds) between successive reconnection attempts.

The default is 0.

ResponseTimeout integer

-responsetimeout integer

Use this property to specify the time (in seconds) that the probe waits for a response from the device when connecting to it.

The default is 20.

RetryConnectionCount integer

-retryconnectioncount integer

Use this property to specify the number of times that the probe attempts to connect to the device. If after this number of attempts the probe has failed to connect to the device, it shuts down.

The default is 15.

RetryConnectionTimeOut integer

-retryconnectiontimeout integer

Use this property to specify the time (in seconds) that the probe waits to receive a response from the device before abandoning the connection attempt.

The default is 30.

StreamCaptureFile string

-streamcapturefile string

Use this property to specify the file that the probes uses to store the input stream log. Leaving this property blank disables the stream capture feature.

The default is "".

TargetVersion string

-targetversion string

Use this property to specify the version of Tellabs 8000 INM to which the probe connects. This property takes the following values:

FA12 for R12

FA13 for R13

FA14 for R14

FA15 for R15

FA16 for R16, R16A

FA17 for R17, R17A, SR2.0, SR2.0.1, SR2.1, SR2.2, SR3.0, SR4.0

The default is FA15.