Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pkittenis committed Oct 21, 2014
1 parent 907dc22 commit fdc5dcc
Showing 1 changed file with 39 additions and 3 deletions.
42 changes: 39 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,46 @@ Run `ls` on two remote hosts in parallel.
[localhost] drwxr-xr-x 6 xxx xxx 4.0K Jan 1 00:00 xxx
[{'localhost': {'exit_code': 0}}]

**************************
Frequently asked questions
**************************

************
SFTP support
************
Q.
Are SSH agent used?

A.
All available keys in a running SSH agent in addition to SSH keys in the user's home directory, `~/.ssh/id_dsa`, `~/.ssh/id_rsa` et al are automatically used by ParallelSSH.

Q.
Can ParallelSSH forward my SSH agent?

A.
SSH agent forwarding, what `ssh -A` does on the command line, is supported and enabled by default. Creating an object as `ParallelSSH(forward_ssh_agent=False)` will disable that behaviour.

Q.
Is proxying supported?

A.
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`.

::

Host target
ProxyCommand ssh bastion -W %h:%p

Q.
Is there a way to programmatically provide an SSH key?

A.
Yes, use the `pkey` parameter of the `ParallelSSHClient class <http://parallel-ssh.readthedocs.org/en/latest/#pssh.ParallelSSHClient>`_. For example:

>>> import paramiko
>>> my_key = paramiko.RSAKey.from_private_key_file(my_rsa_key)
>>> client = ParallelSSHClient(pkey=my_key)

********
SFTP/SCP
********

SFTP is supported (scp version 2) natively, no scp command used.

Expand Down

0 comments on commit fdc5dcc

Please sign in to comment.