ctl Gateway parameters

The following table describes the ctl parameters specific to the Gateway.

Parameter

Description

RETRIVE_USERDAILYORDER_ METHOD

Directs a request to Control-M for z/OS for updated Order method information to be sent to the Control‑M/EM database.

-C Gateway

Indicates that the command is directed to the gateway. The gateway mediates between Control-M/EM components and the Control‑M installation.

-dc

Name of a data center. This name identifies the gateway to which ctl is sending a command or message. This parameter is used when a query or command is directed to a specific gateway (as specified by the -C parameter). -dc cannot be used with -all.

-all

Directs a query or command to all components of the gateway (as specified by the -C parameter).
-all cannot be used with -dc.

-cmd

Indicates a command to be performed by the gateway.

-cmd cannot be used with -reg.

dwl

Forces a new download from a Control‑M installation.

The following -cmd values are used for diagnostics and debugging, as described in Control-M diagnostics.

Diagnostic and non-diagnostic commands can be specified on the same ctl command line.

change_file

Closes the current log and diag files and creates new files.

DIAG [on|off]

Start and stop DIAG. Valid values:

  • on – enable diag facility
  • off – disable diag facility

no_dbg

Stops all debug printing.

db#

Debug level for database operations. Range: 0 - 9
0 turns off debugging.

gui +| –

Starts or stops a debug trace for the GUI.

host +| –

Starts or stops output of host debug messages.

trunc +| –

Starts or stops truncating messages. Only the message header and one row of data remain after truncation.

alive +| –

Starts or stops debugging of "keep alive" messages.

job +| –

Starts or stops dumping job messages. During a debug trace, job+ displays messages on the screen about active job downloads, active job updates, and Folder uploads. This option can also be set by specifying the trace_job_message [on | off] parameter at the command prompt.

dwl_debug +| –

Starts or stops a debug trace for the download procedure.

hostlink +| –

Starts or stops a debug trace for the host link.

guilink +| –

Starts or stops a debug trace for the GUI link.

show_jcl

Shows active JCL.

-cmdstr

Specifies a text string to be sent to the gateway. If the text string contains spaces or tabs, it must be enclosed with double quotation marks (" ").

-cmdstr cannot be used with -reg or -cmd.

Valid values include:

DIAG [ on | off ]

(either enable or disable the diagnostic facility)

DIAGL <context> <level>
[ <buffer level>]

(sets the diagnostic level)

DIAGSTACKS [ on | print ]

(enables the diagnostic stacks option, or prints the details of the current stacks)

TRACE_CLIENT <on|off>

(set GTW-Clients trace either on or off)

TRACE_CTM <on|off>

(set GTW-CTM trace either on or off)

TRACE_DB
<0 - 8>

(set database trace level)

TRACE_KLIVE <on|off>

(set keep alive trace either on or off)

TRACE_LINK_
CLIENT <on|off>

(set GTW-Clients link level trace either on or off)

TRACE_LINK_
CTM <on|off>

(set GTW-CTM link level trace either on or off)

TRACE_DISABLE_ALL

(turns off trace options when selected)

TRACE_SNMP <on|off>

(set trace for SNMP traps either on or off)

TRACE_TRUNC <on|off>

(set truncate trace messages either on or off)

TRACE_TRUNC_INFO <on|off>

(set truncate trace information messages either on or off)

TRACE_JOB_
MESSAGE <on|off>

(set job message trace either on or off)

TRACE_LEVEL_
REPORT

(displays the status of the trace)

The ‑cmdstr parameter is used for diagnostic purposes only. For more information about the ‑cmdstr parameter, see System configuration.

The ctl utility can be run from the Control Shell. For more information, see To perform commands using the Control Shell section in ctl.

Parent Topic

Sending requests to the Gateway using the ctl utility