Docs4dev
Docs
ansible / latest / collections / community / general / pbrun_become.html

community.general.pbrun – PowerBroker run

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

Synopsis

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

Parameters

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

[privilege_escalation]
become_exe = pbrun

[pbrun_become_plugin]
executable = pbrun

env:ANSIBLE_BECOME_EXE
env:ANSIBLE_PBRUN_EXE
var: ansible_become_exe
var: ansible_pbrun_exe
Sudo executable
become_flags
string
Default:
""
ini entries:

[privilege_escalation]
become_flags =

[pbrun_become_plugin]
flags =

env:ANSIBLE_BECOME_FLAGS
env:ANSIBLE_PBRUN_FLAGS
var: ansible_become_flags
var: ansible_pbrun_flags
Options to pass to pbrun
become_pass
string
ini entries:

[pbrun_become_plugin]
password = None

env:ANSIBLE_BECOME_PASS
env:ANSIBLE_PBRUN_PASS
var: ansible_become_password
var: ansible_become_pass
var: ansible_pbrun_pass
Password for pbrun
become_user
string
Default:
""
ini entries:

[privilege_escalation]
become_user =

[pbrun_become_plugin]
user =

env:ANSIBLE_BECOME_USER
env:ANSIBLE_PBRUN_USER
var: ansible_become_user
var: ansible_pbrun_user
User you 'become' to execute the task
wrap_exe
boolean
    Choices:
  • no ←
  • yes
ini entries:

[pbrun_become_plugin]
wrap_execution = no

env:ANSIBLE_PBRUN_WRAP_EXECUTION
var: ansible_pbrun_wrap_execution
Toggle to wrap the command pbrun calls in 'shell -c' or not

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/pbrun_become.html