ipa-healthcheck(8)

✨ ipa-healthcheck(8) ✨

okay bestie, gather round, because we're about to talk about ipa-healthcheck — the FreeIPA manual page that's literally your system's vibe check 💅

---

🎀 NAME 🎀

ipa-healthcheck — check on the health of an IPA installation 🩺✨

---

🌸 SYNOPSIS 🌸

ipa-healthcheck [OPTION]...

---

🦋 DESCRIPTION 🦋

so like, an IPA installation is a complex system, no cap. Spotting real or potential issues can be genuinely hard and takes a whole lot of analysis. This tool is here to reduce that burden, and it tries to identify issues in advance so they can be corrected — ideally before the issue becomes critical. main character energy, honestly. 👑

Not me reminding you: this tool must be run as root in order to access all components of a system. 🔐

---

💜 ORGANIZATION 💜

These areas of the system that get checked can be logically grouped together, and that 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 to give you a yes/no answer on whether that particular configuration is correct.

Every check returns a result, and that result is one of WARNING, ERROR, CRITICAL or SUCCESS. Getting SUCCESS tells you the check actually ran and was deemed correct — which is lowkey useful for tracking the last time something was examined. 🕵️

When something fails, the output includes the source and the check that detected the failure, along with a message and name/value pairs indicating the problem. And ngl, sometimes a check just can't make a final determination — in that case it generally defaults to WARNING if it can't be sure, so that it can be examined. 🙈

---

🌈 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, because ipa-healthcheck leverages the host keytab and uses a temporary credential cache. iconic behaviour, fr fr ✨

---

💅 OPTIONS 💅

⭐ COMMANDS ⭐

• --list-sources — Display a list of the available sources and the checks associated with those sources. your little map of everything, obsessed 🗺️

🎀 OPTIONAL ARGUMENTS 🎀

• --config=FILE — The configuration file to use. If an empty string is passed in then no configuration file is loaded. The default is /etc/ipahealthcheck/ipahealthcheck.conf.
• --source=SOURCE — Execute checks within the named source, or all sources in the given namespace.
• --check=CHECK — Execute this particular check within a source. The exact source must also be specified via --source. (they're a package deal, bestie 🫶)
• --output-type=TYPE — Set the output type. Supported variants are human, json, and prometheus. The default is json.
• --failures-only — Exclude SUCCESS results on output. If stdin is a tty then this will default to True. In all other cases it defaults to False.
• --all — Report all results.
• --severity=SEVERITY — Only report errors in the requested severity of SUCCESS, WARNING, ERROR or CRITICAL. This can be provided multiple times to search on multiple levels. stacking severities? slay 🧚
• --verbose — Generate verbose output.
• --debug — Generate additional debugging output.

---

🍓 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. very plug-and-play of it 💖

• --output-file=FILENAME — Write the output to this filename rather than stdout.
• --input-file=FILENAME — Read the results of a previous run and re-display them.
• --indent=INDENT — Pretty-print the JSON with this indention level. This can make the output more human-readable.

---

🌸 HUMAN-READABLE OUTPUT 🌸

The results are displayed in a more human-readable format. for when you want your eyes to actually enjoy the experience 😭

• --input-file=FILENAME — Take as input a JSON results output and convert it to a more human-readable form.

---

🔥 PROMETHEUS OUTPUT 🔥

The results are displayed in the Prometheus text metric exposition format. metrics girlies rise 👑

• --input-file=FILENAME — Uses the JSON-formatted results output as metrics source.
• --metric-prefix=PREFIX — Prefix to use for metric names.

---

🎀 EXAMPLES 🎀

Execute healthcheck with the default JSON output:

# ipa-healthcheck

Execute healthcheck with a prettier JSON output:

# ipa-healthcheck --indent 2

Execute healthcheck and only display errors:

# ipa-healthcheck --failures-only

Display in human-readable output a previous report:

# ipa-healthcheck --output-type human --input-file \
        /var/log/ipa/healthcheck/healthcheck.log

---

📁 FILES 📁

• /etc/ipahealthcheck/ipahealthcheck.conf

---

🚦 EXIT STATUS 🚦

• 0 if all checks were successful ✅
• 1 if any one check failed or the command failed to execute properly 💀

---

🌐 INTERNET RESOURCES 🌐

• Main website: https://www.freeipa.org/
• Git repository for ipa-healthcheck: https://www.github.com/freeipa/freeipa-healthcheck/

---

📚 OTHER RESOURCES 📚

The ipa-healthcheck distribution includes a documentation file named README.md which contains detailed explanations on executed checks. go read it, it's giving study buddy 📖✨

---

and that's the whole page, bestie!! 🫶 this little love letter to your system comes from the FreeIPA manual pages, dated Jan 16 2020 — so like, it's been serving looks since then. now go run your health checks and stay iconic 💖🌸✨