SOSREPORT(1) General Commands Manual SOSREPORT(1)
NAME
sosreport - Collect and package diagnostic and support data
SYNOPSIS
sosreport
[-l|--list-plugins]
[-n|--skip-plugins plugin-names]
[-e|--enable-plugins plugin-names]
[-o|--only-plugins plugin-names]
[-a|--alloptions] [-v|--verbose]
[--report] [--config-file conf] [--batch]
[--build] [--name name] [--ticket-number number]
[--debug] [--tmp-dir directory]
[--profile] [--help]
DESCRIPTION
sosreport generates a compressed tar archive of diagnostic information from the running system. The archive may be stored locally or cen-
trally for recording or tracking purposes or may be sent to technical support representatives, developers or system administrators to
assist with technical fault-finding and debugging.
Sos is modular in design and is able to collect data from a wide range of subsystems and packages that may be installed. An XML or HTML
report summarizing the collected information is optionally generated and stored within the archive.
OPTIONS
-l, --list-plugins
List all available plugins and their options. Plug-ins that would not be enabled by the current configuration are listed separately.
-n, --skip-plugins PLUGNAME[,PLUGNAME]
Disable the specified plugin(s). Multiple plug-ins may be specified by repeating the option or as a comma-separated list.
-e, --enable-plugins PLUGNAME[,PLUGNAME]
Enable the specified plugin(s). Multiple plug-ins may be specified by repeating the option or as a comma-separated list.
-o, --only-plugins PLUGNAME[,PLUGNAME]
Enable the specified plugin(s) only (all other plugins should be disabled). Multiple plugins may be specified by repeating the
option or as a comma-separated list.
-k PLUGNAME.PLUGOPT[=VALUE]
Specify plug-in options. The option PLUGOPT is enabled, or set to the specified value in the plug-in PLUGNAME.
-a, --alloptions
Set all boolean options to True for all enabled plug-ins.
-v, --verbose
Increase logging verbosity. May be specified multiple times to enable additional debugging messages.
-q, --quiet
Only log fatal errors to stderr.
--report
Enable HTML/XML report writing.
--config-file CONFIG
Specify alternate configuration file.
--tmp-dir DIRECTORY
Specify alternate temporary directory to copy data as well as the compressed report.
--batch
Generate archive without prompting for interactive input.
--name NAME
Specify a name to be used for the archive.
--ticket-number NUMBER
Specify a ticket number to be used for archive
--build
Do not archive copied data. Causes sosreport to leave an uncompressed archive as a temporary file or directory tree.
--debug
Enable interactive debugging using the python debugger. Exceptions in sos or plug-in code will cause a trap to the pdb shell.
--profile
Enable profiler logging.
--help Display usage message.
MAINTAINER
Bryn M. Reeves <bmr@redhat.com>
AUTHORS &; CONTRIBUTORS
See AUTHORS file in /usr/share/doc/sosreport.
TRANSLATIONS
Translations are handled by transifex (https://fedorahosted.org/transifex/)
Mon Mar 25 2013 SOSREPORT(1)