Connection Plugins

    By default, Ansible ships with several plugins. The most commonly used are the paramiko SSH, native ssh (just called ), 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 section.

    You can extend Ansible to support other transports (such as SNMP or message bus) by dropping a custom plugininto the directory.

    The transport can be changed via configuration, at the command line (-c, ), as a in your play, or by setting a variable, most often in your inventory.For example, for Windows machines you might want to use the plugin.

    Plugins are self-documenting. Each plugin should document its configuration options. The following are connection variables common to most connection plugins:

    • ansible_host
    • The name of the host to connect to, if different from the hostname.
    • ansible_port
    • The ssh port number, for and paramiko_ssh it defaults to 22.
    • The default user name to use for log in. Most plugins default to the ‘current user running Ansible’.

    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.

    See also

    • An introduction to playbooks
    • Callback Plugins
    • Ansible callback plugins
    • Jinja2 filter plugins
    • Tests
    • Jinja2 test plugins
    • Jinja2 lookup plugins
    • Vars Plugins
    • Ansible vars plugins
    • Have a question? Stop by the google group!
    • ansible IRC chat channel