CLI parameters

The following table describes the parameters for defining a Control-M Report job in the CLI through the Control-M Workload Automation API.

Parameter

Description

Name

Defines the name of the report you want to order.

Format

(Optional) Specifies the output format.

Values:

  • PDF
  • CSV

NOTE: By default, the output format is in CSV. Use this parameter if you want to change to PDF, otherwise you can ignore.

EXAMPLE: For CSV output type the following:

ctm reporting report::get Alerts1 -o c:\temp\alerts.pdf

-o

(Optional) Specifies the full file name of the output file (which is overwritten if previously existed).

EXAMPLE:

If you want the output to be in the D:\alerts directory for alerts PDF, the output file path is D:\alerts.pdf

NOTE: If you do not want the output to be placed in a directory, do not type -o and the path. The output is generated to a URL.

EXAMPLE: ctm reporting report::get Alerts1 format pdf

Parent Topic

Control-M Reports job definition