cli parameters

The following table lists the cli utility parameters:

Parameter

Description

<emUser>

Control-M for Databases user name.

<emPass>

Control-M for Databases user password.

<passwordFile>

Flat file containing an unencrypted user name and password on separate lines in the format:

user=<emUser>
password=<emPass>

<hostName>

Host name of the workstation running Control-M for Databases Server.

If you need to address a GUI server and multiple GUI servers exist, set this parameter to the logical name of the relevant GUI server.

<timeout>

Time, in seconds, that the utility waits for a response. Timeout is used to override the default waiting period (120 seconds).

Do not use timeout with commands that do not return a response (-JOB_DELETE and ‑MEM_DELETE).

-DDMM

If specified, reverses the Odate format, as described below.

-BY_FORCE

Forces the specified folder or calendar. Use this option during upload only.

-ACTION_REASON

A note saved in the audit report explaining the purpose for performing the action.

-ACTION_NOTE

A note saved in the audit report justifying the performance of the action.

<cmd>

The syntax for additional commands that are available for specifying with the cli utility are shown below.

-JOB_ORDER

<CTM_name> <folderName> <job_name> <Odate> <Wait_Odate>[<With_Hold>] [<library>]

-JOB_FORCE

<CTM_name> <folderName> <job_name> <Odate><Wait_Odate> [<With_Hold>] [<library>]

-JOB_ORDER_INTO

<CTM_name> <folderName> <job_name> <folder> [<Duplication>] <Odate><Wait_Odate> [<With_Hold>] [<library>]

-JOB_FORCE_INTO

<CTM_name> <folderName> <job_name> <folder> [<Duplication>] <Odate> <Wait_Odate> [<With_Hold>] [<library>]

-SUB_FOLDER_FORCE_INTO

<CTM_name> <sub-folderName> <folder> [<Duplication>] <Odate> <Wait_Odate> [<With_Hold>] [<library>]

-FOLDER_ORDER

<CTM_name> <folderName> <Odate> <Wait_Odate> [<With_Hold>][UNIQUE_FLOW] [<library>]

-FOLDER_FORCE

<CTM_name> <folderName> <Odate> <Wait_Odate>[<With_Hold>][UNIQUE_FLOW] [<library>]

-FOLDER_UPLOAD

<CTM_name> <folderName> [<library>]

-FOLDER_
DOWNLOAD

<CTM_name> <folderName> [<library>]

-CAL_UPLOAD

<CTM_name> <calendar_name>

-CAL_DOWNLOAD

<CTM_name> <calendar_name>

-SUB_FOLDER_DELETE

<CTM_name> <sub_folderName>

-JOB_DELETE

<CTM_name> <folderName> <job_name> ALL|NONE|NUMBER

-MEM_DELETE

<CTM_name> <folderName> <mem_name> ALL|NONE|NUMBER [<library>]

 

For more information on the sub elements, see cli additional parameters.

Parent Topic

cli utility