ansible / ansible.builtin / v2.8.13 / connection / paramiko_ssh Run tasks via python ssh (paramiko) | "added in version" 0.1 of ansible.builtin" Authors: Ansible Core Teamansible.builtin.paramiko_ssh (v2.8.13) — connection
pip
Install with pip install ansible==2.8.13
Use the python ssh implementation (Paramiko) to connect to targets
The paramiko transport is provided because many distributions, in particular EL6 and before do not support ControlPersist in their SSH implementations.
This is needed on the Ansible control machine to be reasonably efficient with connections. Thus paramiko is faster for most users on these platforms. Users with ControlPersist capability can consider using -c ssh or configuring the transport in the configuration file.
This plugin also borrows a lot of settings from the ssh plugin as they both cover the same protocol.
pty: default: true description: 'TODO: write it' env: - name: ANSIBLE_PARAMIKO_PTY ini: - key: pty section: paramiko_connection type: boolean password: description: - Secret used to either login the ssh server or as a passphrase for ssh keys that require it - Can be set from the CLI via the C(--ask-pass) option. vars: - name: ansible_password - name: ansible_ssh_pass - name: ansible_ssh_password - name: ansible_paramiko_pass - name: ansible_paramiko_password version_added: '2.5' version_added_collection: ansible.builtin remote_addr: default: inventory_hostname description: - Address of the remote target vars: - name: ansible_host - name: ansible_ssh_host - name: ansible_paramiko_host remote_user: description: - User to login/authenticate as - Can be set from the CLI via the C(--user) or C(-u) options. env: - name: ANSIBLE_REMOTE_USER - name: ANSIBLE_PARAMIKO_REMOTE_USER version_added: '2.5' version_added_collection: ansible.builtin ini: - key: remote_user section: defaults - key: remote_user section: paramiko_connection version_added: '2.5' version_added_collection: ansible.builtin vars: - name: ansible_user - name: ansible_ssh_user - name: ansible_paramiko_user look_for_keys: default: true description: 'TODO: write it' env: - name: ANSIBLE_PARAMIKO_LOOK_FOR_KEYS ini: - key: look_for_keys section: paramiko_connection type: boolean proxy_command: default: '' description: - Proxy information for running the connection via a jumphost - Also this plugin will scan 'ssh_args', 'ssh_extra_args' and 'ssh_common_args' from the 'ssh' plugin settings for proxy information if set. env: - name: ANSIBLE_PARAMIKO_PROXY_COMMAND ini: - key: proxy_command section: paramiko_connection record_host_keys: default: true description: 'TODO: write it' env: - name: ANSIBLE_PARAMIKO_RECORD_HOST_KEYS ini: - key: record_host_keys section: paramiko_connection type: boolean host_key_auto_add: description: 'TODO: write it' env: - name: ANSIBLE_PARAMIKO_HOST_KEY_AUTO_ADD ini: - key: host_key_auto_add section: paramiko_connection type: boolean host_key_checking: default: true description: Set this to "False" if you want to avoid host key checking by the underlying tools Ansible uses to connect to the host env: - name: ANSIBLE_HOST_KEY_CHECKING - name: ANSIBLE_SSH_HOST_KEY_CHECKING version_added: '2.5' version_added_collection: ansible.builtin - name: ANSIBLE_PARAMIKO_HOST_KEY_CHECKING version_added: '2.5' version_added_collection: ansible.builtin ini: - key: host_key_checking section: defaults - key: host_key_checking section: paramiko_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 - name: ansible_paramiko_host_key_checking version_added: '2.5' version_added_collection: ansible.builtin use_persistent_connections: default: false description: Toggles the use of persistence for connections env: - name: ANSIBLE_USE_PERSISTENT_CONNECTIONS ini: - key: use_persistent_connections section: defaults type: boolean