Agent Health Check

The Health Check utility (HCU) collects the environment information and logs, and puts them into a *.zip ((Windows only) ) or *.tar.Z (Linux only) file for troubleshooting purposes. This includes information about the Agent host such as the operating system version, patch level, kernel setting, memory consumption, list of running processes, operating system name, error logs, hardware configuration, and network configuration. This program is used at the request of Technical Support to determine the cause of a problem. The Health Check utility (HCU) creates a log file that specifies the processes that ran and the information that was written to the package file. The contents of the log file indicate what proprietary information is included in the package file.

The HCU utility writes log files to the following directories:

  • Log: <AGENT_HOME>/ctm/proclog/ctma_data_collector_<TIME_STAMP>_<OS_TYPE>_<HOSTNAME>_display.log

  • HCU Package:

    • Windows: <AGENT_HOME>/hcu_package/ctma_data_<TIME_STAMP>_<OS_TYPE>_<HOSTNAME>.zip

    • Linux: ctma_data_<TIME_STAMP>_<OS_TYPE>_<HOSTNAME>.tar.Z

Running the Agent Health Check UtilityLink copied to clipboard

This procedure describes how to run the Health Check utility with default parameters, which enables you to collect and package the data generally required by BMC Support.

Begin

  1. Navigate to the following directory:

    • Windows: <Agent_Home>\exe

    • Linux: $CONTROLM/exe

  2. Run the following command:

    <Full_Pathname>ctma_data_collector

  3. To view the entire list of actions performed by the utility, see the log file right after executing the utility.

    C:\Program Files\BMC Software\Control-M SaaS Agent\Default\proclog\ctm_data_collector_20201103_110037_MSWin32_vw-tlv-ctm-dvl2_display.log

Agent Health Check Utility ParametersLink copied to clipboard

The following table describes the Health Check utility parameters.

Parameter

Description

Components

(Optional) Products and applications that the utility can gather data.

Category (OS)

Defines the Operating System related physical resource.

This information includes the following:

  • Operating system version

  • Hardware configuration

  • Software, hotfixes, and patches installed

  • Environment variables and files

  • System resource limits

  • Kernel parameters

  • Swap space

  • System and application logs

  • Scheduled tasks

  • Startup files

  • File system information

  • (Windows only) *.ini files

  • Resource consumption

  • List of running processes

  • Network settings

  • Locate and timezone information

Profiles

(Optional) A Profile is a predefined combination of Components and Categories.

If you specify one or more Profiles, do not specify Components or Categories.

runConfiguration

(Optional) Determines one or more of the following:

  • -Simulate: Simulates execution of a Health Check utility. This allows the user to verify that specified parameter values are appropriate.

  • -Days: Determines the maximum number of days in the past for which the utility gathers the information. This option only affects log files relevant to BMC Software components.

    Default: 2

  • -Max_size: Defines the maximum size (in MB) of the compressed file that is created by the Health Check utility.

    Default: 300

  • Trace: Run a trace on the Health Check utility run. This generates the following log file:

    ctm_data_collector_<YYYYMMDD>_<HHMMSS>_<PLATFORM_TYPE>_<HOSTNAME>.log

  • -Verbose: Outputs the utility processes to your display. By default, only processed categories are displayed.

  • -Help or -h: Displays an explanation of how to use the utility.

  • -Batch: Runs in batch mode.