clustersosreport man page

clustersosreport — Collect sosreports from multiple (cluster) nodes


[--case-id CASE_ID]
[--cluster-type CLUSTER_TYPE]
[--name NAME]
[--nodes NODES]
[--master MASTER]
[--ssh-user SSH_USER]
[--timeout TIMEOUT]
[--tmp-dir TMP_DIR]


clustersosreport is a utility to collect sosreports from multiple nodes and package them in a single useful tar archive.

clustersosreport can be run either on a workstation that has SSH key authentication setup for the nodes in a given cluster, or from a "master" node in a cluster that has SSH keys configured for the other nodes.

Some sosreport options are supported by clustersosreport and are passed directly to  the sosreport command run on each node.

optional arguments

-a, --alloptions

Enables all sosreport options.

This does NOT enable all clustersosreport options.


Sosreport option. Collects all logs regardless of size.

Default: no

--case-id CASE_ID

Sosreport option. Specifies a case number identifier.

--cluster-type CLUSTER_TYPE

When run by itself, clustersosreport will attempt to identify the type of cluster at play. This is done by checking package or configuration information against the localhost, or the master node if  "--master" is supplied.

Setting --cluster-type skips this step and forcibly sets a particular profile.

Example: clustersosreport --cluster-type=kubernetes will force the kubernetes profile to be run, and thus set sosreport options and attempt to determine a list of nodes using that profile.


Sosreport option. Use this to enable a plugin that would otherwise not be run.

This option supports providing a comma-delimited list of plugins.


Sosreport option. Set a plugin option to a particular value. This takes the form of plugin_name.option_name=value.

Example: To enable the kubernetes "all" option in sosreport use -k kubernetes.all=on.

-n SKIP_PLUGINS, --skip-plugins SKIP_PLUGINS

Sosreport option. Disable (skip) a particular plugin that would otherwise run. This is useful if a particular plugin is prone to hanging for one reason or another.

This option supports providing a comma-delimited list of plugins.

--name NAME

Sosreport option. Specify a customer/user name for the sosreport.

Providing this will cause clustersosreport to not prompt for one when executed.

--nodes NODES

Provide a comma-delimited list of nodes to collect sosreports from.

Providing this option causes a cluster's profile to not discover a list of nodes on its own.


Do not perform package checks. Most cluster profiles check against installed packages to determine if the cluster profile should be applied or not.

Use this with --cluster-type if there are rpm or apt issues on the master/local node.


Do not collect a sosreport from the local system.

If --master is not supplied, it is assumed that the host running sosreport is part of the cluster that is to be collected. Use this option to skip collection of a local sosreport.

This option is NOT needed if --master is provided.

--master MASTER

Specify a master node for the cluster.

If provided, then clustersosreport will check the master node, not localhost, for determining the type of cluster in use.

-o ONLY_PLUGINS, --only-plugins ONLY_PLUGINS

Sosreport option. Run ONLY the plugins listed.

Note that a cluster profile will NOT override this option. This may cause the sosreports generated to not contain the relevant output for a given type of cluster.

This option supports providing a comma-delimited list of plugins.

-p SSH_PORT, --ssh-port SSH_PORT

Specify SSH port for all nodes. Use this if SSH runs on any port other than 22.

--ssh-user SSH_USER

Specify an SSH user for clustersosreport to connect to nodes with. Default is root.

As clustersosreport requires the use of SSH key authentication, this user must be a sudoer, and as such it will prompt you for a sudo password.

--timeout TIMEOUT

Timeout for sosreport generation on each node, in seconds.

Note that sosreports are collected in parallel, so this can also be considered to be approximately the same as a timeout for the entire collection process.

Default is 180 seconds.

--tmp-dir TMP_DIR

Specify a temporary directory to save sos archives to. By default one will be created in /tmp and then removed after clustersosreport has finished running.

This is NOT the same as specifying a temporary directory for sosreport on the remote nodes.

   Jake Hunsaker <>


June 2017