.. _become_plugins:

Become plugins

.. contents:: :local: :depth: 2

.. versionadded:: 2.8

Become plugins work to ensure that Ansible can use certain privilege escalation systems when running the basic commands to work with the target machine as well as the modules required to execute the tasks specified in the play.

These utilities (sudo, su, doas, and so on) generally let you 'become' another user to execute a command with the permissions of that user.

.. _enabling_become:

Enabling Become Plugins

The become plugins shipped with Ansible are already enabled. Custom plugins can be added by placing them into a become_plugins directory adjacent to your play, inside a role, or by placing them in one of the become plugin directory sources configured in :ref:ansible.cfg <ansible_configuration_settings>.

.. _using_become:

Using Become Plugins

In addition to the default configuration settings in :ref:ansible_configuration_settings or the --become-method command line option, you can use the become_method keyword in a play or, if you need to be 'host specific', the connection variable ansible_become_method to select the plugin to use.

You can further control the settings for each plugin with other configuration options detailed in the plugin themselves (linked below).

.. _become_plugin_list:

Plugin List

You can use ansible-doc -t become -l to see the list of available plugins. Use ansible-doc -t become <plugin name> to see plugin-specific documentation and examples.

.. seealso::

:ref:about_playbooks An introduction to playbooks :ref:inventory_plugins Inventory plugins :ref:callback_plugins Callback plugins :ref:filter_plugins Filter plugins :ref:test_plugins Test plugins :ref:lookup_plugins Lookup plugins :ref:Communication<communication> Got questions? Need help? Want to share your ideas? Visit the Ansible communication guide