community.general.ksu become – Kerberos substitute user

Note

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

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.ksu.

Synopsis

  • This become plugins allows your remote/login user to execute commands as another user via the ksu utility.

Parameters

Parameter

Comments

become_exe

string

Su executable

Default: “ksu”

Configuration:

  • INI entries:

    [privilege_escalation]
become_exe = ksu

    [ksu_become_plugin]
executable = ksu

  • Environment variable: ANSIBLE_BECOME_EXE

  • Environment variable: ANSIBLE_KSU_EXE

  • Variable: ansible_become_exe

  • Variable: ansible_ksu_exe

become_flags

string

Options to pass to ksu

Default: “”

Configuration:

  • INI entries:

    [privilege_escalation]
become_flags =

    [ksu_become_plugin]
flags =

  • Environment variable: ANSIBLE_BECOME_FLAGS

  • Environment variable: ANSIBLE_KSU_FLAGS

  • Variable: ansible_become_flags

  • Variable: ansible_ksu_flags

become_pass

string

ksu password

Configuration:

  • INI entry:

    [ksu_become_plugin]
password = None

  • Environment variable: ANSIBLE_BECOME_PASS

  • Environment variable: ANSIBLE_KSU_PASS

  • Variable: ansible_ksu_pass

  • Variable: ansible_become_pass

  • Variable: ansible_become_password

become_user

string / required

User you ‘become’ to execute the task

Configuration:

  • INI entries:

    [privilege_escalation]
become_user = None

    [ksu_become_plugin]
user = None

  • Environment variable: ANSIBLE_BECOME_USER

  • Environment variable: ANSIBLE_KSU_USER

  • Variable: ansible_become_user

  • Variable: ansible_ksu_user

prompt_l10n

string

List of localized strings to match for prompt detection

If empty we’ll use the built in one

Default: []

Configuration:

  • INI entry:

    [ksu_become_plugin]
localized_prompts = []

  • Environment variable: ANSIBLE_KSU_PROMPT_L10N

  • Variable: ansible_ksu_prompt_l10n

Authors

  • Ansible Core Team

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.