aboutsummaryrefslogtreecommitdiffstats
path: root/man/en
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2021-09-28 13:00:17 -0400
committerJake Hunsaker <jhunsake@redhat.com>2021-10-29 12:47:28 -0400
commitf4af5efdc79aefe1aa685c36d095925bae14dc4a (patch)
treec2c73c7932cfba0c600f3ed2051b597194918fc6 /man/en
parentf827192424f2a4b9b390816c10b08dff658e0d74 (diff)
downloadsos-f4af5efdc79aefe1aa685c36d095925bae14dc4a.tar.gz
[collect] Add --transport option and allow clusters to set transport type
Adds a new `--transport` option for users to be able to specify the type of transport to use when connecting to nodes. The default value of `auto` will defer to the cluster profile to set the transport type, which will continue to default to use OpenSSH's ControlPersist feature. Clusters may override the new `set_transport_type()` method to change the default transport used. If `--transport` is anything besides `auto`, then the cluster profile will not be deferred to when choosing a transport for each remote node. Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man/en')
-rw-r--r--man/en/sos-collect.115
1 files changed, 15 insertions, 0 deletions
diff --git a/man/en/sos-collect.1 b/man/en/sos-collect.1
index e930023e..8ad4fe5e 100644
--- a/man/en/sos-collect.1
+++ b/man/en/sos-collect.1
@@ -43,6 +43,7 @@ sos collect \- Collect sosreports from multiple (cluster) nodes
[\-\-sos-cmd SOS_CMD]
[\-t|\-\-threads THREADS]
[\-\-timeout TIMEOUT]
+ [\-\-transport TRANSPORT]
[\-\-tmp\-dir TMP_DIR]
[\-v|\-\-verbose]
[\-\-verify]
@@ -351,6 +352,20 @@ runtime of sos collect via timeout*(number of nodes/jobs).
Default is 180 seconds.
.TP
+\fB\-\-transport\fR TRANSPORT
+Specify the type of remote transport to use to manage connections to remote nodes.
+
+\fBsos collect\fR uses locally installed binaries to connect to and interact with remote
+nodes, instead of directly establishing those connections. By default, OpenSSH's ControlPersist
+feature is preferred, however certain cluster types may have preferences of their own for how
+remote sessions should be established.
+
+The types of transports supported are currently as follows:
+
+ \fBauto\fR Allow the cluster type to determine the transport used
+ \fBcontrol_persist\fR Use OpenSSH's ControlPersist feature. This is the default behavior
+
+.TP
\fB\-\-tmp\-dir\fR TMP_DIR
Specify a temporary directory to save sos archives to. By default one will be created in
/tmp and then removed after sos collect has finished running.