From 55ca9a849121b9058f8e0768eb4d4bef84db49ab Mon Sep 17 00:00:00 2001
From: Jake Hunsaker <jhunsake@redhat.com>
Date: Mon, 12 Oct 2020 12:33:30 -0400
Subject: [report] Allow users to specify commands and files to skip

Adds two new options, `--skip-commands` and `--skip-files`, that allow
users to selectively skip specific command or file collection instead of
having to disable whole plugins to skip those collections.

These options are also exposed via `sos collect`, being gated by a
version of 4.1 since that is the next scheduled release where we can
guarantee this functionality will be present.

Closes: #2203
Resolves: #2271

Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
---
 man/en/sos-report.1 | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'man/en/sos-report.1')

diff --git a/man/en/sos-report.1 b/man/en/sos-report.1
index 0a571d18..19fb6aae 100644
--- a/man/en/sos-report.1
+++ b/man/en/sos-report.1
@@ -26,6 +26,8 @@ sosreport \- Collect and package diagnostic and support data
           [--log-size]\fR
           [--all-logs]\fR
           [--since YYYYMMDD[HHMMSS]]\fR
+          [--skip-commands commands]\fR
+          [--skip-files files]\fR
           [--allow-system-changes]\fR
           [-z|--compression-type method]\fR
           [--encrypt-key KEY]\fR
@@ -180,6 +182,18 @@ compression-type file extension for example ".zip". ".1", ".gz" etc.).
 This also affects \--all-logs. The date string will be padded with zeros
 if HHMMSS is not specified.
 .TP
+.B \--skip-commands COMMANDS
+A comma delimited list of commands to skip execution of, but still allowing the
+rest of the plugin that calls the command to run. This will generally need to
+be some form of UNIX shell-style wildcard matching. For example, using a value
+of \fBhostname\fR will skip only that single command, while using \fBhostname*\fR
+will skip all commands with names that begin with the string "hostname".
+.TP
+.B \--skip-files FILES
+A comma delimited list of files or filepath wildcard matches to skip collection
+of. Values may either be exact filepaths or paths using UNIX shell-style wildcards,
+for example \fB/etc/sos/*\fR.
+.TP
 .B \--allow-system-changes
 Run commands even if they can change the system (e.g. load kernel modules).
 .TP
-- 
cgit