Chapter 30. Installing and running the IdM Healthcheck tool
Learn more about the IdM Healthcheck tool and how to install and run it.
- The Healthcheck tool is only available on RHEL 8.1 or later.
30.1. Healthcheck in IdM
The Healthcheck tool in Identity Management (IdM) helps find issues that may impact the health of your IdM environment.
The Healthcheck tool is a command line tool that can be used without Kerberos authentication.
Modules are Independent
Healthcheck consists of independent modules which test for:
- Replication issues
- Certificate validity
- Certificate Authority infrastructure issues
- IdM and Active Directory trust issues
- Correct file permissions and ownership settings
Two output formats
Healthcheck generates the following outputs, which you can set using the output-type option:
-
json: Machine-readable output in JSON format (default) -
human: Human-readable output
You can specify a different file destination with the --output-file option.
Results
Each Healthcheck module returns one of the following results:
- SUCCESS
- configured as expected
- WARNING
- not an error, but worth keeping an eye on or evaluating
- ERROR
- not configured as expected
- CRITICAL
- not configured as expected, with a high possibility for impact
30.2. Installing IdM Healthcheck
Follow this procedure to install the IdM Healthcheck tool.
Procedure
Install the
ipa-healthcheckpackage:[root@server ~]# yum install ipa-healthcheckNoteOn RHEL 8.1 and 8.2 systems, use the yum install /usr/bin/ipa-healthcheck command instead.
Verification
Use the
--failures-onlyoption to haveipa-healthcheckonly report errors. A fully-functioning IdM installation returns an empty result of[].[root@server ~]# ipa-healthcheck --failures-only []
Additional resources
-
Use
ipa-healthcheck --helpto see all supported arguments.
30.3. Running IdM Healthcheck
Healthcheck can be run manually or automatically using log rotation.
Prerequisites
- The Healthcheck tool must be installed. See Installing IdM Healthcheck.
Procedure
To run healthcheck manually, enter the
ipa-healthcheckcommand.[root@server ~]# ipa-healthcheck
Additional resources
For all options, see the man page: man ipa-healthcheck.
30.4. Additional resources
See the following sections of the Configuring and managing Identity Management guide for examples of using IdM Healthcheck.
- You can also see those chapters organized into a single guide: Using IdM Healthcheck to monitor your IdM environment
