Agent Troubleshooting Utilities

The following Agent utilities describe how to troubleshoot the Agent if there are issues.

ag_diag_comm

The Agent includes a diagnostic program that checks parameters and environmental conditions relevant to communication between the Agent and server computers. This program is typically used at the request of Technical Support to determine the cause of a communication problem.

Running the ag_diag_comm Utility

This procedure describes how to run the ag_diag_comm utility, which enables you to generate a diagnostic report on the Agent communication.

Begin

Navigate to the directory where the Agent is installed.

Enter the following command:

ag_diag_comm

The Agent Communication Diagnostic Report appears.

Copy

Control-M/Agent Communication Diagnostic Report
-----------------------------------------------

Agent User Name : agbebes
Agent Directory : /home/agbebes/ctm
Agent Platform Architecture : Linux
Agent Version : 9.0.20.080
Agent Host Name : vl-tlv-ctm-dv1k.bmc.com
Logical Agent Name : vl-tlv-ctm-dv1k.bmc.com-agbebes
Server-to-Agent Queue : https://sqs.us-west-2.amazonaws.com/075123970104/abebes-15569_s2a_732e999f-7274-44a3-b28d-a4be05903ae0.fifo
Agent-to-Server Queue : https://sqs.us-west-2.amazonaws.com/075123970104/abebes-15569_a2s_38a1de05-6aae-4f20-b56e-54416aab6839.fifo
Signaling Queue : https://sqs.us-west-2.amazonaws.com/075123970104/abebes-15569_signalingQueue
Server-Agent Protocol Version : 13
Server-Agent Comm. Protocol : HTTPS
Agent Ping to Control-M/Server : Succeeded

Agent processes status
======================
Java services : ["ar","onboarding","housekeeping"] on port 38029
Agent Listener : Running as agbebes (7907)
Agent Tracker : Running as agbebes (8023)
Agent Tracker-Worker : Running as agbebes (8025)

If the user is not the Administrator, the ag_diag_comm command shows partial details.

ag_ping

The ag_ping utility verifies whether the Server is connected to the Agent computer.

The utility attempts to communicate with the Server and indicates whether the attempt succeeded or failed.

If the attempt succeeds, the following message appears:

Output:

Server is alive.

Result: Success.

_exit

The _exit utility terminates processes on Windows. The _exit utility is similar to the exit built-in shell function in Linux.

Running the _exit Utility

This procedure describes how to run the _exit utility.

Begin

Create an OS job as command, as described in Creating a Job.
In the Command field, type the following:

_exit <exitCode>

The <exitCode> variable is any whole integer number n. Default: 0

The job output shows %errorlevel% = <exitCode>.

Define _exit 0 to cause the job to end with %errorlevel% 0.

Define _exit 1 in a script to cause the job to end with %errorlevel% 1.

_sleep

The sleep command suspends execution for a defined interval of time. The _sleep utility is similar to the sleep built-in shell function in Linux.

Running the _sleep Utility

This procedure describes how to run the _sleep utility on Windows.

Begin

Create an OS job as command, as described in Creating a Job.
In the Command field, type the following:

_sleep <seconds>

The <seconds> variable is the number of seconds the execution is suspended.

start-ag/shut-ag

The start-ag and shut-ag utilities start up and shut down the Agent.

Starting Up the Agent

This procedure describes how to start up the Agent.

Begin

Do one of the following:
- To start the Agent on Linux, run the following command:
  
  start-ag
  - To specify a user, add -u <Agent_User>.
  - To start a specific Agent process, add -p <process>.
  - To start all the Agent processes, add -p all.
- To start the Agent on Windows, do the following:
  1. Run the following command:
    services.msc
  2. Right click the Control-M/Agent service and click Start.
    The Agent starts up.

Shutting Down the Agent

This procedure describes how to shut down the Agent.

Begin

Do one of the following:
- Linux: To shut down the Agent on Linux, run the following command:
  
  shut-ag
  - To specify a user, add -u <Agent_User>.
  - To shut down a specific Agent process, add -p <process>.
  - To shut down all the Agent processes, add -p all.
- Windows: To shut down the Agent on Windows, do the following:
  1. Run the following command:
    services.msc
  2. Right click the Control-M/Agent service and click Stop.
    The Agent shuts down.

agdbglvl

The agdbglvl utility enables you to change the Agent debug level in the log.

The log level valid values range from 0 to 5, where 0 indicates no diagnostic activity, and 5 indicates the highest level of diagnostic functionality.

The agdbglvl command is as follows:

Linux: agdbglvl <log level>
Windows: agdbglvl -agent <instanceName> <log level>