ansible.builtin.sudo (v2.16.5) — become

Install Ansible via pip

Install with pip install ansible-core==2.16.5

Description

This become plugin allows your remote/login user to execute commands as another user via the sudo utility.

Inputs

    
become_exe:
    default: sudo
    description: Sudo executable
    env:
    - name: ANSIBLE_BECOME_EXE
    - name: ANSIBLE_SUDO_EXE
    ini:
    - key: become_exe
      section: privilege_escalation
    - key: executable
      section: sudo_become_plugin
    keyword:
    - name: become_exe
    vars:
    - name: ansible_become_exe
    - name: ansible_sudo_exe

become_pass:
    description: Password to pass to sudo
    env:
    - name: ANSIBLE_BECOME_PASS
    - name: ANSIBLE_SUDO_PASS
    ini:
    - key: password
      section: sudo_become_plugin
    required: false
    vars:
    - name: ansible_become_password
    - name: ansible_become_pass
    - name: ansible_sudo_pass

become_user:
    default: root
    description: User you 'become' to execute the task
    env:
    - name: ANSIBLE_BECOME_USER
    - name: ANSIBLE_SUDO_USER
    ini:
    - key: become_user
      section: privilege_escalation
    - key: user
      section: sudo_become_plugin
    keyword:
    - name: become_user
    vars:
    - name: ansible_become_user
    - name: ansible_sudo_user

become_flags:
    default: -H -S -n
    description: Options to pass to sudo
    env:
    - name: ANSIBLE_BECOME_FLAGS
    - name: ANSIBLE_SUDO_FLAGS
    ini:
    - key: become_flags
      section: privilege_escalation
    - key: flags
      section: sudo_become_plugin
    keyword:
    - name: become_flags
    vars:
    - name: ansible_become_flags
    - name: ansible_sudo_flags