1ipa-healthcheck(8) FreeIPA Manual Pages ipa-healthcheck(8)
2
6 ipa-healthcheck - Check on the health of an IPA installation
7
9 ipa-healthcheck [OPTION]...
10
13 An IPA installation is a complex system and identifying real or poten‐
14 tial issues can be difficult and require a lot of analysis. This tool
15 aims to reduce the burden of that and attempts to identify issues in
16 advance so they can be corrected, ideally before the issue is critical.
17 ORGANIZATION
20 These areas of the system to check can be logically grouped together.
21 This grouping is called a source. A source consists of one or more
22 checks.
23 A check is as atomic as possible to limit the scope and complexity and
25 provide a yes/no answer on whether that particular configuration is
26 correct.
27 Each check will return a result, either a result of WARNING, ERROR or
29 CRITICAL or SUCCESS. Returning SUCCESS tells you that the check was
30 done and was deemed correct. This should help track when the last time
31 something was examined.
32 Upon failure the output will include the source and check that detected
34 the failure along with a message and name/value pairs indicating the
35 problem. It may very well be that the check can't make a final determi‐
36 nation and generally defaults to WARNING if it can't be sure so that it
37 can be examined.
38 IMPLEMENTATION DETAILS
41 There is no need for users to authenticate and get a ticket in advance
42 for ipa-healthcheck to work. Existing tickets will not be used as
43 ipa-healthcheck will leverage the host keytab and use a temporary cre‐
44 dential cache.
45
48 COMMANDS
49 --list-sources
50 Display a list of the available sources and the checks associ‐
51 ated with those sources.
52 OPTIONAL ARGUMENTS
55 --source=SOURCE
56 Execute checks within the named source, or all sources in the
57 given namespace.
58 --check=CHECK
60 Execute this particular check within a source. The exact source
61 must also be specified via --source.
62 --output-type=TYPE
64 Set the output type. Supported variants are human and json. The
65 default is json.
66 --failures-only
68 Exclude SUCCESS results on output. If stdin is a tty then this
69 will default to True. In all other cases it defaults to False.
70 --all Report all results.
72 --severity=SEVERITY
74 Only report errors in the requested severity of SUCCESS, WARN‐
75 ING, ERROR or CRITICAL. This can be provided multiple times to
76 search on multiple levels.
77 --verbose
79 Generate verbose output.
80 --debug
82 Generate additional debugging output.
83 JSON OUTPUT
86 The results are displayed as a list of result messages for each check
87 executed in JSON format. This could be input for a monitoring system.
88 --output-file=FILENAME
90 Write the output to this filename rather than stdout.
91 --input-file=FILENAME
93 Read the results of a previous run and re-display them.
94 --indent=INDENT
96 Pretty-print the JSON with this indention level. This can make
97 the output more human-readable.
98 HUMAN-READABLE OUTPUT
101 The results are displayed in a more human-readable format.
102 --input-file=FILENAME
104 Take as input a JSON results output and convert it to a more
105 human-readable form.
106
109 Execute healthcheck with the default JSON output:
110 # ipa-healthcheck
112 Execute healthcheck with a prettier JSON output:
114 # ipa-healthcheck --indent 2
116 Execute healthcheck and only display errors:
118 # ipa-healthcheck --failures-only
120 Display in human-readable output a previous report:
122 # ipa-healthcheck --output-type human --input-file \
124 /var/log/ipa/healthcheck/healthcheck.log
125
128 /etc/ipahealthcheck/ipahealthcheck.conf
129
132 0 if all checks were successful
133 1 if any one check failed or the command failed to execute properly
135
138 Main website: https://www.freeipa.org/
139 Git repository for ipa-healthcheck:
141 https://www.github.com/freeipa/freeipa-healthcheck/
142
145 The ipa-healthcheck distribution includes a documentation file named
146 README.md which contains detailed explanations on executed checks.
147FreeIPA Jan 16 2020 ipa-healthcheck(8)