ansible.builtin.local – execute on controller

Note

This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name local even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

Synopsis
Parameters
Notes

Synopsis

This connection plugin allows ansible to execute tasks on the Ansible ‘controller’ instead of on a remote host.

Parameters

Parameter

Choices/Defaults

Configuration

Comments

pipelining

boolean

no
yes

Default:

"ANSIBLE_PIPELINING"

ini entries: [defaults]pipelining = ANSIBLE_PIPELINING

env:ANSIBLE_PIPELINING

var: ansible_pipelining

Pipelining reduces the number of connection operations required to execute a module on the remote server, by executing many Ansible modules without actual file transfers.

This can result in a very significant performance improvement when enabled.

However this can conflict 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.

Notes

Note

The remote user is ignored, the user with which the ansible CLI was executed is used instead.

Authors

ansible (@core)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/local_connection.html