community.general.machinectl – Systemd’s machinectl privilege escalation
Note
This plugin is part of the community.general collection (version 3.8.1).
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] [machinectl_become_plugin]
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] [machinectl_become_plugin]
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]
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] [machinectl_become_plugin]
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
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/machinectl_become.html