1ipa-healthcheck(1)           FreeIPA Manual Pages           ipa-healthcheck(1)
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       --source=SOURCE
56              Execute one or more checks within this given source.
57
58       --check=CHECK
59              Execute  this particular check within a source. A source must be
60              supplied as well with this option.
61
62       --output-type=TYPE
63              Set the output type. The default is JSON.
64
65       --failures-only
66              Exclude SUCCESS results on output.
67
68       --severity=SEVERITY
69              Only report errors in the requested severity of  SUCCESS,  WARN‐
70              ING,  ERROR  or CRITICAL. This can be provided multiple times to
71              search on multiple levels.
72
73       --debug
74              Generate additional debugging output.
75
76
77   JSON OUTPUT
78       The results are displayed as a list of result messages for  each  check
79       executed in JSON format. This could be input for a monitoring system.
80
81       --output-file=FILENAME
82              Write the output to this filename rather than stdout.
83
84       --input-file=FILENAME
85              Read the results of a previous run and re-display them.
86
87       --indent=INDENT
88              Pretty-print  the  JSON with this indention level. This can make
89              the output more human-readable.
90
91
92   HUMAN-READABLE OUTPUT
93       The results are displayed in a more human-readable format.
94
95       --input-file=FILENAME
96              Take as input a JSON results output and convert  it  to  a  more
97              human-readable form.
98
99

EXAMPLES

101       Execute healthcheck with the default JSON output:
102
103        ipa-healthcheck
104
105       Execute healthcheck with a prettier JSON output:
106
107        ipa-healthcheck --indent 2
108
109       Execute healthcheck and only display errors:
110
111        ipa-healthcheck --failures-only
112
113       Display in human-readable output a previous report:
114
115           ipa-healthcheck    --output-format    human    --input-file    \
116       /var/log/ipa/check.json
117
118

FILES

120       /etc/ipahealthcheck/ipahealthcheck.conf
121
122

EXIT STATUS

124       0 if all checks were successful
125
126       1 if any one check failed or the command failed to execute properly
127
128

INTERNET RESOURCES

130       Main website:  https://www.freeipa.org/
131
132       Git             repository             for             ipa-healthcheck:
133       https://www.github.com/freeipa/freeipa-healthcheck/
134
135

OTHER RESOURCES

137       The  ipa-healthcheck  distribution  includes a documentation file named
138       README.md which contains detailed explanations on executed checks.
139
140
141
142FreeIPA                           Apr  4 2019               ipa-healthcheck(1)
Impressum