ansible.builtin.su – 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 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 become plugin name.
New in version 2.8: of ansible.builtin
Synopsis
- This become plugins allows your remote/login user to execute commands as another user via the su utility.
Parameters
| Parameter | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
| become_exe
string
|
Default:
"su"
|
ini entries:
[privilege_escalation] [su_become_plugin]
env:ANSIBLE_BECOME_EXE
env:ANSIBLE_SU_EXE
var: ansible_become_exe
var: ansible_su_exe
|
Su executable
|
| become_flags
string
|
Default:
""
|
ini entries:
[privilege_escalation] [su_become_plugin]
env:ANSIBLE_BECOME_FLAGS
env:ANSIBLE_SU_FLAGS
var: ansible_become_flags
var: ansible_su_flags
|
Options to pass to su
|
| become_pass
string
|
ini entries:
[su_become_plugin]
env:ANSIBLE_BECOME_PASS
env:ANSIBLE_SU_PASS
var: ansible_become_password
var: ansible_become_pass
var: ansible_su_pass
|
Password to pass to su
|
|
| become_user
string
|
Default:
"root"
|
ini entries:
[privilege_escalation] [su_become_plugin]
env:ANSIBLE_BECOME_USER
env:ANSIBLE_SU_USER
var: ansible_become_user
var: ansible_su_user
|
User you 'become' to execute the task
|
| prompt_l10n
list / elements=string
|
Default:
[]
|
ini entries:
[su_become_plugin]
env:ANSIBLE_SU_PROMPT_L10N
var: ansible_su_prompt_l10n
|
List of localized strings to match for prompt detection
If empty we'll use the built in one
|
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/latest/collections/ansible/builtin/su_become.html