QuickStart

Overview

The QuickStart section is divided into multiple subsections that discuss two important aspects of the tool. The first section covers how to validate the FFDC configuration and the second section talks about how to fix the incorrect FFDC configuration reported during the validation.

At the end of this section, you will find a GIF that covers all the commands used in the upcoming sections.

Validate FFDC configuration

Once the ServiceReport package is installed in your system issue the following command:

$ servicereport

The above command will report the status of all the plugins (a plugin is nothing but a group of similar configuration checks) that are applicable to the system. If the status of a plugin is PASS then all the configurations that belong to that plugin have configured correctly. But if the status is FAIL then it means that there is at least one incorrect configuration found in the plugin.

Now to know incorrectly configured configurations, servicereport provides a way to print the detailed validation report that includes the validation status of every configuration checks done by a plugin. To enable this feature, execute the servicereport command with -v option.

$ servicereport -v

The above command will print the detailed validation report on the console. The detail validation report not only contains the overall status of every plugin but the status of every configuration check performed under a plugin. Now in the next section, we will see how to fix the incorrect configurations reported by the servicereport tool.

Repair incorrect FFDC configurations

All the incorrect FFDC configuration reported during the validation phase has to be fixed before considering the system FFDC ready. There are two ways to fix incorrect FFDC configuration reported during the validation phase.

• Manually fixing the incorrect configuration: When servicereport logs the details of incorrect configurations in journald it also adds recommendations that include instructions and commands to fix the incorrect configuration. Run the below command and search for servicereport tag, you will get details of incorrect configuration and instructions to fix them.

$ journalctl

• Automatic repair: The exciting feature of servicereport is that it has the capability to fix the incorrect configuration automatically. To enable the repair mode add -r option to the command.

$ servicereport -v -r

Repair mode collects the details of all the configuration checks performed during the validation phase and tries to fix the incorrect configurations. If the tool succeeds in fixing the configuration then it updates the validation status to PASS and adds "Auto Fixed" tag next to the validation status. In case if the tool fails to fix the configuration it adds "Unable to Fix" tag next to validation status.

Note:

There are some critical FFDC configurations which are partially auto-fixable. User action is required to fix such configuration issues. Please visit User Action on Repair page to know more.