Common properties and command-line options

This section describes the properties and command-line options common to all monitors. Monitor specific properties and command-line options are described in the individual monitor sections.

In Table 1 the default property parameters are underlined where applicable.

Table 1. Common properties and command-line options

Property name

Property parameter

Command-line option

Description

AddRoute

0|1

-addroute

Creates a route from the IP address of the network interface used by the monitor to the IP address of the monitored host.

  • 0 - disabled
  • 1 - enabled (monitor uses the route specified in the profile element, and not over another network interface).
Note: This property is not supported on AIX® and HP-UX platforms.

BridgeIPAddress

not applicable

not applicable

Specifies the IP address of the Databridge. This property is not configurable; the Databridge is always on the local host.

BridgePort

integer

-bridgeport

Port number used by the Databridge. Set this property to the same value as the Databridge SocketPort property.

Default: 9510

BridgeSSLAuthenticatePeer 0|1 -bridgesslauthenticatepeer

If you want to configure SSL authentication between the monitor and bridge, or between the bridge and the agent, set BridgeSSLAuthenticatePeer to 1 and restart the bridge. This action authenticates the certificates from the server. Certificates are stored in the BridgeSSLTrustStore.

  • 0 - disabled
  • 1 - enabled
BridgeSSLCertificateFile string -bridgesslcertificatefile Specifies the path and filename of the digital Bridge SSL certificate.

Default: $ISMHOME/certificates/monitorCert.pem

BridgeSSLCipherSet string -bridgesslcipherset

Specifies a CipherSet. If you update this value, use the Cipher syntax defined in the OpenSSL documentation.

Restriction: Set the same value on the Internet service monitoring agent, all monitors, and the Databridge.

Default: RC4:3DES:DES:+EXP

BridgeSSLDisableSSLv2 0|1 -bridgessldisablesslv2
Determines which types of sockets are accepted.
  • If set to 0, both SSLv2 and SSLv3 are accepted
  • If set to 1, sockets are opened in SSLv3 only
Restriction: Set the same value on the Internet service monitoring agent, all monitors, and the Databridge.
BridgeSSLEncryption 0|1 -bridgesslencryption Enables Bridge SSL encryption. Set this property to the same value as the corresponding Databridge property.
  • 0 - disabled
  • 1 - enabled
Note: Set the same value for all monitors.
BridgeSSLKeyFile string -bridgesslkeyfile The path and the filename of the Bridge SSL private key file.

Default: $ISMHOME/certificates/monitorKey.pem

BridgeSSLKeyPassword string -bridgesslkeypassword The password used to encrypt the Bridge SSL private key.

Default: tivoli

BridgeSSLTruststore string -bridgessltruststore The path and file name of the Trusted certificate file for authentication. This is only required when using the BridgeSSLAuthenticatePeer setting.

If you want to configure SSL authentication between the monitor and bridge, or between the bridge and the agent, set BridgeSSLAuthenticatePeer to 1 and restart the bridge. This action authenticates the certificates from the server. You can store certificates in both the SSLTrustStoreFile and the SSLTrustStorePath.

Defaults:
  • SSLTrustStoreFile, $ISMHOME/certificates/trust.pem
  • SSLTrustStorePath, $ISMHOME/certificates/
To add new certificates, complete one of the following steps:
  • Add a certificate to the end of the list in the SSLTrustStoreFile text file
  • Add a new certificate to the SSLTrustStorePath directory, and run the OpenSSL c_rehash certificate_dir command to hash the certificates

BridgeTimeout

integer

-bridgetimeout

Time, in seconds, that the monitor waits for a response from the Databridge.

ConfigFile

string

-configfile

Use to point to a monitor configuration file.

Default: blank (empty string)

ConfigurationCheckInterval

integer

-configurationcheckinterval

The interval (in seconds) at which the monitor checks for changes to the profile.

Default: 1

Datalog

0|1

-nodatalog -datalog

Forces the monitor to log performance data in a datalog file. The performance data is logged in:

$ISMHOME/datalogs/userprofile
  • 0 - disabled
  • 1 - enabled

DatalogFormat

string

-datalogformat

Defines the format of the datalog file. The parameter is a space-separated list of elements, the values of which should be stored in the datalog file. For each poll result written to the datalog file, the current time ($time) and the time taken ($totalTime) are logged, followed by all the elements defined in this property.

DatalogNameFormat

string

