1SERIVEREPORT(Feb 2019)                                  SERIVEREPORT(Feb 2019)
2
3
4

NAME

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

SYNOPSIS

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

DESCRIPTION

13       The  servicereport command provides the system configuration status and
14       gives recommendations to fix the incorrect system  configurations.  The
15       tool  also  has an option to auto-fix the invalid configurations.  Ser‐
16       viceReport has plugin based architecture and has multiple plugins  that
17       validates and repair different system configuration. The description of
18       plugins is listed below.
19
20              Daemon Checks a list of daemons is enabled in the system or not.
21
22              Dump   Detects which dump mechanism is configured (Kdump or FAD‐
23                     ump)  based  on  that  checks  the  configuration  of the
24                     respective dump tool.
25
26              HTX    Checks  the  configuration  for  Hardware   Test   Execu‐
27                     tive(HTX).  This  plugin  is  only  applicable to PowerPC
28                     architecture.
29
30              Package
31                     Checks a list of packages is installed in the  system  or
32                     not.
33
34       The ServiceReport tool also provide an option to auto fix the incorrect
35       configurations. Not all the validation performed  in  the  plugins  are
36       auto  fixable. ServiceReport try to fix the incorrect configurations if
37       possible else they need to be fixed manually.
38
39       NOTE: The tool supports auto-fix feature for Daemon, Package and  Kdump
40       validations only.
41
42       Please refer the example section to quick start with repair functional‐
43       ity.
44

OPTIONS

46       -f --file <LOG_FILE>
47              Creates LOG_FILE in the current directory and  stores  the  logs
48              into it.
49
50       -h --help
51              Prints usage of the tool and exits.
52
53       -l --list-plugins
54              List all the applicable plugins.
55
56       -p --plugins
57              validates the specified plugins only. Accept multiple plugins as
58              a space separated list.
59
60       -d --dump
61              Triggers a dump if dump tool (Kdump, FADump) is configured  cor‐
62              rectly.
63
64       -q --quiet
65              Execute  all plugins silently without printing any output on the
66              console.
67
68       -r --repair
69              Auto fix the incorrect configurations.
70
71       -V, --version
72              Prints the version of tool and exits.
73
74       -v --verbose
75              Increase the logging verbosity. Display the status of  each  sub
76              check performed by the plugins.
77

EXAMPLES

79       servicereport
80              Runs  and print the status of all the applicable plugins in cur‐
81              rent system.
82
83       servicereport -v
84              Runs all the applicable plugins to current system and print  the
85              detailed status of each plugin.
86
87       servicereport -l
88              List all the applicable plugins.
89
90       servicereport -p P1 P2
91              Runs only P1 and P2 plugins if applicable.
92
93       servicereport -r
94              Repair the incorrect configuration after the validation.
95

AUTHORS & CONTRIBUTORS

97       Sourabh Jain <sourabhjain@linux.ibm.com>
98       Srikanth Aithal <sraithal@linux.vnet.ibm.com>
99
100
101
102Validate and repair the system configuLriantuixon            SERIVEREPORT(Feb 2019)