pfexec – profile based execution — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# pfexec – profile based execution

New in version 2.8.

- Synopsis
- Parameters
- Status

## Synopsis

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

## Parameters

Parameter | Choices/Defaults | Configuration | Comments
--- | --- | --- | ---
become_exe - | Default: "pfexec" | ini entries: [privilege_escalation] become_exe = pfexec [pfexec_become_plugin] executable = pfexec env:ANSIBLE_BECOME_EXE env:ANSIBLE_PFEXEC_EXE var: ansible_become_exe var: ansible_pfexec_exe | Sudo executable
become_flags - | Default: "-H -S -n" | ini entries: [privilege_escalation] become_flags = -H -S -n [pfexec_become_plugin] flags = -H -S -n env:ANSIBLE_BECOME_FLAGS env:ANSIBLE_PFEXEC_FLAGS var: ansible_become_flags var: ansible_pfexec_flags | Options to pass to pfexec
become_pass - |  | ini entries: [pfexec_become_plugin] password = VALUE env:ANSIBLE_BECOME_PASS env:ANSIBLE_PFEXEC_PASS var: ansible_become_password var: ansible_become_pass var: ansible_pfexec_pass | pfexec password
become_user - | Default: "root" | ini entries: [privilege_escalation] become_user = root [pfexec_become_plugin] user = root env:ANSIBLE_BECOME_USER env:ANSIBLE_PFEXEC_USER var: ansible_become_user var: ansible_pfexec_user | User you 'become' to execute the task This plugin ignores this setting as pfexec uses it's own ``exec_attr`` to figure this out, but it is supplied here for Ansible to make decisions needed for the task execution, like file permissions.
wrap_exe boolean | Choices: no ← yes | ini entries: [pfexec_become_plugin] wrap_execution = no env:ANSIBLE_PFEXEC_WRAP_EXECUTION var: ansible_pfexec_wrap_execution | Toggle to wrap the command pfexec calls in 'shell -c' or not

## Status

- This become is not guaranteed to have a backwards compatible interface. [preview]
- This become is maintained by the Ansible Community. [community]

### Authors

- ansible (@core)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

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.