Skip to content

Commit ae153e4

Browse files
author
Dan
committed
Updated readme
1 parent ad9fea4 commit ae153e4

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,11 @@ Stdout and stderr buffers are available in output. Iterating on them can be used
5555
Host myhost1 - output: drwxr-xr-x 6 xxx xxx 4.0K Jan 1 00:00 xxx
5656
Host myhost2 - output: drwxr-xr-x 6 xxx xxx 4.0K Jan 1 00:00 xxx
5757

58+
Joining on the connection pool can be used to block and wait for all parallel commands to finish if reading stdout/stderr is not required.
59+
60+
>>> client.pool.join()
61+
62+
5863
**************************
5964
Frequently asked questions
6065
**************************
@@ -82,10 +87,16 @@ Frequently asked questions
8287
SSH agent forwarding, what `ssh -A` does on the command line, is supported and enabled by default. Creating an object as `ParallelSSHClient(forward_ssh_agent=False)` will disable that behaviour.
8388

8489
:Q:
85-
Is proxying supported?
90+
Is tunneling/proxying supported?
8691

8792
:A:
88-
ParallelSSH supports proxies as defined in SSH's `ProxyCommand` configuration in `~/.ssh/config`. For example, the following entry in `~/.ssh/config` causes ParallelSSH to use host `bastion` as a proxy for host `target`. See the `SSH manual page <http://unixhelp.ed.ac.uk/CGI/man-cgi?ssh+1>`_ for more information on `ProxyCommand`.
93+
ParallelSSH natively supports tunelling through an intermediate SSH server. Connecting to a remote host is accomplished via an SSH tunnel using the SSH's protocol direct TCP tunneling feature, using local port forwarding. This is done natively in python and tunnel connections are asynchronous like all other connections in the ParallelSSH library. For example, client -> proxy SSH server -> remote SSH destination.
94+
95+
Use the `proxy_host` and `proxy_port` parameters to configure your proxy.
96+
97+
>>> client = ParallelSSHClient(hosts, proxy_host='my_ssh_proxy_host')
98+
99+
Note that while connections from the ParallelSSH client to the tunnel host are asynchronous, connections from the tunnel host to the remote destination(s) may not be, depending on the SSH server implementation. If the SSH server uses threading to implement its tunelling and that server is used to tunnel to a large number of remote destinations system load on the tunnel server will increase linearly according to number of remote hosts.
89100

90101
::
91102

0 commit comments

Comments
 (0)