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


Section: User Commands (1)
Updated: April 2020



sos - A unified tool for collecting system logs and other debug information 


sos component [options]



sos is a diagnostic data collection utility, used by system administrators,support representatives, and the like to assist in troubleshooting issues witha system or group of systems.

The most well known function is sos report or sosreport as it waspreviously known.

An sos archive is typically requested by support organizations to collect baselineconfiguration and system data from which to begin the troubleshooting process.



sos supports several subcommands or components. Each provides a different setof information for the user. Supported components are as follows

Report generates an archive of system information including configuration filesand command output. Information included in the report is based upon plugins thatare activated automatically when certain criteria, such as installed packages, files,services, or system architecture is detected.

See sos report --help and man sos-report for more information.

May also be invoked via the alias rep or the deprecated command sosreport.

Collect is used to capture reports on multiple systems simultaneously. Thesesystems can either be defined by the user at the command line and/or defined byclustering software that exists either on the local system or on a "master" systemthat is able to inform about other nodes in the cluster.

When running collect, sos report will be run on the remote nodes, and then theresulting archives will be copied from those nodes to the local system runningsos collect. Archives are then removed from the remote systems.

See sos collect --help and man sos-collect for more information.

May also be invoked via the alias sos collector or the deprecated commandsos-collector.

This subcommand takes input of either 1) an sosreport tarball, 2) a collectionof sosreport tarballs such as from collect, or 3) the unpackageddirectory of an sosreport and obfuscates potentially sensitive system informationthat is not covered by the standard postprocessing of sos report.

Such data includes IP addresses, networks, MAC addresses, and more. Data obfuscatedby this command will remain consistent throughout the report and across reports providedin the same invocation. Additionally, care is taken to maintain network topology relationshipsbetween matched data items.

See sos clean --help and man sos-clean for more information.

May be invoked via either sos clean, sos cleaner, sos mask,or via the --clean, --cleaner or --mask optionsfor report and collect.



sos components provide their own set of options, however the following are availableto be set across all components.

--batchDo not prompt interactively, user will not be prompted for any data

--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.
--config-file CONFIG
Specify alternate configuration file.
-s, --sysroot SYSROOT
Specify an alternate root file system path.
--tmp-dir DIRECTORY
Specify alternate temporary directory to copy data during execution.
--threads THREADS
Specify the number of threads sosreport will use for concurrency. Defaults to 4.
-v, --verbose
Increase logging verbosity. May be specified multiple times to enableadditional debugging messages.
-q, --quiet
Only log fatal errors to stderr.
-z, --compression-type {auto|xz|gzip}
Compression type to use when compression the final archive output
Display usage message.


Jake Hunsaker <>


See AUTHORS file in the package documentation.




This document was created byman2html,using the manual pages.