community.general.machinectl – Systemd’s machinectl privilege escalation

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

Synopsis

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

Parameters

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

[privilege_escalation]
become_exe = machinectl

[machinectl_become_plugin]
executable = machinectl

env:ANSIBLE_BECOME_EXE
env:ANSIBLE_MACHINECTL_EXE
var: ansible_become_exe
var: ansible_machinectl_exe
Machinectl executable
become_flags
string
Default:
""
ini entries:

[privilege_escalation]
become_flags =

[machinectl_become_plugin]
flags =

env:ANSIBLE_BECOME_FLAGS
env:ANSIBLE_MACHINECTL_FLAGS
var: ansible_become_flags
var: ansible_machinectl_flags
Options to pass to machinectl
become_pass
string
ini entries:

[machinectl_become_plugin]
password = None

env:ANSIBLE_BECOME_PASS
env:ANSIBLE_MACHINECTL_PASS
var: ansible_become_password
var: ansible_become_pass
var: ansible_machinectl_pass
Password for machinectl
become_user
string
Default:
""
ini entries:

[privilege_escalation]
become_user =

[machinectl_become_plugin]
user =

env:ANSIBLE_BECOME_USER
env:ANSIBLE_MACHINECTL_USER
var: ansible_become_user
var: ansible_machinectl_user
User you 'become' to execute the task

Authors

  • Ansible Core Team