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

AddrepClasses string

-addrepclasses string

Use this property to specify the DMS Log Reports that the TSM monitors. For example, trk 101 trk 102 trk 103 instructs the TSM to use the DMS command addrep to monitor the three classes listed.

The default is "" (no configuration is done using the addrep command).

AltPassword string

-altpassword string

Use this property to specify a valid password that the TSM uses to log in to the switch. When the TSM logs in, the password is changed and then changed back to the original Password.

The default is "".

Note: The value of AltPassword must be different the value of Password.

ChatinString string

-chatinstring string

Use this property to specify the chat in script for connection to the host system.

If the NoConnect property is set to 1, you must specify the following login details for this property:
.*name username\r assword 
password\r .* IN.
Where *name is the expected username, and assword is the expected password. The TSM sends them to the Nortel DMS device to connect.

The default is "".

ChatoutString string

-chatoutstring string

Use this property to specify the chat out script for disconnection from the host system.

The default is "".

CommandPort integer

-commandport integer

Use this property to specify the port to which the TSM listens for commands.

The default is 0 (command port is not used).

DateStreamCapture boolean

-datestreamcapture boolean

Use this property to specify whether the TSM appends a date and time to the stream capture file name. Possible values are:

0: The TSM does not append the date and time to the stream capture file name.

1: The TSM appends the date and time to the stream capture file name.

The default is 0.

Note: Setting the DateStreamCapture property to 1 prevents the stream capture file from being overwritten.

DelrepClasses string

-delrepclasses string

Use this property to specify the DMS Log Reports that the TSM excludes from its monitoring. For example, trk 101 trk 102 trk 103 instructs the TSM to use the DMS command delrep to exclude the three classes listed from its monitoring.

The default is "" (no configuration is done using the delrep command).

FlushTime integer

-flushtime integer

Use this property to specify number of seconds of silence that the TSM allows after each line read before assuming that an error has occurred and sending the incomplete event to the ObjectServer.

The default is 5.

Note: If this property is set to 0, the TSM does not flush events to the ObjectServer.

HeartbeatInterval integer

-heartbeatinterval integer

Use this property to specify the time (in seconds) that the TSM waits, after receiving data, before sending a Heartbeat String.

The default is 0 (the TSM waits indefinitely).

HeartbeatResponse string

-heartbeatresponse string

Use this property to specify the response the TSM expects to receive from the device. This property is a regular expression, with a maximum of 4096 characters.

The default is "".

HeartbeatString string

-heartbeatstring string

Use this property to specify the command that prompts the switch to give the appropriate heartbeat response.

The default is "".

Note: The user specified using the UserName property must have permissions set to use the command specified using this property.

HeartbeatTimeout integer

-heartbeattimeout integer

Use this property to specify the time interval (in seconds) within which the TSM expects to receive a response from the device.

The default is 0.

Host string

-host string

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

The default is localhost.

HostsFile string

-hostsfile string

Use this property to specify the file that the TSM uses to connect to multiple hosts.

The default is "" (hosts file not used). .

InactivityAlarmTime integer

-inactivityalarmtime integer

Use this property to specify the time (in seconds) the probe waits to receive any messages before sending an inactivity ProbeWatch message to the ObjectServer.

The default is 60.

LogClasses string

-logclasses string

Use this property to specify the DMS Log Classes that the TSM monitors. For example, 0 1 3 5 6 7 13 instructs the TSM to use the DMS command addclass to monitor the seven classes listed.

The default is "" (no configuration is done using the addclass command).

MaxEvents integer

-maxevents integer

Use this property to specify the maximum number of events the TSM attempts to read per connection before moving on to the next connection.

The default is 1.

Note: You can increase this number to increase the event throughput when a large number of events is generated.

MaxStreamCap FileSize 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 (disabled).

Note: If the TSM reads a stream whose size exceeds the remaining allowable space in the file, it creates a new one, thus storing the whole stream in a single file.

NoConnect boolean

-noconnect boolean

Use this property to specify whether the probe bypasses the login process when connecting to the system. Possible values are:

0: The probe does not bypass the login process.

1: The probe bypasses the login process.

If this property is set to 1, you must specify the login details using the ChatinString property.

The default is 0.

NT_ECORE_regexp string

-nt_ecore_regexp string

Use this property to specify the regular expression that the TSM expects to find in the header of ECORE events.

