Diagnostics Service

The diagnostics service allows you to collect diagnostic data for Customer Support. This enables you to identify and troubleshoot problems or areas of inefficiency in the Control-M production environment and communicate that information to BMC Customer Support.

config server:agent:diagnostics::collect

The config server:agent:diagnostics::collect command collects Agent diagnostic data for Customer Support.

This command returns a poll identifier to poll the diagnostic data, which is collected from the Agent, with the config diagnostics:poll::diagnostics command.

  • CLI

  • REST

ctm config server:agent:diagnostics::collect <server> <agent>

The following example shows the REST API syntax for the config server:agent:diagnostics::collect command in cURL:

Copy 
server=Control-M_Server1
agent=Control-M_Agent1
AuthHeader="x-api-key: $token"
# AuthHeader="Authorization: Bearer $token"  #for a session token

curl -H "$AuthHeader" -X POST "$endpoint/config/server/$server/agent/$agent/diagnostics"

To select the AuthHeader value ("Authorization: Bearer $token" or "x-api-key: $token"), see Authentication Tokens.

The following table describes the config server:agent:diagnostics::collect command parameters.

Parameter

Description

<server>

Defines the name of the Control-M/Server.

<agent>

Defines the name of the Agent with the diagnostic data.

config diagnostics:poll::diagnostics

The config diagnostics:poll::diagnostics command polls the results of the diagnostic data collected from the Agent, based on the polling ID returned by the data collection request. This is an asynchronous command and you might need to run it several times until you receive a final response with a 200 HTTP response code.

  • CLI

  • REST

ctm config diagnostics:poll::diagnostics <pollingId>

The following example shows the REST API syntax for the config diagnostics:poll::diagnostics command in cURL:

Copy 
agent=Control-M_Agent1
AuthHeader="x-api-key: $token"
# AuthHeader="Authorization: Bearer $token"  #for a session token

curl -H "$AuthHeader" -X POST "$endpoint/config/diagnostics/poll/{pollingId}"

To select the AuthHeader value ("Authorization: Bearer $token" or "x-api-key: $token"), see Authentication Tokens.

Where

<pollingId> is the identifier to poll the diagnostic data, which is collected from the Agent.

Response

The response contains a path to a file with the diagnostic information.

The following shows an example of a successful response to the config diagnostics:poll::diagnostics <pollingId> command:

Copy 
{
  "message" : "Send the <path/to/diagnostics/data/file> file to BMC support.",
  "returnCode" : 200
}