Watchdog and lifecheck parameters

The following table lists the General Watchdog Process parameters.

Parameter

Description

CTM_PRM_KPA_ACTIVE

Whether the Heartbeat monitor operates in active or passive mode.

Valid Values: Y (for active) or N (for passive)

Default: Y

Refresh Type: Recycle

CTM_PRM_KPA_BETWEEN_MSGS

Time in seconds between heartbeat checks.

Valid Values: 1–2^31 (integer)

Default: 300

Refresh Type: Recycle

CTM_PRM_KPA_ROUNDTRIP_TIMEOUT

Time in seconds to wait for a confirmation from Control‑M/EM.

If confirmation does not arrive, a timeout is generated and the connection is severed.

Valid Values: any integer

Default: 300

Refresh Type: Recycle

WD_ALIVE_MSG

Indicates message to be sent in response to successful heartbeat checks.

Valid values: 1024 characters

Default: ""

Refresh Type: Recycle

WD_CTO_HOSTNAME

Host name or IP address of the computer running CONTROL-O/Server. If this parameter is specified, the Watchdog process sends all error messages to the CONTROL-O/Server Central Message window.

Valid values:Up to 255 characters.

Refresh Type:Recycle

WD_CTO_TIMEOUT

Maximum time (in second) to send messages to CONTROL-O/Server before terminating the communication.

Valid values: 1-10

Default: 10 seconds

How / where to set:

Refresh Type: Recycle

WD_ERROR_HANDLER_SCRIPT_FILE

Full path name of a user defined script called by the Watchdog process as an error handler. The error messages are included as arguments to the script.

Valid values: 1024 characters

Default: "" (In the shipped config.dat, the default is overridden by ./scripts/UE_handler.)

Refresh Type: Recycle

WD_ERROR_HANDLES_TIMEOUT

Maximum time for the Watchdog facility to wait for the user-defined script to run.

Valid values: 5–2^31

Default: 5 (In the shipped config.dat, this is overridden by the value 10.)

Refresh Type: Recycle

WD_HEARTBEAT_INTERVAL

The Watchdog process checks Control‑M/Server processes by sending a message. If this parameter is set to 5, the Watchdog process sends a message to each of the primary Control‑M/Server processes every 5th interval and awaits a response.

Valid values: 1–2^31

Default: 5 (In the shipped config.dat, this is overridden by the value 1.)

Refresh Type: Recycle

WD_HEARTBEAT_LIMIT

Maximum time (in seconds) to wait for a response from each of the Control‑M/Server processes, after issuing a Heartbeat check, before sending a message to the error handlers.

Valid values: 1–2^31

Default: 360

Refresh Type: Recycle

WD_INTERVAL

Basic time unit interval, in minutes. When the value in either the WD_CTMEXIT_#_INTERVAL parameter or the WD_USEREXIT_#_INTERVAL parameter is multiplied by the value in this parameter, the resulting value is the number of minutes that must pass before reinvoking the exit script.

For example, if the value of this parameter is 6 (minutes), and the value of the WD_CTMEXIT_1_INTERVAL parameter is 20, the script for system exit 1 will run once every 120 minutes (20 x 6 minutes).

Valid values: 1–2^31

Default: 5 (In the shipped config.dat, this is overridden by the value 6.)

Refresh Type: Recycle

Parent Topic

Watchdog process parameters