Properties and command line options

ChatinString string

-chatinstring string

Use this property to specify the chat in script for connecting to a target system. The value of this property can be a maximum of 4096 characters long.

The default is "".

ChatoutString string

-chatoutstring string

Use this property to specify the chat out script for disconnecting from a target system. The value of this property can be a maximum of 4096 characters long.

The default is "".

CommandPort integer

-commandport integer

Use this property to specify the port number on which the probe listens for commands. For details about using the command line interface, see Command line interface.

The default is 0.

ConstantHeartbeat integer

-constantheartbeat integer

Use this property to specify whether the probe uses normal heartbeating mode or constant heartbeating. This property takes the following values:

0: The probe uses normal heartbeating.

1: The probe uses constant heartbeating.

The default is 0.

FlushTime integer

–flushtime integer

Use this property to specify the amount of time (in seconds) to wait before flushing a partially read message to the ObjectServer. This is required in case messages arrive that do not have a recognized terminator, in order to prevent the probe from shutting down.

The default is 5.

HeartbeatString string

-heartbeatstring string

Use this property to specify the command to send to the network element as a heartbeat. The value that you specify must be a regular expression with a maximum of 4096 characters.

The default is "".

HeartbeatInterval integer

-heartbeatinterval integer

When running in normal heartbeating mode, use this property to specify how long (in seconds) the network element is quiet before the probe sends a heartbeat command.

When running in constant heartbeating mode, use this property to specify the interval (in seconds) between the sending of successive heartbeats to the network element.

The default is 0.

HeartbeatResponse string

-heartbeatresponse string

Use this property to specify the response to expect from the device. The value that you specify must be a regular expression with a maximum of 4096 characters.

This property is set globally in the properties file, but can be overridden for each network element using the hosts file.

The default is "".

HeartbeatTimeout integer

-heartbeattimeout integer

Use this property to specify the time (in seconds) in which to expect a response from the device.

The default is 0.

Host string

-host string

Use this property to specify the name of the host to connect to. The value of this property can be a maximum of 4096 characters long.

The default is localhost.

HostsFile string

-hostsfile string

Use this property to specify the file that the probe uses to connect to multiple network elements.

For details of the format of the hosts file, see Specifying devices using a hosts file.

The default is "".

MaxMessageSize integer

-maxmessagesize integer

Use this property to specify the maximum buffer size (in bytes) used by the probe. The recommended value is 4096.

The default is 4096.

NoBlankLine integer

-noblankline integer

Use this property to specify whether the probe expects a TL1 message to begin with two newline characters. This property takes the following values:

0: Messages do not begin with two newline characters.

1: Messages begin with two newline characters.

The default is 0.

PidFile string

-pidfile string

Use this property to specify the name of the PID file that holds the process ID of the probe.

The default is $OMNIHOME/var/tl1.

Port integer

-port integer

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

The default is 23.

ReadTimeout integer

-readtimeout integer

Use this property to specify the time (in milliseconds) before a socket read times out.

The default is 100 (0.1 seconds).

ReconnectionInterval integer

-reconnectioninterval integer

Use this property to specify the time (in seconds) between each connection attempt the probe makes to the network element. For example, if set to 10 it tries to connect every 10 seconds.

The default is 0 (the default backoff strategy is implemented).

ResponseTimeout integer

-responsetimeout integer

Use this property to specify the time (in seconds) to wait for a response from the TL1 device when performing chatin and chatout procedures.

The default is 20.

ResynchCommand string

-resynchcommand string

Use this property to specify the command to send to the network element in order to resynchronize with the probe.

The default is "".

ResynchInterval integer

-resynchinterval integer

Use this property to specify the time interval (in seconds) between the sending of resynchronization commands to the network element.

The default is 0.

SlaveMode integer

-slavemode integer

Use this property to specify how the slave probe behaves in a peer-to-peer configuration. This property takes the following values:

0: The slave probe establishes connections with the TL1 devices to receive events at the same time as the master probe, but without forwarding any events to the ObjectServer unless the master probe goes down.

1: The slave probe does not establish any connection with the TL1 devices to receive events unless the master probe goes down, thus reducing event traffic.

The default is 0.

StreamCaptureFile string

-streamcapturefile string

Use this property to specify the file that is used to store the input stream. If no file is specified then the input stream will not be saved to a file.

The default is "".

StreamCaptureFileAppend integer

-streamcapturefileappend integer

Use this property to specify how the probe writes stream capture data following the reconnection of a node. This property takes the following values:

0: Following the reconnection of a node, the probe overwrites the existing StreamCaptureFile.

1: Following the reconnection of a node, the probe appends new stream data to the existing StreamCaptureFile.

The default is 0

Tid string

-tid string

Use this property to specify the target identifier of the network element with which to connect. The value of this property can be a maximum of 4096 characters long.

The default is "".

UserDefined string

-userdefined string

Use this property to specify a comma-separated list of user-defined properties. These properties will be available to use with the rules file, and are populated whenever an event is generated.

The default is "".

WakeupAttempts integer

-wakeupattempts integer

Use this property to specify the number of times to send the wakeup command specified by the WakeupString property.

The default is 0.

WakeupInterval integer

-wakeupinterval integer

Use this property to specify the interval (in seconds) between the sending of wakeup tokens.

The default is 1.

WakeupString string

-wakeupstring string

Use this property to specify the string sent in order to provoke a response from the device. This string wakes up the device to allow the probe to log in. The value of this property can be a maximum of 4096 characters long.

The default is "".