community.general.ksu – Kerberos substitute user

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

Synopsis

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

Parameters

Parameter Choices/Defaults Configuration Comments
become_exe
string
Default:
"ksu"
ini entries:

[privilege_escalation]
become_exe = ksu

[ksu_become_plugin]
executable = ksu

env:ANSIBLE_BECOME_EXE
env:ANSIBLE_KSU_EXE
var: ansible_become_exe
var: ansible_ksu_exe
Su executable
become_flags
string
Default:
""
ini entries:

[privilege_escalation]
become_flags =

[ksu_become_plugin]
flags =

env:ANSIBLE_BECOME_FLAGS
env:ANSIBLE_KSU_FLAGS
var: ansible_become_flags
var: ansible_ksu_flags
Options to pass to ksu
become_pass
string
ini entries:

[ksu_become_plugin]
password = None

env:ANSIBLE_BECOME_PASS
env:ANSIBLE_KSU_PASS
var: ansible_ksu_pass
var: ansible_become_pass
var: ansible_become_password
ksu password
become_user
string / required
ini entries:

[privilege_escalation]
become_user = None

[ksu_become_plugin]
user = None

env:ANSIBLE_BECOME_USER
env:ANSIBLE_KSU_USER
var: ansible_become_user
var: ansible_ksu_user
User you 'become' to execute the task
prompt_l10n
string
Default:
[]
ini entries:

[ksu_become_plugin]
localized_prompts = []

env:ANSIBLE_KSU_PROMPT_L10N
var: ansible_ksu_prompt_l10n
List of localized strings to match for prompt detection
If empty we'll use the built in one

Authors

  • Ansible Core Team