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 [--batch] [--build] [--debug]
18 [--name name] [--case-id id] [--ticket-number nr]
19 [--tmp-dir directory]
20 [-p|--profile profile-name]
21 [--list-profiles]
22 [--verify]
23 [--log-size]
24 [--all-logs]
25 [-z|--compression-type method]
26 [-h|--help]
27
30 sosreport generates an archive of configuration and diagnostic informa‐
31 tion from the running system. The archive may be stored locally or cen‐
32 trally for recording or tracking purposes or may be sent to technical
33 support representatives, developers or system administrators to assist
34 with technical fault-finding and debugging.
35 Sos is modular in design and is able to collect data from a wide range
37 of subsystems and packages that may be installed. An XML or HTML report
38 summarizing the collected information is optionally generated and
39 stored within the archive.
40
42 -l, --list-plugins
43 List all available plugins and their options. Plug-ins that
44 would not be enabled by the current configuration are listed
45 separately.
46 -n, --skip-plugins PLUGNAME[,PLUGNAME]
48 Disable the specified plugin(s). Multiple plug-ins may be speci‐
49 fied by repeating the option or as a comma-separated list.
50 -e, --enable-plugins PLUGNAME[,PLUGNAME]
52 Enable the specified plugin(s). Multiple plug-ins may be speci‐
53 fied by repeating the option or as a comma-separated list.
54 -o, --only-plugins PLUGNAME[,PLUGNAME]
56 Enable the specified plugin(s) only (all other plugins should be
57 disabled). Multiple plugins may be specified by repeating the
58 option or as a comma-separated list.
59 -k PLUGNAME.PLUGOPT[=VALUE], --plugin-option=PLUGNAME.PLUGOPT[=VALUE]
61 Specify plug-in options. The option PLUGOPT is enabled, or set
62 to the specified value in the plug-in PLUGNAME.
63 -a, --alloptions
65 Set all boolean options to True for all enabled plug-ins.
66 -v, --verbose
68 Increase logging verbosity. May be specified multiple times to
69 enable additional debugging messages.
70 -q, --quiet
72 Only log fatal errors to stderr.
73 --no-report
75 Disable HTML/XML report writing.
76 --config-file CONFIG
78 Specify alternate configuration file.
79 --tmp-dir DIRECTORY
81 Specify alternate temporary directory to copy data as well as
82 the compressed report.
83 --list-profiles
85 Display a list of available profiles and the plugins that they
86 enable.
87 -p, --profile NAME
89 Only run plugins that correspond to the given profile. Multple
90 profiles may be specified as a comma-separated list; the set of
91 plugins executed is the union of each of the profile's plugin
92 sets. Currently defined profiles include: boot, cluster, desk‐
93 top, debug, hardware, identity, network, openstack, packageman‐
94 ager, security, services, storage, sysmgmt, system, performance,
95 virt, and webserver.
96 --verify
98 Instructs plugins to perform plugin-specific verification during
99 data collection. This may include package manager verification,
100 log integrity testing or other plugin defined behaviour. Use of
101 --verify may cause the time taken to generate a report to be
102 considerably longer.
103 --log-size
105 Places a global limit on the size of any collected set of logs.
106 The limit is applied separately for each set of logs collected
107 by any plugin.
108 --all-logs
110 Tell plugins to collect all possible log data ignoring any size
111 limits and including logs in non-default locations. This option
112 may significantly increase the size of reports.
113 -z, --compression-type METHOD
115 Override the default compression type specified by the active
116 policy.
117 --batch
120 Generate archive without prompting for interactive input.
121 --name NAME
123 Specify a name to be used for the archive.
124 --case-id NUMBER
126 Specify a case identifier to associate with the archive.
127 Identifiers may include alphanumeric characters, commas
128 and periods ('.'). Synonymous with --ticket-number.
129 --ticket-number NUMBER
131 Specify a ticket number or other identifier to associate
132 with the archive. Identifiers may include alphanumeric
133 characters, commas and periods ('.'). Synonymous with
134 --case-id.
135 --build
137 Do not archive copied data. Causes sosreport to leave an
138 uncompressed archive as a temporary file or directory
139 tree.
140 --debug
142 Enable interactive debugging using the python debugger.
143 Exceptions in sos or plug-in code will cause a trap to
144 the pdb shell.
145 --help Display usage message.
147
149 Bryn M. Reeves <bmr@redhat.com>
150
152 See AUTHORS file in /usr/share/doc/sosreport.
153
155 Translations are handled by transifex (https://fedorahosted.org/transifex/)
156 Mon Mar 25 2013 SOSREPORT(1)