aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorBryn M. Reeves <bmr@redhat.com>2014-09-16 11:07:44 +0100
committerBryn M. Reeves <bmr@redhat.com>2014-09-16 11:08:03 +0100
commit2b9cf8b0746c0125d4e4516b03d3add39d0adaad (patch)
tree73d2b591a18e905e36f6e11b71abcbc15642471e /man
parent9bfe802436f5707b38bfbcf83795ee0629939542 (diff)
downloadsos-2b9cf8b0746c0125d4e4516b03d3add39d0adaad.tar.gz
[sosreport] initial profiles support
Add simple profile support. Plugins can define a 'profiles' attribute that contains a list of profile names that this plugin belongs to. If a profile is given on the command line only plugins belonging to that profile will run. Two new command-line options are introduced in thie commit: --list-profiles --profile=NAME Profiles can be combined with -l/--list-plugins in order to see the effect of the profile on the set of enabled plugins. Fixes #247. Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/en/sosreport.124
1 files changed, 18 insertions, 6 deletions
diff --git a/man/en/sosreport.1 b/man/en/sosreport.1
index df4f1cd3..5cc0298c 100644
--- a/man/en/sosreport.1
+++ b/man/en/sosreport.1
@@ -12,15 +12,16 @@ sosreport \- Collect and package diagnostic and support data
[--batch] [--build] [--debug]\fR
[--name name] [--case-id id] [--ticket-number nr]
[--tmp-dir directory]\fR
+ [-p|--profile profile-name]\fR
+ [--list-profiles]\fR
[-z|--compression-type method]\fR
[--help]\fR
.SH DESCRIPTION
-\fBsosreport\fR generates a compressed tar archive of diagnostic
-information from the running system. The archive may be stored
-locally or centrally 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.
+\fBsosreport\fR generates an archive of configuration and diagnostic
+information from the running system. The archive may be stored locally
+or centrally 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.
.LP
Sos is modular in design and is able to collect data from a wide
range of subsystems and packages that may be installed. An
@@ -69,6 +70,17 @@ Specify alternate configuration file.
Specify alternate temporary directory to copy data as well as the
compressed report.
.TP
+.B \--list-profiles
+Display a list of available profiles and the plugins that they enable.
+.TP
+.B \-p, \--profile NAME
+Only run plugins that correspond to the given profile. Multple profiles
+may be specified as a comma-separated list; the set of plugins executed
+is the union of each of the profile's plugin sets. Currently defined
+profiles include: boot, cluster, desktop, debug, hardware, identity,
+network, openstack, packagemanager, security, services, storage,
+sysmgmt, system, performance, virt, and webserver.
+.TP
.B \-z, \--compression-type METHOD
Override the default compression type specified by the active policy.
.TP