@ssh Connector

Connect to hosts over SSH. This is the default connector and all targets default to this meaning you do not need to specify it - ie the following two commands are identical:

pyinfra my-host.net ...
pyinfra @ssh/my-host.net ...

Usage

pyinfra @ssh/hostname ...

Available Data

ssh_hostname  # SSH hostname
ssh_port  # SSH port
ssh_user  # User to SSH as
ssh_password  # Password to use for authentication
ssh_key  # Key file to use for authentication
ssh_key_password  # Key file password
ssh_allow_agent  # Allow using SSH agent
ssh_look_for_keys  # Allow looking up users keys
ssh_forward_agent  # Enable SSH forward agent
ssh_config_file  # Custom SSH config file
ssh_known_hosts_file  # Custom SSH known hosts file
ssh_strict_host_key_checking  # Override strict host keys check setting
ssh_connect_retries  # Number of tries to connect via ssh
ssh_connect_retry_min_delay  # Lower bound for random delay between retries
ssh_connect_retry_max_delay  # Upper bound for random delay between retries
ssh_paramiko_connect_kwargs  # Override keyword arguments passed into paramiko's `SSHClient.connect`