ipa-healthcheck man page

ipa-healthcheck ā€” Check on the health of an IPA installation

Synopsis

ipa-healthcheck [OPTION]...

Description

An IPA installation is a complex system and identifing real or potential issues can be difficult and require a lot of analysis. This tool aims to reduce the burden of that and attempts to identify issues in advance so they can be corrected, ideally before the issue is critical.

Organization

These areas of the system to check can be logically grouped together. This grouping is called a source. A source consists of one or more checks.

A check is as atomic as possible to limit the scope and complexity and provide a yes/no answer on whether that particular configuration is correct.

Each check will return a result, either a result of WARNING, ERROR or CRITICAL or SUCCESS. Returning SUCCESS tells you that the check was done and was deemed correct. This should help track when the last time something was examined.

Upon failure the output will include the source and check that detected the failure along with a message and name/value pairs indicating the problem. It may very well be that the check can't make a final determination and generally defaults to WARNING if it can't be sure so that it can be examined.

Implementation Details

There is no need for users to authenticate and get a ticket in advance for ipa-healthcheck to work. Existing tickets will not be used as ipa-healthcheck will leverage the host keytab and use a temporary credential cache.

Options

Commands

--list-sources

Display a list of the available sources and the checks associated with those sources.

Optional Arguments

--source=SOURCE

Execute one or more checks within this given source.

--check=CHECK

Execute this particular check within a source. A source must be supplied as well with this option.

--output-type=TYPE

Set the output type. The default is JSON.

--failures-only

Exclude SUCCESS results on output.

--severity=SEVERITY

Only report errors in the requested severity of SUCCESS, WARNING, ERROR or CRITICAL. This can be provided multiple times to search on multiple levels.

--debug

Generate additional debugging output.

JSON Output

The results are displayed as a list of result messages for each check executed in JSON format. This could be input for a monitoring system.

--output-file=FILENAME

Write the output to this filename rather than stdout.

--input-file=FILENAME

Read the results of a previous run and re-display them.

--indent=INDENT

Pretty-print the JSON with this indention level. This can make the output more human-readable.

Human-Readable Output

The results are displayed in a more human-readable format.

--input-file=FILENAME

Take as input a JSON results output and convert it to a more human-readable form.

Examples

Execute healthcheck with the default JSON output:

 ipa-healthcheck

Execute healthcheck with a prettier JSON output:

 ipa-healthcheck --indent 2

Execute healthcheck and only display errors:

 ipa-healthcheck --failures-only

Display in human-readble output a previous report:

 ipa-healthcheck --output-format human --input-file \
        /var/log/ipa/check.json

Files

/etc/ipahealthcheck/ipahealthcheck.conf

Exit Status

0 if all checks were successful

1 if any one check failed or the command failed to execute properly

Referenced By

ipahealthcheck.conf(5).

Apr 4 2019 FreeIPA Manual Pages