API Documentation

• Native Parallel Client
  • ParallelSSHClient
    • ParallelSSHClient.copy_file()
    • ParallelSSHClient.copy_remote_file()
    • ParallelSSHClient.run_command()
    • ParallelSSHClient.scp_recv()
    • ParallelSSHClient.scp_send()
• Native Single Host Client
  • KeepAlive
    • KeepAlive.eagain()
    • KeepAlive.poll()
    • KeepAlive.session
    • KeepAlive.sock
  • SSHClient
    • SSHClient.close_channel()
    • SSHClient.configure_keepalive()
    • SSHClient.copy_file()
    • SSHClient.copy_remote_file()
    • SSHClient.eagain()
    • SSHClient.eagain_write()
    • SSHClient.finished()
    • SSHClient.get_exit_status()
    • SSHClient.mkdir()
    • SSHClient.open_session()
    • SSHClient.poll()
    • SSHClient.scp_recv()
    • SSHClient.scp_send()
    • SSHClient.sftp_get()
    • SSHClient.sftp_put()
    • SSHClient.wait_finished()
    • SSHClient.sock
• ssh-python Parallel Client
  • ParallelSSHClient
    • ParallelSSHClient.run_command()
• ssh-python Single Host Client
  • SSHClient
    • SSHClient.auth()
    • SSHClient.close_channel()
    • SSHClient.eagain()
    • SSHClient.eagain_write()
    • SSHClient.finished()
    • SSHClient.get_exit_status()
    • SSHClient.open_session()
    • SSHClient.poll()
    • SSHClient.wait_finished()
    • SSHClient.sock
• Base Parallel Client
  • BaseParallelSSHClient
    • BaseParallelSSHClient.connect_auth()
    • BaseParallelSSHClient.copy_file()
    • BaseParallelSSHClient.copy_remote_file()
    • BaseParallelSSHClient.finished()
    • BaseParallelSSHClient.get_last_output()
    • BaseParallelSSHClient.join()
    • BaseParallelSSHClient.join_shells()
    • BaseParallelSSHClient.open_shell()
    • BaseParallelSSHClient.run_command()
    • BaseParallelSSHClient.run_shell_commands()
    • BaseParallelSSHClient.hosts
• Base Single Client
  • BaseSSHClient
    • BaseSSHClient.auth()
    • BaseSSHClient.close_channel()
    • BaseSSHClient.copy_file()
    • BaseSSHClient.copy_remote_file()
    • BaseSSHClient.disconnect()
    • BaseSSHClient.execute()
    • BaseSSHClient.get_exit_status()
    • BaseSSHClient.mkdir()
    • BaseSSHClient.open_session()
    • BaseSSHClient.open_shell()
    • BaseSSHClient.read_output()
    • BaseSSHClient.read_output_buffer()
    • BaseSSHClient.read_stderr()
    • BaseSSHClient.run_command()
    • BaseSSHClient.scp_recv()
    • BaseSSHClient.scp_send()
    • BaseSSHClient.sftp_get()
    • BaseSSHClient.sftp_put()
    • BaseSSHClient.wait_finished()
    • BaseSSHClient.IDENTITIES
    • BaseSSHClient.sock
  • InteractiveShell
    • InteractiveShell.close()
    • InteractiveShell.run()
    • InteractiveShell.exit_code
    • InteractiveShell.output
    • InteractiveShell.stderr
    • InteractiveShell.stdin
    • InteractiveShell.stdout
  • PollMixIn
    • PollMixIn.eagain()
    • PollMixIn.eagain_write()
    • PollMixIn.poll()
    • PollMixIn.sock
  • Stdin
    • Stdin.flush()
    • Stdin.write()
• Host Output
  • BufferData
    • BufferData.reader
    • BufferData.rw_buffer
  • HostOutput
    • HostOutput.alias
    • HostOutput.buffers
    • HostOutput.channel
    • HostOutput.client
    • HostOutput.encoding
    • HostOutput.exception
    • HostOutput.exit_code
    • HostOutput.host
    • HostOutput.read_timeout
    • HostOutput.stderr
    • HostOutput.stdin
    • HostOutput.stdout
  • HostOutputBuffers
    • HostOutputBuffers.stderr
    • HostOutputBuffers.stdout
• Host Config
  • HostConfig
    • HostConfig.alias
    • HostConfig.allow_agent
    • HostConfig.auth_thread_pool
    • HostConfig.cert_file
    • HostConfig.forward_ssh_agent
    • HostConfig.gssapi_auth
    • HostConfig.gssapi_client_identity
    • HostConfig.gssapi_delegate_credentials
    • HostConfig.gssapi_server_identity
    • HostConfig.identity_auth
    • HostConfig.ipv6_only
    • HostConfig.keepalive_seconds
    • HostConfig.num_retries
    • HostConfig.password
    • HostConfig.port
    • HostConfig.private_key
    • HostConfig.proxy_host
    • HostConfig.proxy_password
    • HostConfig.proxy_pkey
    • HostConfig.proxy_port
    • HostConfig.proxy_user
    • HostConfig.retry_delay
    • HostConfig.timeout
    • HostConfig.user
• Native Tunnel
  • LocalForwarder
    • LocalForwarder.cleanup_server()
    • LocalForwarder.enqueue()
    • LocalForwarder.run()
    • LocalForwarder.shutdown()
  • TunnelServer
    • TunnelServer.listen_port
• Output reader/writer
  • ConcurrentRWBuffer
    • ConcurrentRWBuffer.read()
    • ConcurrentRWBuffer.write()
    • ConcurrentRWBuffer.eof
• Utility functions
  • enable_debug_logger()
  • enable_host_logger()
  • enable_logger()
• Exceptions
  • AuthenticationError
  • AuthenticationException
  • HostArgumentError
  • HostArgumentException
  • HostConfigError
  • NoIPv6AddressFoundError
  • PKeyFileError
  • ProxyError
  • SCPError
  • SFTPError
  • SFTPIOError
  • SSHError
  • SSHException
  • SessionError
  • ShellError
  • Timeout
  • UnknownHostError
  • UnknownHostException
• Constants
  • DEFAULT_RETRIES
  • RETRY_DELAY