Agent Utilities

The following table describes AgentClosed command line utilities that you can run on the Agent host.

Utility

Description

start-ag/shut-ag

Enables you to start up and shut down the Agent.

ctmag

Enables you to maintain, view, and modify the Agent configuration parameters.

ctmagcfg

Enables you to configure the Agent.

ctmunixcfg

Enables you to interactively view and modify most of the plug-inClosed configuration parameters on Linux.

ctmwincfg

Enables you to interactively view and modify most of the plug-in configuration parameters on Windows.

ctmagcpk

Enables you to change a key password and apply the new key to job owner credentials for all installed plug-ins that support the AES algorithm.

set_agent_mode

Enables root, non-root, and Sudo modes on Linux.

ag_diag_comm

Verifies the ability of the Agent computer to communicate with the Control-M/Server.

ag_ping

Verifies whether the Control-M/Server is active and connected to the Agent.

_exit

Terminates processes on Windows.

_sleep

Suspends execution for a defined interval of time.

File Watcher (ctmfw)

Detects the successful creation or deletion of a file or a file transfer activity.

Health Check

Collects the environment information, logs, and saves them to a zip or tar.Z file for troubleshooting purposes.

agdbglvl

Enables you to change the Agent debug level.

Agent Toolbox

Analyzes proper functionality and troubleshoots issues on the Agent.

If you have multiple Agents installed on a Windows machine, the first Agent that is installed is the default Agent and is assigned the Agent instance name Default. If you want to run a utility on a different Agent instance that is on this machine, you must run the following command:
<utility_Name> <Parameters> -agent <Agent_Instance_Name>