ctm_agstat
The ctm_agstat utility enables you to list or update the status of an Agent. For more information, see communication status of Agents and remote hosts in Component management.
Running the ctm_agstat Utility
This procedure describes how to run the ctm_agstat utility, which enables you to list or update the status of an Agent.
Begin
-
Do one of the following:
-
UNIX: Log in to a Control-M/Server account.
-
Windows: Open a command prompt window where Control-M/Server is installed.
-
-
Type the following command:
ctm_agstat
{ -LIST <AgentName> | -UPDATE <AgentName> {AVAILABLE | DISABLED} }
[ -DEBUG <debug level 1-5> ]
[ -QUIET ]
ctm_agstat Parameters
The following table describes the parameters of the ctm_agstat utility:
Parameter |
Description |
---|---|
-LIST |
Lists the current status of the specified Agent. This parameter is mandatory if the -UPDATE parameter is not specified. |
-UPDATE |
Changes the status of the specified Agent to the specified status. This parameter is mandatory if the -LIST parameter is not specified The permissions of the AGSTAT directory must be modified to allow access to users who will run the ctm_agstat utility with the -UPDATE parameter.
|
-DEBUG <debug level> |
Sets the required diagnostic level. Valid values: 0 - 5 |
-QUIET |
Indicates that the utility runs without displaying output messages. |
ctm_agstat Examples
The following are examples of the ctm_agstat utility commands:
-
To display the current status of Agent CMAgent, type:
ctm_agstat -LIST CMAgent
-
To change the status of Agent CMAgent to DISABLED, type:
ctm_agstat -UPDATE CMAgent DISABLED