Host Config

Host specific configuration.

class pssh.config.HostConfig(user=None, port=None, password=None, private_key=None, allow_agent=None, num_retries=None, retry_delay=None, timeout=None, identity_auth=None, proxy_host=None, proxy_port=None, proxy_user=None, proxy_password=None, proxy_pkey=None, keepalive_seconds=None)

Host configuration for ParallelSSHClient.

Used to hold individual configuration for each host in ParallelSSHClient host list.

Parameters

  • user (str) – Username to login as.

  • port (int) – Port number.

  • password (str) – Password to login with.

  • private_key (str) – Private key file to use for authentication.

  • allow_agent (bool) – Enable/disable SSH agent authentication.

  • num_retries (int) – Number of retry attempts before giving up on connection and SSH operations.

  • retry_delay (int) – Delay in seconds between retry attempts.

  • timeout (int) – Timeout value for connection and SSH sessions in seconds.

  • identity_auth (bool) – Enable/disable identity file authentication under user’s home directory (~/.ssh).

  • proxy_host (str) – Proxy SSH host to use for connecting to target SSH host. client -> proxy_host -> SSH host

  • proxy_port (int) – Port for proxy host.

  • proxy_user (str) – Username for proxy host.

  • proxy_password (str) – Password for proxy host.

  • proxy_pkey (str) – Private key for proxy host.

  • keepalive_seconds (int) – Seconds between keepalive packets being sent. 0 to disable.

allow_agent
identity_auth
keepalive_seconds
num_retries
password
port
private_key
proxy_host
proxy_password
proxy_pkey
proxy_port
proxy_user
retry_delay
timeout
user