1ipa-healthcheck(8)           FreeIPA Manual Pages           ipa-healthcheck(8)
2
3
4

NAME

6       ipa-healthcheck - Check on the health of an IPA installation
7

SYNOPSIS

9       ipa-healthcheck [OPTION]...
10
11

DESCRIPTION

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
18       This tool must be run as root in order to access all  components  of  a
19       system.
20
21
22   ORGANIZATION
23       These  areas  of the system to check can be logically grouped together.
24       This grouping is called a source. A source  consists  of  one  or  more
25       checks.
26
27       A  check is as atomic as possible to limit the scope and complexity and
28       provide a yes/no answer on whether  that  particular  configuration  is
29       correct.
30
31       Each  check  will return a result, either a result of WARNING, ERROR or
32       CRITICAL or SUCCESS. Returning SUCCESS tells you  that  the  check  was
33       done  and was deemed correct. This should help track when the last time
34       something was examined.
35
36       Upon failure the output will include the source and check that detected
37       the  failure  along  with a message and name/value pairs indicating the
38       problem. It may very well be that the check can't make a final determi‐
39       nation and generally defaults to WARNING if it can't be sure so that it
40       can be examined.
41
42
43   IMPLEMENTATION DETAILS
44       There is no need for users to authenticate and get a ticket in  advance
45       for  ipa-healthcheck  to  work.  Existing  tickets  will not be used as
46       ipa-healthcheck will leverage the host keytab and use a temporary  cre‐
47       dential cache.
48
49

OPTIONS

51   COMMANDS
52       --list-sources
53              Display  a  list of the available sources and the checks associ‐
54              ated with those sources.
55
56
57   OPTIONAL ARGUMENTS
58       --config=FILE
59              The configuration file to use. If an empty string is  passed  in
60              then  no  configuration file is loaded. The default is /etc/ipa‐
61              healthcheck/ipahealthcheck.conf.
62
63       --source=SOURCE
64              Execute checks within the named source, or all  sources  in  the
65              given namespace.
66
67       --check=CHECK
68              Execute  this particular check within a source. The exact source
69              must also be specified via --source.
70
71       --output-type=TYPE
72              Set the output type. Supported variants  are  human,  json,  and
73              prometheus. The default is json.
74
75       --failures-only
76              Exclude  SUCCESS  results on output. If stdin is a tty then this
77              will default to True. In all other cases it defaults to False.
78
79       --all  Report all results.
80
81       --severity=SEVERITY
82              Only report errors in the requested severity of  SUCCESS,  WARN‐
83              ING,  ERROR  or CRITICAL. This can be provided multiple times to
84              search on multiple levels.
85
86       --verbose
87              Generate verbose output.
88
89       --debug
90              Generate additional debugging output.
91
92
93   JSON OUTPUT
94       The results are displayed as a list of result messages for  each  check
95       executed in JSON format. This could be input for a monitoring system.
96
97       --output-file=FILENAME
98              Write the output to this filename rather than stdout.
99
100       --input-file=FILENAME
101              Read the results of a previous run and re-display them.
102
103       --indent=INDENT
104              Pretty-print  the  JSON with this indention level. This can make
105              the output more human-readable.
106
107
108   HUMAN-READABLE OUTPUT
109       The results are displayed in a more human-readable format.
110
111       --input-file=FILENAME
112              Take as input a JSON results output and convert it to a more hu‐
113              man-readable form.
114
115
116   PROMETHEUS OUTPUT
117       The results are displayed in the Prometheus text metric exposition for‐
118       mat.
119
120       --input-file=FILENAME
121              Uses the JSON-formatted results output as metrics source.
122
123       --metric-prefix=PREFIX
124              Prefix to use for metric names.
125
126

EXAMPLES

128       Execute healthcheck with the default JSON output:
129
130       # ipa-healthcheck
131
132       Execute healthcheck with a prettier JSON output:
133
134       # ipa-healthcheck --indent 2
135
136       Execute healthcheck and only display errors:
137
138       # ipa-healthcheck --failures-only
139
140       Display in human-readable output a previous report:
141
142       # ipa-healthcheck --output-type human --input-file \
143               /var/log/ipa/healthcheck/healthcheck.log
144
145

FILES

147       /etc/ipahealthcheck/ipahealthcheck.conf
148
149

EXIT STATUS

151       0 if all checks were successful
152
153       1 if any one check failed or the command failed to execute properly
154
155

INTERNET RESOURCES

157       Main website:  https://www.freeipa.org/
158
159       Git             repository             for             ipa-healthcheck:
160       https://www.github.com/freeipa/freeipa-healthcheck/
161
162

OTHER RESOURCES

164       The  ipa-healthcheck  distribution  includes a documentation file named
165       README.md which contains detailed explanations on executed checks.
166
167
168
169FreeIPA                           Jan 16 2020               ipa-healthcheck(8)