aboutsummaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2021-05-14 15:41:05 -0400
committerJake Hunsaker <jhunsake@redhat.com>2021-08-02 10:35:40 -0400
commit441f865981b314b5c07f49ecccb7d63bc4503588 (patch)
tree0f6381ad566621008333beb1ac1472507e531a0e /man
parente14e41538c9864b360184574e3a80a00ed4fd50a (diff)
downloadsos-441f865981b314b5c07f49ecccb7d63bc4503588.tar.gz
[sos|options] Add global 'namespaces' option
Adds a global `--namespaces` option that can be used to limit the number of namespaces all plugins will iterate over. If a plugin provides a specific plugin option, such as the `networking.namespaces` option, then if set that plugin option will override the global option value. The global option defaults to not limiting namespaces, matching current behavior. Closes: #2092 Resolves: #2547 Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/en/sos-report.110
1 files changed, 10 insertions, 0 deletions
diff --git a/man/en/sos-report.1 b/man/en/sos-report.1
index f6bd6c6a..36b337df 100644
--- a/man/en/sos-report.1
+++ b/man/en/sos-report.1
@@ -18,6 +18,7 @@ sos report \- Collect and package diagnostic and support data
[--threads threads]\fR
[--plugin-timeout TIMEOUT]\fR
[--cmd-timeout TIMEOUT]\fR
+ [--namespaces NAMESPACES]\fR
[-s|--sysroot SYSROOT]\fR
[-c|--chroot {auto|always|never}\fR
[--tmp-dir directory]\fR
@@ -289,6 +290,15 @@ Note that setting --cmd-timeout (or -k logs.cmd-timeout) high should be followed
by increasing the --plugin-timeout equivalent, otherwise the plugin can easily
timeout on slow commands execution.
.TP
+.B \--namespaces NAMESPACES
+For plugins that iterate collections over namespaces that exist on the system,
+for example the networking plugin collecting `ip` command output for each network
+namespace, use this option to limit the number of namespaces that will be collected.
+
+Use '0' (default) for no limit - all namespaces will be used for collections.
+
+Note that specific plugins may provide a similar `namespaces` plugin option. If
+the plugin option is used, it will override this option.
.B \--case-id NUMBER
Specify a case identifier to associate with the archive.
Identifiers may include alphanumeric characters, commas and periods ('.').