ansible.builtin.local connection – execute on controller
Note
This connection plugin is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
plugin name
local
even without specifying the collections:
keyword.
However, we recommend you use the FQCN for easy linking to the
plugin documentation and to avoid conflicting with other collections that may have
the same connection plugin name.
Synopsis
This connection plugin allows ansible to execute tasks on the Ansible ‘controller’ instead of on a remote host.
Parameters
Parameter |
Comments |
---|---|
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. Choices:
Configuration:
|
Notes
Note
The remote user is ignored, the user with which the ansible CLI was executed is used instead.