-u

Control-M/EM user name

-p

Control-M/EM user password

-pf

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

user=username
password=password

-s

The name of the Control-M Configuration Server. It is mandatory to specify this parameter.

-t

The type of component. Valid values are:

• Gateway
• GUI_Server
• GCS
• BIM
• Forecast_Server
• Self_Service_Server
• Web_Server
• CTM_Server
• CTM_Agent

-n

The logical name of the component.

-h

The host on which the component is running.

-cmd

The command you want to run on the agent configuration server or component. Valid values are:

• start
• stop
• ignore
• recycle
• details
• remove_old_alerts
• erase_jobs_history
• delete_agent
• delete_remote_host
• deploy
• HA

If the component type is -t CTM_Agent, only -cmd recycle is supported.

When you specify the -force flag, and the recycle command for a Control-M/Agent, you can force recycling of a Control-M/Agent, even if jobs are running on it or on a remote host computer.

You must specify the -date flag, when you specify the remove_old_alerts command.

You must specify the -node_id flag, when you specify the delete_agent and delete_remote_host commands.

You must specify the Control-M/Server where the Control-M/Agent and Remote Host are defined, when you specify the command type, name , and host for the delete_agent and delete_remote_host commands.

You must specify the -keep_days flag, when you specify the erase_jobs_history command. All jobs above the specified number are deleted.

If you use the HA command on Windows or Linux, you must define the -action flag. Available options are -ha <em_failover|em_fallback|set_as_primary>

Deploy: The following flags must be specified:

• -action <install|transfer|transfer_and_install>
• -agent
• -ctm_server
• -package

  NOTE: If the action is install, you must specify -activity_id. If the action is transfer or transfer and install, you must specify-activity_name.

-date

The date from which alerts must be kept. Alerts older than the specified date are removed. Enter the date in the format YYYYMMDD. Use this parameter when specifying -cmd remove_old_alerts. All alerts received up to and including the specified date are deleted.

-keep_days

The number of days to keep job or group definition history. Use this parameter when specifying -cmd erase_jobs_history. All versions older than the specified number of days will be deleted.

-force

The command to force the component to recycle. Valid values are:

• Y
• N

When -cmd recycle is specified for an agent (-t CTM_Agent), you can specify the -force to force Control-M/Agent to recycle even if jobs are running on the agent or remote host computer through the agent.

-node_id

The name of a Control-M/Agent computer, remote host computer, or host group where the job is submitted.

-ctlcmd

A control shell command sent to one of the Control‑M/EM components.