1SOSREPORT(1) General Commands Manual SOSREPORT(1)
2
6 sosreport - Collect and package diagnostic and support data
7
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 [--preset preset] [--add-preset add_preset]
18 [--del-preset del_preset] [--desc description]
19 [--batch] [--build] [--debug] [--dry-run]
20 [--label label] [--case-id id] [--ticket-number nr]
21 [--threads threads]
22 [--plugin-timeout TIMEOUT]
23 [-s|--sysroot SYSROOT]
24 [-c|--chroot {auto|always|never}
25 [--tmp-dir directory]
26 [-p|--profile profile-name]
27 [--list-profiles]
28 [--verify]
29 [--log-size]
30 [--all-logs]
31 [-z|--compression-type method]
32 [--encrypt-key KEY]
33 [--encrypt-pass PASS]
34 [--experimental]
35 [-h|--help]
36
39 sosreport generates an archive of configuration and diagnostic informa‐
40 tion from the running system. The archive may be stored locally or cen‐
41 trally for recording or tracking purposes or may be sent to technical
42 support representatives, developers or system administrators to assist
43 with technical fault-finding and debugging.
44 Sos is modular in design and is able to collect data from a wide range
46 of subsystems and packages that may be installed. An XML or HTML report
47 summarizing the collected information is optionally generated and
48 stored within the archive.
49
51 -l, --list-plugins
52 List all available plugins and their options. Plug-ins that
53 would not be enabled by the current configuration are listed
54 separately.
55 -n, --skip-plugins PLUGNAME[,PLUGNAME]
57 Disable the specified plugin(s). Multiple plug-ins may be speci‐
58 fied by repeating the option or as a comma-separated list.
59 -e, --enable-plugins PLUGNAME[,PLUGNAME]
61 Enable the specified plugin(s). Multiple plug-ins may be speci‐
62 fied by repeating the option or as a comma-separated list.
63 -o, --only-plugins PLUGNAME[,PLUGNAME]
65 Enable the specified plugin(s) only (all other plugins should be
66 disabled). Multiple plugins may be specified by repeating the
67 option or as a comma-separated list.
68 -k PLUGNAME.PLUGOPT[=VALUE], --plugin-option=PLUGNAME.PLUGOPT[=VALUE]
70 Specify plug-in options. The option PLUGOPT is enabled, or set
71 to the specified value in the plug-in PLUGNAME.
72 -a, --alloptions
74 Set all boolean options to True for all enabled plug-ins.
75 -v, --verbose
77 Increase logging verbosity. May be specified multiple times to
78 enable additional debugging messages.
79 -q, --quiet
81 Only log fatal errors to stderr.
82 --no-report
84 Disable HTML/XML report writing.
85 --config-file CONFIG
87 Specify alternate configuration file.
88 --preset PRESET
90 Specify an existing preset to use for sos options.
91 Presets are pre-configured sets of options for both sos and sos
93 plugins. For example a preset may enable a certain set of plug‐
94 ins, disable others, or enable specific plugin options. They may
95 also specify sos options such as log-size or package verifica‐
96 tion.
97 User defined presets are saved under /var/lib/sos/presets as
99 JSON-formatted files.
100 --add-preset ADD_PRESET [options]
102 Add a preset with name ADD_PRESET that enables [options] when
103 called.
104 For example, 'sosreport --add-preset mypreset --log-size=50 -n
106 logs' will enable a user to run 'sosreport --preset mypreset'
107 that sets the maximum log size to 50 and disables the logs plug‐
108 in.
109 Note: to set a description for the preset that is displayed with
111 --list-presets use the --desc option.
112 --del-preset DEL_PRESET
114 Deletes the preset with name DEL_PRESET from the filesystem so
115 that it can no longer be used.
116 --list-presets
118 Display a list of available presets and what options they carry.
119 --desc DESCRIPTION
121 When using --add-preset use this option to add a description of
122 the preset that will be displayed when using --list-presets.
123 -s, --sysroot SYSROOT
125 Specify an alternate root file system path. Useful for collect‐
126 ing reports from containers and images.
127 -c, --chroot {auto|always|never}
129 Set the chroot mode. When --sysroot is used commands default to
130 executing with SYSROOT as the root directory (unless disabled by
131 a specific plugin). This can be overriden by setting --chroot to
132 "always" (always chroot) or "never" (always run in the host
133 namespace).
134 --tmp-dir DIRECTORY
136 Specify alternate temporary directory to copy data as well as
137 the compressed report.
138 --list-profiles
140 Display a list of available profiles and the plugins that they
141 enable.
142 -p, --profile NAME
144 Only run plugins that correspond to the given profile. Multple
145 profiles may be specified as a comma-separated list; the set of
146 plugins executed is the union of each of the profile's plugin
147 sets. Currently defined profiles include: boot, cluster, desk‐
148 top, debug, hardware, identity, network, openstack, packageman‐
149 ager, security, services, storage, sysmgmt, system, performance,
150 virt, and webserver.
151 --verify
153 Instructs plugins to perform plugin-specific verification during
154 data collection. This may include package manager verification,
155 log integrity testing or other plugin defined behaviour. Use of
156 --verify may cause the time taken to generate a report to be
157 considerably longer.
158 --log-size
160 Places a global limit on the size (in MiB) of any collected set
161 of logs. The limit is applied separately for each set of logs
162 collected by any plugin.
163 --all-logs
165 Tell plugins to collect all possible log data ignoring any size
166 limits and including logs in non-default locations. This option
167 may significantly increase the size of reports.
168 -z, --compression-type METHOD
170 Override the default compression type specified by the active
171 policy.
172 --encrypt-key KEY
174 Encrypts the resulting archive that sosreport produces using
175 GPG. KEY must be an existing key in the user's keyring as GPG
176 does not allow for keyfiles. KEY can be any value accepted by
177 gpg's 'recipient' option.
178 Note that the user running sosreport must match the user owning
180 the keyring from which keys will be obtained. In particular this
181 means that if sudo is used to run sosreport, the keyring must
182 also be set up using sudo (or direct shell access to the
183 account).
184 Users should be aware that encrypting the final archive will
186 result in sos using double the amount of temporary disk space -
187 the encrypted archive must be written as a separate, rather than
188 replacement, file within the temp directory that sos writes the
189 archive to. However, since the encrypted archive will be the
190 same size as the original archive, there is no additional space
191 consumption once the temporary directory is removed at the end
192 of execution.
193 This means that only the encrypted archive is present on disk
195 after sos finishes running.
196 If encryption fails for any reason, the original unencrypted ar‐
198 chive is preserved instead.
199 --encrypt-pass PASS
201 The same as --encrypt-key, but use the provided PASS for symmet‐
202 ric encryption rather than key-pair encryption.
203 --batch
205 Generate archive without prompting for interactive input.
206 --name NAME
208 Deprecated. See --label
209 --label LABEL
211 Specify an arbitrary identifier to associate with the archive.
212 Labels will be appended after the system's short hostname and
213 may contain alphanumeric characters.
214 --threads THREADS
216 Specify the number of threads sosreport will use for concur‐
217 rency. Defaults to 4.
218 --plugin-timeout TIMEOUT
220 Specify a timeout in seconds to allow each plugin to run for. A
221 value of 0 means no timeout will be set.
222 Note that this options sets the timeout for all plugins. If you
224 want to set a timeout for a specific plugin, use the 'timeout'
225 plugin option available to all plugins - e.g. '-k logs.time‐
226 out=600'.
227 The plugin-specific timeout option will override this option.
229 For example, using ´--plugin-timeout=60 -k logs.timeout=600´
230 will set a timeout of 600 seconds for the logs plugin and 60
231 seconds for all other enabled plugins.
232 --case-id NUMBER
234 Specify a case identifier to associate with the archive. Iden‐
235 tifiers may include alphanumeric characters, commas and periods
236 ('.'). Synonymous with --ticket-number.
237 --ticket-number NUMBER
239 Specify a ticket number or other identifier to associate with
240 the archive. Identifiers may include alphanumeric characters,
241 commas and periods ('.'). Synonymous with --case-id.
242 --build
244 Do not archive copied data. Causes sosreport to leave an uncom‐
245 pressed archive as a temporary file or directory tree.
246 --debug
248 Enable interactive debugging using the python debugger. Excep‐
249 tions in sos or plug-in code will cause a trap to the pdb shell.
250 --dry-run
252 Execute plugins as normal, but do not collect any file content,
253 command output, or string data from the system. The resulting
254 logs may be used to understand the actions that sos would have
255 taken without the dry run option.
256 --experimental
258 Enable plugins marked as experimental. Experimental plugins may
259 not have been tested for this port or may still be under active
260 development.
261 --help Display usage message.
263
265 Bryn M. Reeves <bmr@redhat.com>
266
268 See AUTHORS file in the package documentation.
269
271 Translations are handled by transifex (https://fedorahosted.org/transifex/)
272 Mon Mar 25 2013 SOSREPORT(1)