SERVICEREPORT(8)

✨ SERVICEREPORT(8) — the girlies' guide to validating & repairing your system config ✨

okay so bestie, welcome to SERIVEREPORT(8) (yes the man page header spells it like that, we don't talk about it 💀) — aka ServiceReport, the tool that checks your system configuration and fixes what's fixable. Section 8, system administration, main character energy only. Let's go 🫶

🌸 NAME 🌸

ServiceReport — a tool to verify and repair the system configuration. that's it, that's the vibe 💅

🦋 SYNOPSIS 🦋

servicereport [-f LOG_FILE] [-h] [-l] [-p PLUGIN [PLUGIN ...] [-d]
                   [-q] [-r] [-V] [-v]

👑 DESCRIPTION 👑

The servicereport command gives you the system configuration status, and it also hands you recommendations to fix the incorrect system configurations. And because it's that girl, it also has an option to auto-fix the invalid configurations. iconic behavior, honestly.

ServiceReport runs on a plugin based architecture, and it ships with multiple plugins that validate and repair different parts of your system configuration. here's the plugin lineup, no cap:

• Daemon — checks whether a list of daemons is enabled in the system or not.
• Dump — detects which dump mechanism is configured (Kdump or FADump), and based on that, checks the configuration of the respective dump tool.
• HTX — checks the configuration for Hardware Test Executive (HTX). this plugin is only applicable to PowerPC architecture, so if that's not you, it's not you 🫶
• Package — checks whether a list of packages is installed in the system or not.

The ServiceReport tool also provides an option to auto fix the incorrect configurations. Not all the validation performed in the plugins is auto fixable, bestie. ServiceReport tries to fix the incorrect configurations if possible — otherwise they need to be fixed manually. so close yet so far 😭

NOTE: The tool supports the auto-fix feature for Daemon, Package and Kdump validations only.

Please refer to the EXAMPLES section to quick start with the repair functionality. ✨

💖 OPTIONS 💖

• -f, --file <LOG_FILE> — Creates LOG_FILE in the current directory and stores the logs into it.
• -h, --help — Prints usage of the tool and exits.
• -l, --list-plugins — List all the applicable plugins.
• -p, --plugins — validates the specified plugins only. Accepts multiple plugins as a space separated list.
• -d, --dump — Triggers a dump if dump tool (Kdump, FADump) is configured correctly.
• -q, --quiet — Execute all plugins silently without printing any output on the console. 🤫
• -r, --repair — Auto fix the incorrect configurations.
• -V, --version — Prints the version of tool and exits.
• -v, --verbose — Increase the logging verbosity. Displays the status of each sub check performed by the plugins.

🌈 EXAMPLES 🌈

• servicereport — Runs and prints the status of all the applicable plugins in the current system.
• servicereport -v — Runs all the applicable plugins on the current system and prints the detailed status of each plugin. tell me everything, bestie 💅
• servicereport -l — List all the applicable plugins.
• servicereport -p P1 P2 — Runs only the P1 and P2 plugins, if applicable.
• servicereport -r — Repair the incorrect configuration after the validation.

🎀 AUTHORS & CONTRIBUTORS 🎀

• Sourabh Jain <sourabhjain@linux.ibm.com>
• Srikanth Aithal <sraithal@linux.vnet.ibm.com>

and that's the whole page, periodt. 💜 this one lives under source Linux, dated Feb 2019 (per the footer, which reads Linux SERIVEREPORT(Feb 2019)), and honestly? still serving. go validate something and slay 🧚✨