ansible / ansible.builtin / v2.9.7 / connection / ssh connect via ssh client binary | "added in version" historical of ansible.builtin" Authors: ansible (@core)ansible.builtin.ssh (v2.9.7) — connection
pip
Install with pip install ansible==2.9.7
This connection plugin allows ansible to communicate to the target machines via normal ssh command line.
Ansible does not expose a channel to allow communication between the user and the ssh process to accept a password manually to decrypt an ssh key when using this connection plugin (which is the default). The use of ``ssh-agent`` is highly recommended.
host: default: inventory_hostname description: Hostname/ip to connect to. vars: - name: ansible_host - name: ansible_ssh_host port: default: 22 description: Remote port to connect to. env: - name: ANSIBLE_REMOTE_PORT ini: - key: remote_port section: defaults type: int vars: - name: ansible_port - name: ansible_ssh_port retries: default: 3 description: Number of attempts to connect. env: - name: ANSIBLE_SSH_RETRIES ini: - key: retries section: connection - key: retries section: ssh_connection type: integer vars: - name: ansible_ssh_retries version_added: '2.7' version_added_collection: ansible.builtin use_tty: default: 'yes' description: add -tt to ssh commands to force tty allocation env: - name: ANSIBLE_SSH_USETTY ini: - key: usetty section: ssh_connection type: bool vars: - name: ansible_ssh_use_tty version_added: '2.7' version_added_collection: ansible.builtin version_added: '2.5' version_added_collection: ansible.builtin password: description: Authentication password for the C(remote_user). Can be supplied as CLI option. vars: - name: ansible_password - name: ansible_ssh_pass - name: ansible_ssh_password ssh_args: default: -C -o ControlMaster=auto -o ControlPersist=60s description: Arguments to pass to all ssh cli tools env: - name: ANSIBLE_SSH_ARGS ini: - key: ssh_args section: ssh_connection vars: - name: ansible_ssh_args version_added: '2.7' version_added_collection: ansible.builtin pipelining: default: ANSIBLE_PIPELINING description: - Pipelining reduces the number of SSH operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfer. - This can result in a very significant performance improvement when enabled. - However this conflicts with privilege escalation (become). For example, when using sudo operations you must first disable 'requiretty' in the sudoers file for the target hosts, which is why this feature is disabled by default. env: - name: ANSIBLE_PIPELINING ini: - key: pipelining section: defaults type: boolean vars: - name: ansible_pipelining - name: ansible_ssh_pipelining scp_if_ssh: default: smart description: - Prefered method to use when transfering files over ssh - When set to smart, Ansible will try them until one succeeds or they all fail - If set to True, it will force 'scp', if False it will use 'sftp' env: - name: ANSIBLE_SCP_IF_SSH ini: - key: scp_if_ssh section: ssh_connection vars: - name: ansible_scp_if_ssh version_added: '2.7' version_added_collection: ansible.builtin remote_user: description: - User name with which to login to the remote server, normally set by the remote_user keyword. - If no user is supplied, Ansible will let the ssh client binary choose the user as it normally env: - name: ANSIBLE_REMOTE_USER ini: - key: remote_user section: defaults vars: - name: ansible_user - name: ansible_ssh_user control_path: description: - This is the location to save ssh's ControlPath sockets, it uses ssh's variable substitution. - Since 2.3, if null, ansible will generate a unique hash. Use `%(directory)s` to indicate where to use the control dir path setting. env: - name: ANSIBLE_SSH_CONTROL_PATH ini: - key: control_path section: ssh_connection vars: - name: ansible_control_path version_added: '2.7' version_added_collection: ansible.builtin scp_executable: default: scp description: - This defines the location of the scp binary. It defaults to `scp` which will use the first binary available in $PATH. env: - name: ANSIBLE_SCP_EXECUTABLE ini: - key: scp_executable section: ssh_connection vars: - name: ansible_scp_executable version_added: '2.7' version_added_collection: ansible.builtin version_added: '2.6' version_added_collection: ansible.builtin scp_extra_args: description: Extra exclusive to the ``scp`` CLI env: - name: ANSIBLE_SCP_EXTRA_ARGS version_added: '2.7' version_added_collection: ansible.builtin ini: - key: scp_extra_args section: ssh_connection version_added: '2.7' version_added_collection: ansible.builtin vars: - name: ansible_scp_extra_args ssh_executable: default: ssh description: - This defines the location of the ssh binary. It defaults to ``ssh`` which will use the first ssh binary available in $PATH. - This option is usually not required, it might be useful when access to system ssh is restricted, or when using ssh wrappers to connect to remote hosts. env: - name: ANSIBLE_SSH_EXECUTABLE ini: - key: ssh_executable section: ssh_connection vars: - name: ansible_ssh_executable version_added: '2.7' version_added_collection: ansible.builtin version_added: '2.2' version_added_collection: ansible.builtin ssh_extra_args: description: Extra exclusive to the 'ssh' CLI env: - name: ANSIBLE_SSH_EXTRA_ARGS version_added: '2.7' version_added_collection: ansible.builtin ini: - key: ssh_extra_args section: ssh_connection version_added: '2.7' version_added_collection: ansible.builtin vars: - name: ansible_ssh_extra_args sftp_batch_mode: default: 'yes' description: 'TODO: write it' env: - name: ANSIBLE_SFTP_BATCH_MODE ini: - key: sftp_batch_mode section: ssh_connection type: bool vars: - name: ansible_sftp_batch_mode version_added: '2.7' version_added_collection: ansible.builtin sftp_executable: default: sftp description: - This defines the location of the sftp binary. It defaults to ``sftp`` which will use the first binary available in $PATH. env: - name: ANSIBLE_SFTP_EXECUTABLE ini: - key: sftp_executable section: ssh_connection vars: - name: ansible_sftp_executable version_added: '2.7' version_added_collection: ansible.builtin version_added: '2.6' version_added_collection: ansible.builtin sftp_extra_args: description: Extra exclusive to the ``sftp`` CLI env: - name: ANSIBLE_SFTP_EXTRA_ARGS version_added: '2.7' version_added_collection: ansible.builtin ini: - key: sftp_extra_args section: ssh_connection version_added: '2.7' version_added_collection: ansible.builtin vars: - name: ansible_sftp_extra_args ssh_common_args: description: Common extra args for all ssh CLI tools env: - name: ANSIBLE_SSH_COMMON_ARGS version_added: '2.7' version_added_collection: ansible.builtin ini: - key: ssh_common_args section: ssh_connection version_added: '2.7' version_added_collection: ansible.builtin vars: - name: ansible_ssh_common_args control_path_dir: default: ~/.ansible/cp description: - This sets the directory to use for ssh control path if the control path setting is null. - Also, provides the `%(directory)s` variable for the control path setting. env: - name: ANSIBLE_SSH_CONTROL_PATH_DIR ini: - key: control_path_dir section: ssh_connection vars: - name: ansible_control_path_dir version_added: '2.7' version_added_collection: ansible.builtin private_key_file: description: - Path to private key file to use for authentication env: - name: ANSIBLE_PRIVATE_KEY_FILE ini: - key: private_key_file section: defaults vars: - name: ansible_private_key_file - name: ansible_ssh_private_key_file host_key_checking: description: Determines if ssh should check host keys env: - name: ANSIBLE_HOST_KEY_CHECKING - name: ANSIBLE_SSH_HOST_KEY_CHECKING version_added: '2.5' version_added_collection: ansible.builtin ini: - key: host_key_checking section: defaults - key: host_key_checking section: ssh_connection version_added: '2.5' version_added_collection: ansible.builtin type: boolean vars: - name: ansible_host_key_checking version_added: '2.5' version_added_collection: ansible.builtin - name: ansible_ssh_host_key_checking version_added: '2.5' version_added_collection: ansible.builtin