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

NAME

6       sosreport - Collect and package diagnostic and support data
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                 [-k plug.opt|--plugin-option plug.opt]
16                 [--no-report] [--config-file conf]
17                 [--batch] [--build] [--debug]
18                 [--label label] [--case-id id] [--ticket-number nr]
19                 [--threads threads]
20                 [-s|--sysroot SYSROOT]
21                 [-c|--chroot {auto|always|never}
22                 [--tmp-dir directory]
23                 [-p|--profile profile-name]
24                 [--list-profiles]
25                 [--verify]
26                 [--log-size]
27                 [--all-logs]
28                 [-z|--compression-type method]
29                 [--encrypt-key KEY]
30                 [--encrypt-pass PASS]
31                 [--experimental]
32                 [-h|--help]
33
34

DESCRIPTION

36       sosreport generates an archive of configuration and diagnostic informa‐
37       tion from the running system. The archive may be stored locally or cen‐
38       trally  for  recording or tracking purposes or may be sent to technical
39       support representatives, developers or system administrators to  assist
40       with technical fault-finding and debugging.
41
42       Sos  is modular in design and is able to collect data from a wide range
43       of subsystems and packages that may be installed. An XML or HTML report
44       summarizing  the  collected  information  is  optionally  generated and
45       stored within the archive.
46

OPTIONS

48       -l, --list-plugins
49              List all available plugins  and  their  options.  Plug-ins  that
50              would  not  be  enabled  by the current configuration are listed
51              separately.
52
53       -n, --skip-plugins PLUGNAME[,PLUGNAME]
54              Disable the specified plugin(s). Multiple plug-ins may be speci‐
55              fied by repeating the option or as a comma-separated list.
56
57       -e, --enable-plugins PLUGNAME[,PLUGNAME]
58              Enable  the specified plugin(s). Multiple plug-ins may be speci‐
59              fied by repeating the option or as a comma-separated list.
60
61       -o, --only-plugins PLUGNAME[,PLUGNAME]
62              Enable the specified plugin(s) only (all other plugins should be
63              disabled).  Multiple  plugins  may be specified by repeating the
64              option or as a comma-separated list.
65
66       -k PLUGNAME.PLUGOPT[=VALUE], --plugin-option=PLUGNAME.PLUGOPT[=VALUE]
67              Specify plug-in options. The option PLUGOPT is enabled,  or  set
68              to the specified value in the plug-in PLUGNAME.
69
70       -a, --alloptions
71              Set all boolean options to True for all enabled plug-ins.
72
73       -v, --verbose
74              Increase  logging  verbosity. May be specified multiple times to
75              enable additional debugging messages.
76
77       -q, --quiet
78              Only log fatal errors to stderr.
79
80       --no-report
81              Disable HTML/XML report writing.
82
83       --config-file CONFIG
84              Specify alternate configuration file.
85
86       -s, --sysroot SYSROOT
87              Specify an alternate root file system path. Useful for  collect‐
88              ing reports from containers and images.
89
90       -c, --chroot {auto|always|never}
91              Set  the chroot mode. When --sysroot is used commands default to
92              executing with SYSROOT as the root directory (unless disabled by
93              a specific plugin). This can be overriden by setting --chroot to
94              "always" (always chroot) or "never"  (always  run  in  the  host
95              namespace).
96
97       --tmp-dir DIRECTORY
98              Specify  alternate  temporary  directory to copy data as well as
99              the compressed report.
100
101       --list-profiles
102              Display a list of available profiles and the plugins  that  they
103              enable.
104
105       -p, --profile NAME
106              Only  run  plugins that correspond to the given profile. Multple
107              profiles may be specified as a comma-separated list; the set  of
108              plugins  executed  is  the union of each of the profile's plugin
109              sets. Currently defined profiles include: boot,  cluster,  desk‐
110              top,  debug, hardware, identity, network, openstack, packageman‐
111              ager, security, services, storage, sysmgmt, system, performance,
112              virt, and webserver.
113
114       --verify
115              Instructs plugins to perform plugin-specific verification during
116              data collection. This may include package manager  verification,
117              log  integrity testing or other plugin defined behaviour. Use of
118              --verify may cause the time taken to generate  a  report  to  be
119              considerably longer.
120
121       --log-size
122              Places  a global limit on the size (in MiB) of any collected set
123              of logs. The limit is applied separately for each  set  of  logs
124              collected by any plugin.
125
126       --all-logs
127              Tell  plugins to collect all possible log data ignoring any size
128              limits and including logs in non-default locations. This  option
129              may significantly increase the size of reports.
130
131       -z, --compression-type METHOD
132              Override  the  default  compression type specified by the active
133              policy.
134
135       --encrypt-key KEY
136              Encrypts the resulting archive  that  sosreport  produces  using
137              GPG.  KEY  must  be an existing key in the user's keyring as GPG
138              does not allow for keyfiles.  KEY can be any value  accepted  by
139              gpg's 'recipient' option.
140
141              Note  that the user running sosreport must match the user owning
142              the keyring from which keys will be obtained. In particular this
143              means  that  if  sudo is used to run sosreport, the keyring must
144              also be set up  using  sudo  (or  direct  shell  access  to  the
145              account).
146
147              Users  should  be  aware  that encrypting the final archive will
148              result in sos using double the amount of temporary disk space  -
149              the encrypted archive must be written as a separate, rather than
150              replacement, file within the temp directory that sos writes  the
151              archive  to.  However,  since  the encrypted archive will be the
152              same size as the original archive, there is no additional  space
153              consumption  once  the temporary directory is removed at the end
154              of execution.
155
156              This means that only the encrypted archive is  present  on  disk
157              after sos finishes running.
158
159              If encryption fails for any reason, the original unencrypted ar‐
160              chive is preserved instead.
161
162       --encrypt-pass PASS
163              The same as --encrypt-key, but use the provided PASS for symmet‐
164              ric encryption rather than key-pair encryption.
165
166       --batch
167              Generate archive without prompting for interactive input.
168
169       --name NAME
170              Deprecated. See --label
171
172       --label LABEL
173              Specify  an  arbitrary identifier to associate with the archive.
174              Labels will be appended after the system's  short  hostname  and
175              may contain alphanumeric characters.
176
177       --threads THREADS
178              Specify  the  number  of  threads sosreport will use for concur‐
179              rency. Defaults to 4.
180
181       --case-id NUMBER
182              Specify a case identifier to associate with the archive.   Iden‐
183              tifiers  may include alphanumeric characters, commas and periods
184              ('.').  Synonymous with --ticket-number.
185
186       --ticket-number NUMBER
187              Specify a ticket number or other identifier  to  associate  with
188              the  archive.   Identifiers may include alphanumeric characters,
189              commas and periods ('.').  Synonymous with --case-id.
190
191       --build
192              Do not archive copied data. Causes sosreport to leave an  uncom‐
193              pressed archive as a temporary file or directory tree.
194
195       --debug
196              Enable  interactive  debugging using the python debugger. Excep‐
197              tions in sos or plug-in code will cause a trap to the pdb shell.
198
199       --experimental
200              Enable plugins marked as experimental. Experimental plugins  may
201              not  have been tested for this port or may still be under active
202              development.
203
204       --help Display usage message.
205

MAINTAINER

207       Bryn M. Reeves <bmr@redhat.com>
208

AUTHORS & CONTRIBUTORS

210       See AUTHORS file in /usr/share/doc/sosreport.
211

TRANSLATIONS

213       Translations are handled by transifex (https://fedorahosted.org/transifex/)
214
215
216
217                                Mon Mar 25 2013                   SOSREPORT(1)
Impressum