-datalognameformat

Format of the datalog filename.

Domain

string

-domain

Specifies the domain name of the host running the monitor. If this property is not set, the monitor attempts to guess the domain name using the NIS and DNS configurations

DumpProps

not applicable

-dumpprops

Displays a list of all properties for a monitor.

FullHostInfo

0|1

-fullhostinfo

Specifies whether to map the $host element to an IP address element $hostIP (if $host is a DNS name) or to a DNS name element (if $host is an IP address).

0 - disabled

1 - enabled

Note: This is not available in the TRANSX monitor.

GroupID

string

-groupid

The group ID that the monitor should be run as.

Help

0|1

-help

Displays the help for command-line options without running the monitor.

  • 0 - disabled
  • 1 - enabled

IdentifierChecksumFields

string

-identifierchecksumfields

Deprecated.

IgnoreUnmatchedDVC

0|1

-ignoreunmatcheddvc

If a particular service level classification is not matched (element not created by the monitor) then ignore that element in the service level calculation.

Tip: In earlier releases of Internet Service Monitoring, service level classifications were called Discrete Value Classifications (DVCs).
  • 0 - disabled
  • 1 - enabled

IpAddress

string

-ipaddress

Specifies the IP address of the network interface that the monitor uses during tests.

If this property is not set, the monitor attempts to determine the host machine's IP address using a host name lookup. This attempt may fail if the host machine has more than one network interface.

Manager

string

-manager

Specifies the name of the management application, which is used in ObjectServer event de-duplication.

MaxCCA

integer

-maxcca

Sets the maximum number of concurrent connections that the monitor can have at any one time. Note that if you set this value too high, you could severely affect the performance of the monitor.

This property is not available for the ICMP monitor.

Default: 10

MaxLogFileSize

integer

-maxlogfilesize

The maximum size (in bytes) of the log file.

Default: 1048576

MessageLevel

string

-messagelevel

The lowest level of messages to be sent to the message log. Values, in ascending order of severity are: debug, info, warn, error, and fatal.

Default: warn

MessageLog

string

-messagelog

Location of the log file.

Default: $ISMHOME/log/monitor.log

MinPoll

integer

-minpoll

Defines the minimum polling interval allowed. If any of the monitor configuration files have a poll interval set below this value, the value in the configuration file is overridden.

Default: 60

MsgDailyLog

integer

-msgdailylog

Enables generation of a daily log file.

Default: 0 - Daily log disabled

MsgTimeLog

string

-msgtimelog

Specifies the time (in 24-hour format HHMM) after which the monitor generates a daily log, if MsgDailyLog is enabled.

Default: 0000 - 12:00am

Name

string

-name

The name of the monitor. Setting this property resets the PropsFile, RulesFile and MessageLog properties to their defaults.

NewProfileCheckMultiple

integer

-newprofilecheckmultiple

Multiple that indicates how often the monitor checks for new configuration files when checking for profile changes.

Default: 10

NoRecover

integer

-norecover

Instructs the monitor not to recover the store and forward file.

Default: 0 - recovery is not suppressed

Pause

integer

-pause

Sets the interval (in seconds) at which a monitor spawns threads. Setting this property to higher values, such as 100 or more, forces the monitor to spawn threads at a slower rate. Increasing the value is generally only necessary on slow systems.

This property is not supported on the ICMP monitor.

Default: 50

PreviousFields

string

-previousfields

Elements specified by this property (using the form "<element>, <element>, …") are stored for one poll and prefixed with the string previous.

Profile

string

-profile

The name of the customer profile, or profiles to use. The string can be a single profile name, a space separated list of profile names, or *, which forces the monitor to use all available profiles.

Default: *

ProfileUpdateTimeout

integer

-profileupdatetimeout

The number of milliseconds that a profile file must remain static before it can be read by a monitor and updated. The allowable range is 1-20000 milliseconds.

Default: 100

PropsFile

string

-propsfile

The name of the properties file.

Default: $ISMHOME/etc/props/monitor.props

QFile

string

-qfile

Sets the name of the store and forward file.

Default: $ISMHOME/var/monitor.saf.

QSize

integer

-qsize

Sets the reserved size (in bytes) of the store and forward file.

Default: 10240000

UserID

string

-userid

The user ID that the monitor should be run as.

Note: Do not use this property with the DHCP monitor.

Version

not applicable

-version

Prints the monitor version without running the monitor.