ansible.builtin.su become – Substitute User
Note
This become plugin is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
plugin name
su
.
However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.su
for easy linking to the
plugin documentation and to avoid conflicting with other collections that may have
the same become plugin name.
New in Ansible 2.8
Synopsis
This become plugin allows your remote/login user to execute commands as another user via the su utility.
Parameters
Parameter |
Comments |
---|---|
Su executable Default: Configuration:
|
|
Options to pass to su Default: Configuration:
|
|
Password to pass to su Configuration:
|
|
User you ‘become’ to execute the task Default: Configuration:
|
|
List of localized strings to match for prompt detection If empty we’ll use the built in one Do NOT add a colon (:) to your custom entries. Ansible adds a colon at the end of each prompt; if you add another one in your string, your prompt will fail with a “Timeout” error. Default: Configuration:
|