ansible.netcommon.enable become – Switch to elevated permissions on a network device

Note

This become plugin is part of the ansible.netcommon collection (version 8.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 ansible.netcommon.

To use it in a playbook, specify: ansible.netcommon.enable.

New in ansible.netcommon 1.0.0

Synopsis

  • This become plugins allows elevated permissions on a remote network device.

Parameters

Parameter

Comments

become_pass

string

password

Configuration:

  • INI entry:

    [enable_become_plugin]
password = VALUE

  • Environment variable: ANSIBLE_BECOME_PASS

  • Environment variable: ANSIBLE_ENABLE_PASS

  • Variable: ansible_become_password

  • Variable: ansible_become_pass

  • Variable: ansible_enable_pass

Note

Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) 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. The entry types are also ordered by precedence from low to high priority order. For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).

Notes

Note

  • enable is really implemented in the network connection handler and as such can only be used with network connections.

  • This plugin ignores the ‘become_exe’ and ‘become_user’ settings as it uses an API and not an executable.

Authors

  • Ansible Networking Team (@ansible-network)