community.general.pmrun become – Privilege Manager run

Note

This become plugin is part of the community.general collection (version 10.1.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.pmrun.

Synopsis

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

Parameters

Parameter

Comments

become_exe

string

Sudo executable

Default: "pmrun"

Configuration:

  • INI entries:

    [privilege_escalation]
become_exe = pmrun

    [pmrun_become_plugin]
executable = pmrun

  • Environment variable: ANSIBLE_BECOME_EXE

  • Environment variable: ANSIBLE_PMRUN_EXE

  • Variable: ansible_become_exe

  • Variable: ansible_pmrun_exe

become_flags

string

Options to pass to pmrun.

Default: ""

Configuration:

  • INI entries:

    [privilege_escalation]
become_flags = ""

    [pmrun_become_plugin]
flags = ""

  • Environment variable: ANSIBLE_BECOME_FLAGS

  • Environment variable: ANSIBLE_PMRUN_FLAGS

  • Variable: ansible_become_flags

  • Variable: ansible_pmrun_flags

become_pass

string

pmrun password.

Configuration:

  • INI entry:

    [pmrun_become_plugin]
password = VALUE

  • Environment variable: ANSIBLE_BECOME_PASS

  • Environment variable: ANSIBLE_PMRUN_PASS

  • Variable: ansible_become_password

  • Variable: ansible_become_pass

  • Variable: ansible_pmrun_pass

Notes

Note

  • This plugin ignores the become_user supplied and uses pmrun’s own configuration to select the user.

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.