.\" A man page for ipa-healthcheck
.\" Copyright (C) 2019  FreeIPA Contributors see COPYING for license
.\"
.TH "ipa-healthcheck" "8" "Jan 16 2020" "FreeIPA" "FreeIPA Manual Pages"
.SH "NAME"
ipa\-healthcheck \- Check on the health of an IPA installation
.SH "SYNOPSIS"
ipa\-healthcheck [\fIOPTION\fR]...

.SH "DESCRIPTION"
An IPA installation is a complex system and identifying 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.

.SS "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.

.SS "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.

.SH "OPTIONS"
.SS "COMMANDS"
.TP
\fB\-\-list\-sources\fR
Display a list of the available sources and the checks associated with those sources.

.SS "OPTIONAL ARGUMENTS"
.TP
\fB\-\-source\fR=\fISOURCE\fR
Execute checks within the named source, or all sources in the given namespace.
.TP
\fB\-\-check\fR=\fICHECK\fR
Execute this particular check within a source. The exact source must also be specified via \fB\-\-source\fR.
.TP
\fB\-\-output\-type\fR=\fITYPE\fR
Set the output type. Supported variants are \fBhuman\fR and \fBjson\fR. The default is \fBjson\fR.
.TP
\fB\-\-failures\-only\fR
Exclude SUCCESS results on output. If stdin is a tty then this will default to True. In all other cases it defaults to False.
.TP
\fB\-\-all\fR
Report all results.
.TP
\fB\-\-severity=\fRSEVERITY\fR
Only report errors in the requested severity of SUCCESS, WARNING, ERROR or CRITICAL. This can be provided multiple times to search on multiple levels.
.TP
\fB\-\-verbose\fR
Generate verbose output.
.TP
\fB\-\-debug\fR
Generate additional debugging output.

.SS "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.
.TP
\fB\-\-output\-file\fR=\fIFILENAME\fR
Write the output to this filename rather than stdout.
.TP
\fB\-\-input\-file\fR=\fIFILENAME\fR
Read the results of a previous run and re-display them.
.TP
\fB\-\-indent\fR=\fIINDENT\fR
Pretty\-print the JSON with this indention level. This can make the output more human\-readable.

.SS "HUMAN\-READABLE OUTPUT"
The results are displayed in a more human\-readable format.
.TP
\fB\-\-input\-file\fR=\fIFILENAME\fR
Take as input a JSON results output and convert it to a more human\-readable form.

.SH "EXAMPLES"
.PP
Execute healthcheck with the default JSON output:
.PP
.nf 1
\&# ipa\-healthcheck
.fi
.PP
Execute healthcheck with a prettier JSON output:
.PP
.nf 1
\&# ipa\-healthcheck \-\-indent 2
.fi
.PP
Execute healthcheck and only display errors:
.PP
.nf 1
\&# ipa\-healthcheck \-\-failures\-only
.fi
.PP
Display in human\-readable output a previous report:
.PP
.nf 2
\&# ipa\-healthcheck \-\-output\-type human \-\-input\-file \e
\&        /var/log/ipa/healthcheck/healthcheck.log
.fi

.SH "FILES"
.TP
/etc/ipahealthcheck/ipahealthcheck.conf

.SH "EXIT STATUS"
0 if all checks were successful

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

.SH INTERNET RESOURCES
Main website:  https://www.freeipa.org/

Git repository for ipa-healthcheck:  https://www.github.com/freeipa/freeipa-healthcheck/

.SH OTHER RESOURCES
The ipa-healthcheck distribution includes a documentation file named README.md which contains detailed explanations on executed checks.