aboutsummaryrefslogtreecommitdiffstats
path: root/man/en/sos.conf.5
blob: 248af60c5540a111ca6093506af64f4506ffd7f0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
.TH "sos.conf" "5" "SOSREPORT" "sosreport configuration file"
.SH NAME
sos.conf \- sosreport configuration
.SH DESCRIPTION
.sp
sosreport uses a configuration file at /etc/sos/sos.conf.
.SH PARAMETERS
.sp
There are sections for each sos component, as well as global values and
those for plugin options. Options are set using 'ini'-style
\fBname = value\fP pairs. Disabling/enabling a boolean option
is done the same way like on command line (e.g. process.lsof=off).

Some options accept a comma separated list of values.

Using options that don't expect a value (like all-logs or no-report)
will result in enabling those options, regardless of value set.

Sections are parsed in the ordering:
.br
- \fB[global]\fP
.br
- \fB[component]\fP
.br
- \fB[plugin_options]\fP

.TP
\fB[global]\fP
<option>      Sets (long) option value. Short options (i.e. z=auto)
              are not supported.
.TP
\fB[component]\fP
Each component will have a separate section, and it will support the options
that particular component provides. These are readily identifiable in the
\fB--help\fP output for each component, E.G. \fBsos report --help\fP.
.TP
\fB[plugin_options]\fP
Alter available options for defined (and loaded) plugins.

Takes the form plugin.option = value, for example \fBrpm.rpmva = true\fP.
.SH EXAMPLES
To use quiet and batch mode with 10 threads:
.LP
[global]
.br
batch=yes
.br
build=true
.br
threads=10
.sp
To disable the 'host' and 'filesys' plugins:
.LP
[report]
.br
noplugins = host,filesys
.sp
To disable rpm package verification in the RPM plugin:
.LP
[plugin_options]
.br
rpm.rpmva = off
.br
.SH FILES
.sp
/etc/sos/sos.conf
.SH SEE ALSO
.sp
sos-report(1)
sos-collect(1)
sos-clean(1)