The ccmcli utility enables you to interactively perform basic administrative tasks on Control-M components using the Control-M Configuration Manager GUI, including the following tasks:
- Starting
- Stopping
- Ignoring
- Recycling
- Viewing details about the component or server
- Removing old alerts
- Deleting the history of job or group definitions
- Deleting Control-M/Agent or remote host component
Usage:
em ccmcli [-u <user> [-p <password>] | -pf <passwordFile>] [-s <Configuration Server Name>] [-t <component Type>] [-n <component Name>] [-h <component Host>] [-cmd <command>]| [-date <YYYYMMDD>] | [-keep_days <number>] | [-force Y|N] | [-node_id <Node ID>] | [-ctlcmd <command>] ]
Parameter Description:
-u Control-M EM Administrator User name
-p Control-M EM Administrator 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
- 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 "-cmd HA" command, you must define the -action flag. Available options are -ha <em_failover|em_fallback|set_as_primary>
-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. This will also remove the "DELETED" Jobs from def_ver_* tables.
-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 node group where the job is submitted.
-ctlcmd A control shell command sent to one of the Control-M/EM components.
-dbg To debug ccmcli command (ex: -dbg 5)
* Switches can be specified in any order.
Additional Information:
- Do not use EM Database Owner account when specifying "-u <user> -p <password>"
- Use the EM user administrator account, which is the same account used to login to Control-M Configuration Manager (CCM)
- Try not to use the same username between EM Server OS install user and the EM user administrator account since the ccmcli command might fail to login.