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
19   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
24       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
28       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
33       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
39
40   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
46

OPTIONS

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

EXAMPLES

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

FILES

142       /etc/ipahealthcheck/ipahealthcheck.conf
143
144

EXIT STATUS

146       0 if all checks were successful
147
148       1 if any one check failed or the command failed to execute properly
149
150

INTERNET RESOURCES

152       Main website:  https://www.freeipa.org/
153
154       Git             repository             for             ipa-healthcheck:
155       https://www.github.com/freeipa/freeipa-healthcheck/
156
157

OTHER RESOURCES

159       The  ipa-healthcheck  distribution  includes a documentation file named
160       README.md which contains detailed explanations on executed checks.
161
162
163
164FreeIPA                           Jan 16 2020               ipa-healthcheck(8)