Chapter 25. Installing and running the IdM Healthcheck tool
Learn more about the IdM Healthcheck tool and how to install and run it.
25.1. Healthcheck in IdM Copy linkLink copied to clipboard!
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.
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.
25.2. Installing IdM Healthcheck Copy linkLink copied to clipboard!
Learn how you can install the IdM Healthcheck tool.
Prerequisites
-
You are logged in as
root
.
Procedure
Install the
ipa-healthcheck
package:dnf install ipa-healthcheck
[root@server ~]# dnf install ipa-healthcheck
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
Perform a basic Healthcheck test:
ipa-healthcheck
[root@server ~]# ipa-healthcheck []
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The empty square brackets
[]
indicate a fully-functioning IdM installation.
25.3. Running IdM Healthcheck manually Copy linkLink copied to clipboard!
You can execute Healthcheck tests in one of the following ways:
- Manually on the CLI.
- Automatically by using a timer.
This section describes how to execute Healthcheck tests manually.
Prerequisites
- The Healthcheck tool is installed. See Installing IdM Healthcheck.
Procedure
Optional: To display a list of all available Healthcheck tests, enter:
ipa-healthcheck --list-sources
[root@server ~]# ipa-healthcheck --list-sources
Copy to Clipboard Copied! Toggle word wrap Toggle overflow To run the Healthcheck utility, enter:
ipa-healthcheck
[root@server ~]# ipa-healthcheck
Copy to Clipboard Copied! Toggle word wrap Toggle overflow