SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from CentOS Other sos-4.1-4.el8.noarch.rpm

SOSREPORT

Section: User Commands (1)
Updated: Mon Mar 25 2013
Index 

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]
          [-k plug.opt|--plugin-option plug.opt]
          [--no-report] [--config-file conf]
          [--no-postproc]
          [--preset preset] [--add-preset add_preset]
          [--del-preset del_preset] [--desc description]
          [--batch] [--build] [--debug] [--dry-run]
          [--label label] [--case-id id]
          [--threads threads]
          [--plugin-timeout TIMEOUT]
          [--cmd-timeout TIMEOUT]
          [-s|--sysroot SYSROOT]
          [-c|--chroot {auto|always|never}
          [--tmp-dir directory]
          [-p|--profile profile-name]
          [--list-profiles]
          [--verify]
          [--log-size]
          [--all-logs]
          [--since YYYYMMDD[HHMMSS]]
          [--skip-commands commands]
          [--skip-files files]
          [--allow-system-changes]
          [-z|--compression-type method]
          [--encrypt-key KEY]
          [--encrypt-pass PASS]
          [--upload] [--upload-url url] [--upload-user user]
          [--upload-directory dir] [--upload-pass pass]
          [--experimental]
          [-h|--help]

 

DESCRIPTION

report is an sos subcommand that generates an archive ofconfiguration and diagnostic information from the running system.The archive may be stored locally or centrally for recording ortracking purposes or may be sent to technical support representatives,developers or system administrators to assist with technicalfault-finding and debugging.

Sos is modular in design and is able to collect data from a widerange of subsystems and packages that may be installed. AnHTML report summarizing the collected information is optionallygenerated and stored within the archive. 

OPTIONS

-l, --list-plugins
List all available plugins and their options. Plug-ins that wouldnot be enabled by the current configuration are listed separately.
-n, --skip-plugins PLUGNAME[,PLUGNAME]
Disable the specified plugin(s). Multiple plug-ins may be specifiedby repeating the option or as a comma-separated list.
-e, --enable-plugins PLUGNAME[,PLUGNAME]
Enable the specified plugin(s). Multiple plug-ins may be specifiedby repeating the option or as a comma-separated list.
-o, --only-plugins PLUGNAME[,PLUGNAME]
Enable the specified plugin(s) only (all other plugins should bedisabled). Multiple plugins may be specified by repeating the optionor as a comma-separated list.
-k PLUGNAME.PLUGOPT[=VALUE], --plugin-option=PLUGNAME.PLUGOPT[=VALUE]
Specify plug-in options. The option PLUGOPT is enabled, or set to thespecified 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 enableadditional debugging messages.
-q, --quiet
Only log fatal errors to stderr.
--no-report
Disable HTML report writing.
--config-file CONFIG
Specify alternate configuration file.
--no-postproc
Disable postprocessing globally for all plugins. This will mean data is notobfuscated/sanitized from the archive during collection.

Note that this means data such as password, SSH keys, certificates, etc...will be collected in plain text.

To selectively disable postprocessing on a per-plugin basis, use the 'postproc'plugin option available to all plugins, e.g. '-k podman.postproc=off'.

--preset PRESET
Specify an existing preset to use for sos options.

Presets are pre-configured sets of options for both sos and sos plugins. Forexample a preset may enable a certain set of plugins, disable others, or enablespecific plugin options. They may also specify sos options such as log-size orpackage verification.

User defined presets are saved under /var/lib/sos/presets as JSON-formatted files.

--add-preset ADD_PRESET [options]
Add a preset with name ADD_PRESET that enables [options] when called.

For example, 'sos report --add-preset mypreset --log-size=50 -n logs' will enablea user to run 'sos report --preset mypreset' that sets the maximum log size to50 and disables the logs plugin.

Note: to set a description for the preset that is displayed with --list-presets,use the --desc option.

Note: to set a behaviour note of the preset, use --note option.

Note: The root filesystem, as seen by sos if running within a container, must bewritable to save presets using this option.

--del-preset DEL_PRESET
Deletes the preset with name DEL_PRESET from the filesystem so that it can nolonger be used.
--list-presets
Display a list of available presets and what options they carry.
--desc DESCRIPTION
When using --add-preset use this option to add a description of the presetthat will be displayed when using --list-presets.
-s, --sysroot SYSROOT
Specify an alternate root file system path. Useful for collectingreports from containers and images.
-c, --chroot {auto|always|never}
Set the chroot mode. When --sysroot is used commands default toexecuting with SYSROOT as the root directory (unless disabled bya specific plugin). This can be overridden by setting --chroot to"always" (always chroot) or "never" (always run in the hostnamespace).
--tmp-dir DIRECTORY
Specify alternate temporary directory to copy data as well as thecompressed report.
--list-profiles
Display a list of available profiles and the plugins that they enable.
-p, --profile, --profiles NAME
Only run plugins that correspond to the given profile. Multiple profilesmay be specified as a comma-separated list; the set of plugins executedis the union of each of the profile's plugin sets. Currently definedprofiles include: boot, cluster, desktop, debug, hardware, identity,network, openstack, packagemanager, security, services, storage,sysmgmt, system, performance, virt, and webserver.
--verify
Instructs plugins to perform plugin-specific verification during datacollection. This may include package manager verification, log integritytesting or other plugin defined behaviour. Use of --verify may causethe time taken to generate a report to be considerably longer.
--log-size
Places a global limit on the size (in MiB) of any collected set of logs. Thelimit is applied separately for each set of logs collected by anyplugin.
--all-logs
Tell plugins to collect all possible log data ignoring any size limitsand including logs in non-default locations. This option may significantlyincrease the size of reports.
--since YYYYMMDD[HHMMSS]
Limits the collection of log archives to those newer than this date. A logarchive is any file not found in /etc, that has either a numeric or acompression-type file extension for example ".zip". ".1", ".gz" etc.).This also affects --all-logs. The date string will be padded with zerosif HHMMSS is not specified.
--skip-commands COMMANDS
A comma delimited list of commands to skip execution of, but still allowing therest of the plugin that calls the command to run. This will generally need tobe some form of UNIX shell-style wildcard matching. For example, using a valueof hostname will skip only that single command, while using hostname*will skip all commands with names that begin with the string "hostname".
--skip-files FILES
A comma delimited list of files or filepath wildcard matches to skip collectionof. Values may either be exact filepaths or paths using UNIX shell-style wildcards,for example /etc/sos/*.
--allow-system-changes
Run commands even if they can change the system (e.g. load kernel modules).
-z, --compression-type METHOD
Override the default compression type specified by the active policy.
--encrypt-key KEY
Encrypts the resulting archive that sosreport produces using GPG. KEY must bean existing key in the user's keyring as GPG does not allow for keyfiles.KEY can be any value accepted by gpg's 'recipient' option.

Note that the user running sosreport must match the user owning the keyringfrom which keys will be obtained. In particular this means that if sudo isused to run sosreport, the keyring must also be set up using sudo(or direct shell access to the account).

Users should be aware that encrypting the final archive will result in sosusing double the amount of temporary disk space - the encrypted archive must bewritten as a separate, rather than replacement, file within the temp directorythat sos writes the archive to. However, since the encrypted archive will bethe same size as the original archive, there is no additional space consumptiononce the temporary directory is removed at the end of execution.

This means that only the encrypted archive is present on disk after sosfinishes running.

If encryption fails for any reason, the original unencrypted archive ispreserved instead.

--encrypt-pass PASS
The same as --encrypt-key, but use the provided PASS for symmetric encryptionrather than key-pair encryption.
--batch
Generate archive without prompting for interactive input.
--name NAME
Deprecated. See --label
--label LABEL
Specify an arbitrary identifier to associate with the archive.Labels will be appended after the system's short hostname and may containalphanumeric characters.
--threads THREADS
Specify the number of threads sosreport will use for concurrency. Defaults to 4.
--plugin-timeout TIMEOUT
Specify a timeout in seconds to allow each plugin to run for. A value of 0means no timeout will be set. A value of -1 is used to indicate the defaulttimeout of 300 seconds.

Note that this option sets the timeout for all plugins. If you want to seta timeout for a specific plugin, use the 'timeout' plugin option available toall plugins - e.g. '-k logs.timeout=600'.

The plugin-specific timeout option will override this option. For example, using'--plugin-timeout=60 -k logs.timeout=600' will set a timeout of 600 seconds forthe logs plugin and 60 seconds for all other enabled plugins.

--cmd-timeout TIMEOUT
Specify a timeout limit in seconds for a command execution. Same defaults logicfrom --plugin-timeout applies here.

This option sets the command timeout for all plugins. If you want to set a cmdtimeout for a specific plugin, use the 'cmd-timeout' plugin option available toall plugins - e.g. '-k logs.cmd-timeout=600'.

Again, the same plugin/global precedence logic as for --plugin-timeout applieshere.

Note that setting --cmd-timeout (or -k logs.cmd-timeout) high should be followedby increasing the --plugin-timeout equivalent, otherwise the plugin can easilytimeout on slow commands execution.

--case-id NUMBER
Specify a case identifier to associate with the archive.Identifiers may include alphanumeric characters, commas and periods ('.').
--build
Do not archive copied data. Causes sosreport to leave an uncompressedarchive as a temporary file or directory tree.
--debug
Enable interactive debugging using the python debugger. Exceptions insos or plug-in code will cause a trap to the pdb shell.
--dry-run
Execute plugins as normal, but do not collect any file content, commandoutput, or string data from the system. The resulting logs may be usedto understand the actions that sos would have taken without the dry runoption.
--upload
If specified, attempt to upload the resulting archive to a vendor defined location.

This option is implied if --upload-url is used.

You may be prompted for a username and password if these are not defined by the vendoras well. If these credentials are not provided, sos will still run and create an archivebut will not attempt an automatic upload, instead relying on the end user to upload itas needed.

The sosreport archive will still remain on the local filesystem even after a successfulupload.

Note that depending on the distribution sos is being run on, or the vendor policy detected duringexecution, there may be dependencies that are not strictly required by the packageat installation time.

For example, for HTTPS uploads the python-requests library must be available. If thislibrary is not available, HTTPS uploads will not be attempted.

--upload-url URL
If a vendor does not provide a default upload location, or if you would like to uploadthe archive to a different location, specify the address here.

A support protocol MUST be specified in this URL. Currently uploading is supportedfor HTTPS, SFTP, and FTP protocols.

If your destination server listens on a non-standard port, specify the listeningport in the URL.

--upload-user USER
If a vendor does not provide a default user for uploading, specify the username here.

If this option is unused and upload is request, and a vendor default is not set, youwill be prompted for one. If --batch is used and this option is omitted, no username willbe collected and thus uploads will fail if no vendor default is set.

You also have the option of providing this value via the SOSUPLOADUSER environmentvariable. If this variable is set, then no username prompt will occur and --batchmay be used provided all other required values (case number, upload password)are provided.

--upload-pass PASS
Specify the password to use for authentication with the destination server.

If this option is omitted and upload is requested, you will be prompted for one.

If --batch is used, this prompt will not occur, so any uploads are likely to fail unlessthis option is used.

Note that this will result in the plaintext string appearing in `ps` output that maybe collected by sos and be in the archive. If a password must be provided by youfor uploading, it is strongly recommended to not use --batch and enter the passwordwhen prompted rather than using this option.

You also have the option of providing this value via the SOSUPLOADPASSWORD environmentvariable. If this variable is set, then no password prompt will occur and --batch maybe used provided all other required values (case number, upload user) are provided.

--upload-directory DIR
Specify a directory to upload to, if one is not specified by a vendor default locationor if your destination server does not allow writes to '/'.
--experimental
Enable plugins marked as experimental. Experimental plugins may not havebeen tested for this port or may still be under active development.
--help
Display usage message.
 

SEE ALSO

sos(1)sos-clean(1)sos-collect(1)

 

MAINTAINER

Jake Hunsaker <jhunsakeAATTredhat.com>
 

AUTHORS & CONTRIBUTORS

See AUTHORS file in the package documentation.
 

TRANSLATIONS

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


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
SEE ALSO
MAINTAINER
AUTHORS & CONTRIBUTORS
TRANSLATIONS

This document was created byman2html,using the manual pages.