Host Config

Host specific configuration.

class pssh.config.HostConfig(user=None, port=None, password=None, private_key=None, allow_agent=None, alias=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, ipv6_only=None, cert_file=None, auth_thread_pool=True, gssapi_auth=False, gssapi_server_identity=None, gssapi_client_identity=None, gssapi_delegate_credentials=False, forward_ssh_agent=False)

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.
• alias (str) – Use an alias for this host.
• num_retries (int) – Number of retry attempts before giving up on connection and SSH operations.
• retry_delay (int or float) – Delay in seconds between retry attempts.
• timeout (int or float) – 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.
• ipv6_only (bool) – Use IPv6 addresses only.
• cert_file (str) – Certificate file for authentication (pssh.clients.ssh only)
• auth_thread_pool (bool) – Enable/Disable use of thread pool for authentication.
• forward_ssh_agent (bool) – Currently unused.
• gssapi_server_identity (str) – Set GSSAPI server identity. (pssh.clients.ssh only)
• gssapi_server_identity – Set GSSAPI client identity. (pssh.clients.ssh only)
• gssapi_delegate_credentials (bool) – Enable/disable server credentials delegation. (pssh.clients.ssh only)

alias

allow_agent

auth_thread_pool

cert_file

forward_ssh_agent

gssapi_auth

gssapi_client_identity

gssapi_delegate_credentials

gssapi_server_identity

identity_auth

ipv6_only

keepalive_seconds

num_retries

password

port

private_key

proxy_host

proxy_password

proxy_pkey

proxy_port

proxy_user

retry_delay

timeout

user