Healthcheck program

You can use the Healthcheck program to collect consolidated data about your TADDM environment for IBM® Support.

Run the Healthcheck program from the $COLLATION_HOME/bin directory.

Command syntax

healthcheck -u user -p password [format] [action]

Parameters

-u user

The TADDM user name. The default value is administrator.

-p password

The TADDM user password. The default value is collation.

-h

Prints a help message.

-v

Helps to filter the logs. You can filter the logs based on the duration as follows:

Single year – Skips displaying the data for a specified year.
Multiple Years – Skips displaying the data for the specified number of years.
Single Date – Skips displaying the data for a specified date.
Date Range – Skips displaying the data between specified from and to date range.

Note: This is applicable only for checkDiskFailures module.

format

Specifies the format of the output. You can specify none or one of the following options:

-c, –csv: Outputs information in CSV format, which can be used for scripting.
–moswos column_list: Outputs only the columns you specify in the list of comma-separated column names. If you use the -moswos option, you must also specify one module when running the Healthcheck program.

action

Specifies how the Healthcheck program is run. You can specify none or one of the following options:

-l list: Displays all the available modules.
module_name: The module on which the Healthcheck program is run. If a module is not specified, then the Healthcheck program is run on all modules.
-g group: Runs the Healthcheck program on all modules in the specified group.

Valid groups and modules

Table 1 lists the valid groups and modules with which you can run the Healthcheck program.

Table 1. Valid groups and modules
Group	Module name	Module description
config	checkTADDMInfo	This module displays information about TADDM.
config	checkTaddmAnchors	This module displays information about the TADDM anchor servers.
config	checkTaddmDNS	This module displays information about the TADDM server DNS configuration.
config	checkTaddmGateways	This module displays information about the TADDM gateways.
config	checkTaddmMode	This module displays information about the TADDM mode.
config	checkTaddmOS	This module displays information about the TADDM server.
config	checkTaddmScopes	This module displays information about the TADDM scopes.
database	checkDBIndexes	This module validates the indexes on the primary database schema. It compares the indexes in the database with the indexes in the following files: create-indexes.sql or create-meta.sql from the oal-topomgr.jar file etc/schema/create-tables.sql The text Nothing to do means that the indexes were successfully validated. If some indexes are not displayed, reset them. If unexpected indexes are displayed. Investigate why they are displayed.
database	checkDBInfo	This module displays basic information about the database and the database server. To view extended information about the database server, it must have been discovered by the TADDM server where the Healthcheck program is running.
database	checkDBStats	This module shows the last time that database statistics were updated in the database. Ensure that the TADDM database statistics are updated regularly. If the TADDM spaces have not been updated recently, ensure that a database administrator updates the statistics.
database	checkDBTuning	This module displays information about buffer tuning in the database.
database	getCompsysTableInfo	This module displays basic information and sizing information about the database.
database	getPersobjTableInfo	This module displays information about the Persobj database table, by type.
discovery	checkDiscFailures	This module displays information about the sensors that have failed during discovery. They can be filtered based on the below scenarios: `Single Year`, e.g. 2022 `Multiple Years`, e.g. "2022\|2021" `Single Date`, e.g. 7/10/2022 `Date Range`, e.g. 7/10/2022:7/12/2022
discovery	checkDiscIPFailures	This module displays information about discovery results for the Session sensor, for the previous week. IP address failures for the Session sensor might indicate credential or access problems.
discovery	checkDiscThisWeek	This module displays information about discovery results for all sensors, for the previous week. The following details are displayed: Label The sensor name. Week The start date of the current week. UniqueIPS The number of items discovered by the sensor. Total_Runs The number of times the sensor was run the previous week. Success The number of successful sensor runs. Failures The number of failed sensor runs. You can use this information to determine which sensors must be investigated for configuration problems.
performance	checkDBPerformance	This check runs a performance test against the database over a JDBC connection. The following tasks are performed: Connects to the TADDM database. Creates a table with 10 columns (one character large object and one binary large object) For large objects of size 1000, 10000, and 20000 bytes, the following tasks are performed: Inserts 300 rows. Selects 300 rows. Deletes 300 rows. The result is the number of milliseconds it takes to complete the test. The result can be used to compare JDBC performance between two systems, or over time.
performance	checkTaddmPerformance	This check calculates the time taken to perform finds and gets on ComputerSystem model objects. It runs the check against 10 ComputerSystem model objects and returns the following information: Label The displayName of the computer system. Attribute Count An estimate of the number of attributes the computer system has. AttrTime(sec) The time taken to get the attributes. Relationships The number of relationships the computer system has. This check uses `findRelationships`. RelTime(sec) The time taken to run `findRelationships`. ExtAttributes The number of extended attributes. This check uses `getExtendedAttributes`. ExtAttrTime(sec) The time taken to run `getExtendedAttributes`. Find Guid Time(sec) The time taken to perform a depth 3 find on the GUID of a displayName.
status	checkTaddmStatus	This module displays information about the TADDM status (similar to information provided by bin/control) for the major services, and information about the services that they provide. For the major services, the following details are displayed, where available: Label The service name. A subservice is indicated with the + character. Max Memory The maximum memory available to the Java™ virtual machine (JVM). The information is similar to information provided by the `-Xmx` setting. Total Memory The total amount of memory in use. Free Memory The amount of free memory. Threads The number of threads assigned. Running Threads The number of threads in use. Status The status of the service. For more information about these values, see `java.lang.Runtime` in the Javadoc.
validate	checkCompsysAging	This module displays a count of systems discovered in the last 30 days, 30 - 90 days ago, and 90 - 360 days ago. You can use this information to determine what maintenance must be performed on the system. For example, if TADDM must contain the list of actual systems, you must ensure that they are discovered or loaded regularly (at least every 90 days).
validate	checkOrphanedIP	This module looks for a specific data corruption problem where an IpInterface has been orphaned. The module reports the address of the interface, the GUID of the interface, and the MSS that controls the interface. Where an orphaned interface exists, the IpInterface points to a parent ComputerSystem, but the parent ComputerSystem does not point to the IpInterface. In this situation, the parent ComputerSystem has been deleted, so you can delete the orphaned interface.
validate	checkRogueAgents	This module displays the number of CIs, grouped by the CDM type and Management Software System (MSS). It lists which sensors or DLAs created systems in TADDM. You can use this module to find problematic sensors, DLAs, or topology agents. For example, a disproportionately large number of computer systems owned by a single topology build agent might indicate a data problem. The data in this module might be truncated. If so, you can view it in CSV format by using the `-c` switch when running the Healthcheck program.
validate	checkTADDMDuplicates	This module displays CIs with the same DisplayName. CIs with the same name are potentially duplicates. The host name, GUIDs, and the MSS owners (for example, sensors and DLA) of the duplicate items are displayed. It searches for COMPSYS entries that are of type ComputerSystem, and that have been scanned with the OS sensor. You must examine each one and establish whether it is valid or not. In many situations, duplicate displayNames do not indicate a problem.

Examples

The following sample command lists the available modules:

healthcheck --list

The following sample lists the available modules, by group and with a description:

healthcheck --info

The following sample command runs all modules:

healthcheck -u username -p password

The following sample command runs a group of modules:

healthcheck -u username -p password -g group

The following sample command runs a single module:

 healthcheck -u username -p password module_name

The following sample command runs a single module and outputs only the requested columns:

 healthcheck -u username -p password --moswos "column1,column2,..." module_name

If a column does not exist, the result is None. No headers or other information is output.

The following sample command runs a checkDiskFailures module with the duration provided to skip:

 healthcheck -u username -p password -v 2022 checkDiscFailures