- Docs »
- ansible.builtin.su – Substitute User
-
You are reading the latest community version of the Ansible documentation. Red Hat subscribers, select 2.9 in the version selection to the left for the most recent Red Hat release.
ansible.builtin.su – Substitute User
Note
This module is part of ansible-base
and included in all Ansible
installations. In most cases, you can use the short module name
su 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.
New in version 2.8: of ansible.builtin
Parameter |
Choices/Defaults |
Configuration |
Comments |
become_exe
string
|
Default:
"su"
|
ini entries:
[privilege_escalation] become_exe = su
[su_become_plugin] executable = su
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] become_flags =
[su_become_plugin] flags =
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] password = None
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] become_user = root
[su_become_plugin] user = root
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] localized_prompts = []
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
|