community.general.sudosu – Run tasks using sudo su -

Note

This plugin is part of the community.general collection (version 4.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.sudosu.

New in version 2.4.0: of community.general

Synopsis

  • This become plugins allows your remote/login user to execute commands as another user via the sudo and su utilities combined.

Parameters

Parameter Choices/Defaults Configuration Comments
become_flags
string
Default:
"-H -S -n"
ini entries:

[privilege_escalation]
become_flags = -H -S -n

[sudo_become_plugin]
flags = -H -S -n

env:ANSIBLE_BECOME_FLAGS
env:ANSIBLE_SUDO_FLAGS
var: ansible_become_flags
var: ansible_sudo_flags
Options to pass to sudo.
become_pass
string
ini entries:

[sudo_become_plugin]
password = None

env:ANSIBLE_BECOME_PASS
env:ANSIBLE_SUDO_PASS
var: ansible_become_password
var: ansible_become_pass
var: ansible_sudo_pass
Password to pass to sudo.
become_user
string
Default:
"root"
ini entries:

[privilege_escalation]
become_user = root

[sudo_become_plugin]
user = root

env:ANSIBLE_BECOME_USER
env:ANSIBLE_SUDO_USER
var: ansible_become_user
var: ansible_sudo_user
User you 'become' to execute the task.

Authors

  • Dag Wieers (@dagwieers)