Parallel-SSH Documentation

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

It uses non-blocking asynchronous SSH sessions and is to date the only publicly available non-blocking SSH client library, as well as the only non-blocking parallel SSH client library available for Python.

• Design And Goals
  • Design Principles
• Installation
  • Pip Install
  • Old Python Versions
  • Dependencies
  • Building from Source
  • Building System Packages
• Quickstart
  • Run a command on hosts in parallel
  • Standard Output
  • Exit codes
  • Authentication
  • Output for Last Executed Commands
  • Host Logger
  • Using standard input
  • Errors and Exceptions
• Clients Feature Comparison
• Advanced Usage
  • Agents and Private Keys
  • Native clients
  • Tunneling
  • Join and Output Timeouts
  • Per-Host Configuration
  • Per-Host Command substitution
  • Run command features and options
  • SFTP
  • Hosts filtering and overriding
  • Additional options for underlying SSH libraries
• API Documentation
  • Native Parallel Client
  • Native Single Host Client
  • Paramiko based Single Host Client
  • Paramiko based Parallel Client
  • BaseParallelSSHClient
  • Host Output
  • SSH Agent
  • Native Tunnel
  • Utility functions
  • Exceptions
• Change Log
  • 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

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 __future__ import print_function

from pssh.clients import ParallelSSHClient

client = ParallelSSHClient(['localhost'])
output = client.run_command('whoami')
for line in output['localhost'].stdout:
    print(line)

Output:

<your username here>

Note

There is also a now deprecated paramiko based client available under pssh.clients.miko that has much the same API. It supports some features not currently supported by the native client - see feature comparison.

From version 2.x.x onwards, the clients under pssh.clients.miko will be an optional extras install.

Indices and tables

• Index