For Netcool/OMNIbus 3.6 and above, the default is ^([A-Z0-9_]+ [A-Z0-9_]+) * (\\*+)? +(\\+)?([A-Z0-9]+) (.*[0-3][0-9]) ([0-2][0-9]: [0-5][0-9]:[0-5][0-9]) ([0-9]+) ([A-Z]+)? (.*)$.

For Netcool/OMNIbus 3.5 and below, the default is ^([A-Z0-9_]+ [A-Z0-9_]+) *(\*+)? + (\+)?([A-Z0-9]+) (.*[0-3][0-9]) ([0-2][0-9]:[0-5][0-9]:[0-5][0-9]) ([0-9]+) ([A-Z]+)? (.*)$.

NT_STD_regexp string

-nt_std_regexp string

Use this property to specify the regular expression that the TSM expects to find in the header of STD events.

For Netcool/OMNIbus 3.6 and above, the default is ^([A-Z0-9_]+)? *(\\*+)? *(\\+)? ([A-Z0-9]+[0-9]+) * ([JFMASOND][AEPUCO][NBRYLGPTVC][0-3 ]? [0-9]) *([0-2][0-9]:[0-5][0-9]: [0-5][0-9]) *([0-9]+) *([A-Z]+ )? * (.*)$.

For Netcool/OMNIbus 3.5 and below, the default is ^([A-Z0-9_]+)? *(\*+)? *(\+)? ([A-Z0-9]+[0-9]+) * ([JFMASOND][AEPUCO][NBRYLGPTVC] [0-3 ]?[0-9]) *([0-2][0-9]:[0-5] [0-9]:[0-5][0-9]) *([0-9]+) * ([A-Z]+ )? *(.*)$.

Password string

-password string

Use this property to specify the password required with the UserName property to log in to the DMS switch.

The default is "".

Port integer

-port integer

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

ReadTimeout integer

-readtimeout integer

Use this property to specify the time (in milliseconds) that the TSM allows to elapse during a data read before assuming that there is nothing to be read.

The default is 100.

ReconnectionInterval integer

-reconnectioninterval integer

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

The default is 0 (TSM uses standard backoff strategy).

ReportClasses string

-reportclasses string

Use this property to specify the class of events that the probe writes to a report file. All events of this class are written to a report file and are not forwarded to the ObjectServer.

The default is "".

ReportDirectory string

-reportdirectory string

Use this property to specify the location of the directory to which the probe writes the report file containing events not sent to the ObjectServer.

The default is $OMNIHOME/log/.

ResponseTimeout integer

-responsetimeout integer

Use this property to specify the time (in seconds) that the TSM waits for a response from the device when logging in or out.

The default is 20.

ResynchCommand string

-resynchcommand string

Use this property to specify the command that the TSM sends to the device to initiate a resynchronization.

The default is "".

Note: This property is not currently implemented.

ResynchInterval integer

-resynchinterval integer

Use this property to specify the time (in seconds) that the TSM waits between resynchronization attempts.

The default is 0 (the TSM waits indefinitely).

Note: This property is not currently implemented.

SCC2_regexp string

-scc2_regexp string

Use this property to specify the regular expression that the TSM expects to find in the header of SCC2 events.

For Netcool/OMNIbus 3.6 and above, the default is ^(\\*[*C]*)? *([0-5][0-9]) ([A-Z0-9]+ [0-9]+) *(\\+)? ([0-9]+) ([A-Z]+) (.*)$.

For Netcool/OMNIbus 3.5 and below, the default is ^(\*[*C]*)? *([0-5][0-9]) ([A-Z0-9]+ [0-9]+) *(\+)? ([0-9]+) ([A-Z]+) (.*)$.

StreamCaptureFile string

-streamcapturefile string

Use this property to specify the first part of the filename that the TSM uses to store the input stream log. The full file path also needs to be specified. The full filename that the TSM uses is as follows:
streamcapturefile_host_port

The default is "".

Note: Omitting this property disables the stream capture feature.

Terminator string

-terminator string

Use this property to specify the regular expression that indicates the end of the message.

The default is ^ $. (the TSM waits indefinitely).

UserDefined string

-userdefined string

Use this property to specify a comma-separated list of user-defined properties. These properties are available from within the rules file.

The default is "".

UserName string

-username string

Use this property to specify the username with which the TSM logs in to the DMS switch.

The default is "".