Parallel-SSH Documentation

parallel-ssh is a non-blocking parallel SSH client library.

It provides clients based on C libraries with an easy to use Python API providing native code levels of performance and stability.

In a nutshell

Client will attempt to use all available keys under ~/.ssh as well as any keys in an SSH agent, if one is available.

from pssh.clients import ParallelSSHClient

client = ParallelSSHClient(['localhost', 'localhost'])
output = client.run_command('uname')
for host_out in output:
    for line in host_out.stdout:
        print(line)
    exit_code = host_out.exit_code

Output:

<Uname output>
<Uname output>

Single Host Client

Single host client is also available with similar API.

from pssh.clients import SSHClient

client = SSHClient('localhost')
host_out = client.run_command('uname')
for line in host_out.stdout:
    print(line)
exit_code = host_out.exit_code

Output:

<Uname output>

• Design And Goals
  • Design Principles
• Installation
  • Pip Install
  • From Source Dependencies
  • Building from Source
  • Python 2
• Quickstart
  • Run a command on hosts in parallel
  • Single Host Client
  • Step by Step
  • Run Command Output
  • Exit codes
  • Authentication
  • Output for Last Executed Commands
  • Host Logger
  • Using standard input
  • Errors and Exceptions
• Advanced Usage
  • Agents and Private Keys
  • Native Clients
  • Proxy Hosts and Tunneling
  • Join and Output Timeouts
  • Per-Host Configuration
  • Per-Host Command substitution
  • Run command features and options
  • SFTP and SCP
  • Interactive Shells
  • Hosts filtering and overriding
  • IPv6 Addresses
• API Documentation
  • Native Parallel Client
  • Native Single Host Client
  • ssh-python Parallel Client
  • ssh-python Single Host Client
  • Base Parallel Client
  • Base Single Client
  • Host Output
  • Host Config
  • Native Tunnel
  • Output reader/writer
  • Utility functions
  • Exceptions
  • Constants
• Clients Feature Comparison
• Scaling
  • Technical Details
• Comparison With Alternatives
  • Paramiko
  • asyncssh
  • Fabric
  • Ansible
  • ssh2-python
  • ssh-python
• Change Log
  • 2.13.0
  • 2.12.0
  • 2.11.1
  • 2.11.0
  • 2.10.0
  • 2.9.1
  • 2.9.0
  • 2.8.0
  • 2.7.1
  • 2.7.0
  • 2.6.0
  • 2.5.4
  • 2.5.3
  • 2.5.2
  • 2.5.1
  • 2.5.0
  • 2.4.0
  • 2.3.2
  • 2.3.1
  • 2.3.0
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.13.0
  • 1.12.1
  • 1.12.0
  • 1.11.2
  • 1.11.0
  • 1.10.0
  • 1.9.1
  • 1.9.0
  • 1.8.2
  • 1.8.1
  • 1.8.0
  • 1.7.0
  • 1.6.3
  • 1.6.2
  • 1.6.1
  • 1.6.0
  • 1.5.5
  • 1.5.4
  • 1.5.2
  • 1.5.1
  • 1.5.0
  • 1.4.0
  • 1.3.2
  • 1.3.1
  • 1.3.0
  • 1.2.1
  • 1.2.0
  • 1.1.1
  • 1.1.0
  • 1.0.0
• Upgrading to API 2.0
  • Parallel Client Run Command
  • Parallel Client Get last output
  • Single Client Run Command

Indices and tables

• Index