Connection plugins allow Ansible to connect to the target hosts so it can execute tasks on them. Ansible ships with many connection plugins, but only one can be used per host at a time.
By default, Ansible ships with several plugins. The most commonly used are the paramiko SSH, native ssh (just called ssh), and local connection types. All of these can be used in playbooks and with /usr/bin/ansible to decide how you want to talk to remote machines.
The basics of these connection types are covered in the getting started section.
Because ssh is the default protocol used in system administration and the protocol most used in Ansible, ssh options are included in the command line tools. See ansible-playbook for more details.
You can extend Ansible to support other transports (such as SNMP or message bus) by dropping a custom plugin into the
You can set the connection plugin globally via configuration, at the command line (
--connection), as a keyword in your play, or by setting a variable, most often in your inventory. For example, for Windows machines you might want to set the winrm plugin as an inventory variable.
Most connection plugins can operate with minimal configuration. By default they use the inventory hostname and defaults to find the target host.
Plugins are self-documenting. Each plugin should document its configuration options. The following are connection variables common to most connection plugins:
Each plugin might also have a specific version of a variable that overrides the general version. For example,
ansible_ssh_host for the ssh plugin.
You can use
ansible-doc -t connection -l to see the list of available plugins. Use
ansible-doc -t connection <plugin name> to see detailed documentation and examples.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.