SOSREPORT

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
MAINTAINER
TRANSLATIONS

NAME

sosreport − Generate debugging information for this system

SYNOPSIS

sosreport [-l|--list-plugins] [-n|--skip-plugins plugin-names] [-e|--enable-plugins plugin-names] [-o|--only-plugins plugin-names] [-a|--alloptions] [-v|--verbose] [--diagnose] [--analyze] [--report] [--config-file conf] [--batch] [--build] [--name name] [--no-colors] [--ticket-number number] [--debug] [--upload] [--tmp-dir directory] [--profile] [--help]

DESCRIPTION

sosreport generates a compressed tarball of debugging information for the system it is run on that can be sent to technical support reps that will give them a more complete view of the overall system status.

OPTIONS

−l, −-list-plugins

This will list all available plugins showing which ones will be enabled by the current configuration. It will also show all plugin options which can be modified using the -k option (see below).

−n, --skip-plugins PLUGNAME[,PLUGNAME]

Do not load specified plugin(s). To specify multiple plugins, separate them with a comma.

−e, --enable-plugins PLUGNAME[,PLUGNAME]

Enable the specified plugin(s). To specify multiple plugins, separate them with a comma.

−o, --only-plugins PLUGNAME[,PLUGNAME]

Enable the specified plugin(s) only (all other plugins should be disabled). To specify multiple plugins, separate them with a comma.

−k PLUGNAME.PLUGOPT[=VALUE]

This is used to specify options for plugins. A list of available plugin options can be obtained from the output of --list-plugins. If no value is specified and the option is a boolean (on/off), it will be set to "on".

−a, −-alloptions

Enable all (boolean) options for all loaded plugins.

−-upload FTP_SERVER

Upload the report to Red Hat (use exclusively if advised from a Red Hat support representative).

−v, −-verbose

Increase the verbosity of the output as sosreport is running. Multiple -v mean more verbosity.

−-diagnose

Turn on diagnostic functions

−-analyze

Turn on analyzation functions

−-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

Perform data gathering unattended

−-name NAME

Define a unique name for archive

−-ticket-number NUMBER

Define a unique number for archive

−-build

Do not archive copied data, leave directory tree untouched for further modification

−-no-colors

Disable colors written to console

−-debug

Give opportunity to debug python exceptions through the python debugger.

−-profile

Turn on profiling for cmds run

−-help

Display sosreport help system.

MAINTAINER

Adam Stokes <astokes@fedoraproject.org>

TRANSLATIONS

Translations are handled by transifex (https://fedorahosted.org/transifex/)