aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2020-10-12 12:33:30 -0400
committerJake Hunsaker <jhunsake@redhat.com>2020-11-03 13:40:18 -0500
commit55ca9a849121b9058f8e0768eb4d4bef84db49ab (patch)
tree5951b559a6bc3acf88edd860bb9d32bd1740e52b /man
parenta5162c73ddd948085ca99fba81353104c54623de (diff)
downloadsos-55ca9a849121b9058f8e0768eb4d4bef84db49ab.tar.gz
[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>
Diffstat (limited to 'man')
-rw-r--r--man/en/sos-collect.114
-rw-r--r--man/en/sos-report.114
2 files changed, 28 insertions, 0 deletions
diff --git a/man/en/sos-collect.1 b/man/en/sos-collect.1
index 7d6f8b87..d4e5e648 100644
--- a/man/en/sos-collect.1
+++ b/man/en/sos-collect.1
@@ -30,6 +30,8 @@ sos collect \- Collect sosreports from multiple (cluster) nodes
[\-\-password]
[\-\-password\-per\-node]
[\-\-preset PRESET]
+ [\-\-skip-commands COMMANDS]
+ [\-\-skip-files FILES]
[\-s|\-\-sysroot SYSROOT]
[\-\-ssh\-user SSH_USER]
[\-\-sos-cmd SOS_CMD]
@@ -261,6 +263,18 @@ defined, or has a version of sos prior to 3.6, this option is ignored for that n
\fB\-p\fR SSH_PORT, \fB\-\-ssh\-port\fR SSH_PORT
Specify SSH port for all nodes. Use this if SSH runs on any port other than 22.
.TP
+\fB\-\-skip-commands\fR 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
+\fB\-\-skip-files\fR 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
\fB\-\-ssh\-user\fR SSH_USER
Specify an SSH user for sos collect to connect to nodes with. Default is root.
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