How do we collect and attach system data and diagnostic logs for use when opening a new Control-M support case?

There are five commands to run on five different components that collect the majority of the information that we might need in most technical support cases.

From command line:

1. Control-M/Enterprise Manager:
    Please run the following command on the server that runs the Control-M/Enterprise Manager server to collect basic Control-M/EM and OS information:

        em_data_collector -U <em_dbo_user> -P <em_dbo_pwd>
        File location: <EM_HOME>/hcu_package

Video Languages Available

English

Starting with Control-M version 9.0.20 the data collector utility support -include and -exclude parameters for Category Type. -Include will collect only categories specified and -Exclude will collect all but the categories specified. If the Database is not available the data collector utility will skip all database checks and continue with all the others.

2. Control-M/Enterprise Manager Client:

       emclient_data_collector
        NOTE: You need to run this from the client_health_check\bin directory
        File location:<EM_HOME>\client_health_check

Video Languages Available

English

3. Control-M/Server for UNIX and Microsoft Windows:
    Please run the following command on the Control-M/Server to collect basic Control-M/Server and OS information:

        ctms_data_collector -U <ctm_dbo_user> -P <ctm_dbo_pwd> 
        File location: <SERVER_HOME>/health_check/hcu_package

Video Languages Available

English

Español

Japanese

Starting with Control-M version 9.0.20 the data collector utility support -include and -exclude parameters for Category Type. -Include will collect only categories specified and -Exclude will collect all but the categories specified. If the Database is not available the data collector utility will skip all database checks and continue with all the others.

4. Control-M/Agent for UNIX and Microsoft Windows  and Control-M Application plugins
   Please run the Control-M/Agent Health Check Utility (data collector), which collects your environment information and logs and puts them into a file.
   You will need to logon to the Control-M/Agent and run the command:

        ctma_data_collector
        File location: <AGENT_HOME>/hcu_package

•    If there are multiple instances of the Control-M/agent installed on a windows machine, it is important to specify which instance you want to collect data on: 
  • ctma_data_collector -D AG -C LOG -D CMAFT -instance INSTANCE_NAME
  •  Where:
    • INSTANCE_NAME is the instance name of the Control-M/Agent
    • -D can use any of these values
      • CMOAP CMDatabase CMOEBS CMHadoop CMSAP CMBPI CMCOGNOS CMBO APPPACK CMAI CMDATASTAGE CMCLOUD CMAFT CMBackup CMINF AG CMORACLE_BI
    • -C an use any of these values
      • OS UTL LOG MSR_AG CNF BSS
• If you are running ctma_data_collector from a remote machine and don't want to be prompted for a Yes answer (Do you want to continue?)
  • ctma_data_collector -batch

NOTE:
Supported from version 9.0.19 and higher:
ctma_data_collector -F EXD_BSS   (EXcluDe Backup, Sysout, Status folders)

Video Languages Available

English

Español

Japanese

 
5. Control-M/Archive
  Please run the following command on the server that runs the Control-M/ Archive  server to collect   information:

      arc_data_collector
       File location: <EM_HOME>/archive/health_check/hcu_package

 From Configuration Manager:

Right click at the Control-M product from  Configuration manager --> Select Diagnostics Data

Possibility to modify the network location for the saved file from the advance option.
See article 000172498 for information how to send the file(s) to the Support team.

Each of these *_data_collector commands will create a single file.
Depending on the nature of the case and the specific issue being faced, the technical support analyst may also request that certain components be placed into debug mode and for further logs to be collected while in debug mode to provide additional detail for examination by developers.