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

Note

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

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 community.general 2.4.0

Synopsis

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

Parameters

Parameter

Comments

alt_method

boolean

added in community.general 9.2.0

Whether to use an alternative method to call su. Instead of running su -l user /path/to/shell -c command, it runs su -l user -c command.

Use this when the default one is not working on your system.

Choices:

  • false

  • true

Configuration:

  • INI entry:

    [community.general.sudosu]
    alternative_method = VALUE
    
  • Environment variable: ANSIBLE_SUDOSU_ALT_METHOD

  • Variable: ansible_sudosu_alt_method

become_flags

string

Options to pass to sudo.

Default: "-H -S -n"

Configuration:

  • INI entries:

    [privilege_escalation]
    become_flags = -H -S -n
    
    [sudo_become_plugin]
    flags = -H -S -n
    
  • Environment variable: ANSIBLE_BECOME_FLAGS

  • Environment variable: ANSIBLE_SUDO_FLAGS

  • Variable: ansible_become_flags

  • Variable: ansible_sudo_flags

become_pass

string

Password to pass to sudo.

Configuration:

  • INI entry:

    [sudo_become_plugin]
    password = VALUE
    
  • Environment variable: ANSIBLE_BECOME_PASS

  • Environment variable: ANSIBLE_SUDO_PASS

  • Variable: ansible_become_password

  • Variable: ansible_become_pass

  • Variable: ansible_sudo_pass

become_user

string

User you ‘become’ to execute the task.

Default: "root"

Configuration:

  • INI entries:

    [privilege_escalation]
    become_user = root
    
    [sudo_become_plugin]
    user = root
    
  • Environment variable: ANSIBLE_BECOME_USER

  • Environment variable: ANSIBLE_SUDO_USER

  • Variable: ansible_become_user

  • Variable: ansible_sudo_user

Authors

  • Dag Wieers (@dagwieers)

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.