SERIVEREPORT(Feb 2019)

NAME
ServiceReport - A tool to verify and repair the system configuration.

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

DESCRIPTION
The servicereport command provides the system configuration status and gives recommendations to fix the incorrect system configurations. The tool also has an option to auto-fix the invalid configurations. ServiceReport has plugin based architecture and has multiple plugins that validates and repair different system configuration. The description of plugins is listed below.

    Daemon
        Checks a list of daemons is enabled in the system or not.

    Dump
        Detects which dump mechanism is configured (Kdump or FADump) 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.

    Package
        Checks a list of packages is installed in the system or not.

The ServiceReport tool also provide an option to auto fix the incorrect configurations. Not all the validation performed in the plugins are auto fixable. ServiceReport try to fix the incorrect configurations if possible else they need to be fixed manually.

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

Please refer the example section to quick start with 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. Accept 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. Display the status of each sub check performed by the plugins.

EXAMPLES

servicereport
    Runs and print the status of all the applicable plugins in current system.

servicereport -v
    Runs all the applicable plugins to current system and print the detailed status of each plugin.

servicereport -l
    List all the applicable plugins.

servicereport -p P1 P2
    Runs only 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>