local¶

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin

Added in version historical.

Synopsis¶

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

Parameter	Defaults / Choices	Comments
become_strip_preamble bool	Default: True	Strip internal become output preceding command execution. Disable for additional diagnostics. Version Added: 2.19
become_success_timeout int	Default: 10	Number of seconds to wait for become to succeed when enabled. The default will be used if the configured value is less than 1. Version Added: 2.19
pipelining boolean		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 (C(become)). For example, when using sudo operations you must first disable C(requiretty) in the sudoers file for the target hosts, which is why this feature is disabled by default. Env: ANSIBLE_PIPELINING

Note

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