su – Substitute User

From Get docs
< Become PluginsAnsible/docs/2.8/plugins/become/su


su – Substitute User

New in version 2.8.


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

-

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

-

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

-

ini entries: [su_become_plugin]password = VALUE


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

-

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

-

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



Status

Authors

  • ansible (@core)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.


Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/plugins/become/su.html