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