Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 30. Installing and running the IdM Healthcheck tool

Learn more about the IdM Healthcheck tool and how to install and run it.

Note
  • The Healthcheck tool is only available on RHEL 8.1 or later.

30.1. Healthcheck in IdM
Copy link

The Healthcheck command line tool in Identity Management (IdM) helps find issues that can impact the performance of your IdM environment. Using Healthcheck, you can identify an issue in advance so that you can correct it before it becomes critical.

Note

You can use Healthcheck without obtaining a Kerberos ticket.

Modules are independent

Healthcheck consists of independent modules which check for:

  • Replication issues
  • Certificate validity
  • Certificate authority infrastructure issues
  • IdM and Active Directory trust issues
  • Correct file permissions and ownership settings

Output formats and destination

You can set the following types of output for Healthcheck to generate by using the output-type option:

  • json: Machine-readable output in JSON format (default)
  • human: Human-readable output

You can specify a file to store the output by using the --output-file option.

Results

Each Healthcheck module returns one of the following results:

SUCCESS
The system is configured as expected.
WARNING
It is advisable to monitor or evaluate the configuration.
ERROR
The system is not configured as expected.
CRITICAL
The configuration is not as expected, with a significant potential to impact the functioning of your IdM deployment.

30.2. Installing IdM Healthcheck
Copy link

Learn how you can install the IdM Healthcheck tool.

Prerequisites

  • You are logged in as root.

Procedure

  • Install the ipa-healthcheck package: 

    [root@server ~]# yum install ipa-healthcheck
    Copy to Clipboard Toggle word wrap
    Note

    On RHEL 8.1 and 8.2 systems, use the yum install /usr/bin/ipa-healthcheck command instead.

Verification

  • Perform a basic Healthcheck test: 

    [root@server ~]# ipa-healthcheck
[]
    Copy to Clipboard Toggle word wrap

    The empty square brackets [] indicate a fully-functioning IdM installation.

30.3. Running IdM Healthcheck
Copy link

You can execute Healthcheck tests in one of the following ways:

This section describes how to execute the tests manually.

Prerequisites

Procedure

  1. [Optional] To display a list of all available Healthcheck tests, enter: 

    [root@server ~]# ipa-healthcheck --list-sources
    Copy to Clipboard Toggle word wrap

  2. To run the Healthcheck utility, enter: 

    [root@server ~]# ipa-healthcheck
    Copy to Clipboard Toggle word wrap
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat