Parallel-SSH Documentation

Parallel-SSH is a parallel SSH client library. It uses asynchronous SSH connections and is, to date, the only publicly available asynchronous SSH client library for Python, as well as the only asynchronous parallel SSH client library available for Python.

• Design And Goals
  • Design Principles
• Installation
  • Pip Install
  • Old Python Versions
  • Source Code
• Quickstart
  • Run a command on hosts in parallel
  • Standard Output
  • Exit codes
  • Authentication
  • Host Logger
  • Using standard input
  • Errors and Exceptions
• Advanced Usage
  • Agents and Private Keys
  • Tunneling
  • 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
  • ParallelSSHClient
  • SSHClient
  • Host Output
  • SSH Agent
  • Utility functions
  • Exceptions

In a nutshell

from __future__ import print_function

from pssh.pssh_client import ParallelSSHClient

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

Output:

<your username here>

Indices and tables

• Index