1SOSREPORT(1)                General Commands Manual               SOSREPORT(1)
2
3
4

NAME

6       sosreport - Generate debugging information for this system
7

SYNOPSIS

9       sosreport
10                 [-l|--list-plugins]
11                 [-n|--skip-plugins plugin-names]
12                 [-e|--enable-plugins plugin-names]
13                 [-o|--only-plugins plugin-names]
14                 [-a|--alloptions] [-v|--verbose]
15                 [--diagnose] [--analyze] [--report]
16                 [--config-file conf] [--batch]
17                 [--build] [--name name] [--no-colors]
18                 [--ticket-number number] [--debug]
19                 [--upload] [--tmp-dir directory]
20                 [--profile] [--help]
21

DESCRIPTION

23       sosreport  generates  a compressed tarball of debugging information for
24       the system it is run on that can be sent to technical support reps that
25       will give them a more complete view of the overall system status.
26

OPTIONS

28       -l, --list-plugins
29              This  will list all available plugins showing which ones will be
30              enabled by the current configuration.  It  will  also  show  all
31              plugin  options  which  can be modified using the -k option (see
32              below).
33
34       -n, --skip-plugins PLUGNAME[,PLUGNAME]
35              Do not load specified plugin(s). To  specify  multiple  plugins,
36              separate them with a comma.
37
38       -e, --enable-plugins PLUGNAME[,PLUGNAME]
39              Enable  the  specified  plugin(s).  To specify multiple plugins,
40              separate them with a comma.
41
42       -o, --only-plugins PLUGNAME[,PLUGNAME]
43              Enable the specified plugin(s) only (all other plugins should be
44              disabled).  To  specify  multiple  plugins, separate them with a
45              comma.
46
47       -k PLUGNAME.PLUGOPT[=VALUE]
48              This is used to specify options for plugins. A list of available
49              plugin  options  can be obtained from the output of --list-plug‐
50              ins.  If no value is specified  and  the  option  is  a  boolean
51              (on/off), it will be set to "on".
52
53       -a, --alloptions
54              Enable all (boolean) options for all loaded plugins.
55
56       --upload FTP_SERVER
57              Upload  the report to Red Hat (use exclusively if advised from a
58              Red Hat support representative).
59
60       -v, --verbose
61              Increase the verbosity of the output as  sosreport  is  running.
62              Multiple -v mean more verbosity.
63
64       --diagnose
65              Turn on diagnostic functions
66
67       --analyze
68              Turn on analyzation functions
69
70       --report
71              Enable html/xml report writing
72
73       --config-file CONFIG
74              Specify alternate configuration file
75
76       --tmp-dir DIRECTORY
77              Specify  alternate  temporary  directory to copy data as well as
78              the compressed report.
79
80       --batch
81              Perform data gathering unattended
82
83       --name NAME
84              Define a unique name for archive
85
86       --ticket-number NUMBER
87              Define a unique number for archive
88
89       --build
90              Do not archive copied data, leave directory tree  untouched  for
91              further modification
92
93       --no-colors
94              Disable colors written to console
95
96       --debug
97              Give  opportunity  to debug python exceptions through the python
98              debugger.
99
100       --profile
101              Turn on profiling for cmds run
102
103       --help Display sosreport help system.
104

MAINTAINER

106       Adam Stokes <astokes@fedoraproject.org>
107

TRANSLATIONS

109       Translations are handled by transifex (https://fedorahosted.org/transifex/)
110
111
112
113                                Tue Apr 08 2010                   SOSREPORT(1)