ctmshout parameters

The following table lists the ctmshout utility parameters:

Parameter

Description

<username>

User ID that should receive the message. DEST and USER can be specified in the same ctmshout command.

<destinationName>

Logical destination device name or a valid destination name in the Shout Destination folder. DEST and USER can be specified in the same ctmshout command.

<message>

Free text to be sent to the destination (1 - 255 characters). If the text is more than one word, it must be enclosed in quotation marks.

<orderID>

Order ID of a job, as displayed in the Job Details window in Control‑M/EM. Associates the message with a specific job in the Active Network.

<hostID>

Host ID of the agent computer. Used for messages whose destination is either a user in the data center or a user defined in the Shout Destination folder.

NOTE: If ‑ORDERID is also specified, this Host_ID overrides the Host ID specified in the job with that Order ID.

<severityLevel>

One letter character indicating the urgency of the message. Valid values:

  • R – Regular (Default)
  • U – Urgent
  • V – Very urgent

<fullPathFileName>

Name and full path of a file containing the utility parameters. In this file, each parameter and its values (if any) are on a separate line with the same syntax they would have on the command line. The -input_file parameter enables you to:

  • Prepare and save files of utility parameters that can be reused.
  • Specify utility input longer than the number of characters allowed in the command line.

    -input_file~<controlm_owner>/ctm_server/data/ctmshout_parms.txt

Parent Topic

ctmshout