From ebcf1654c49ef3ce53771579aa903f2e1293c231 Mon Sep 17 00:00:00 2001 From: jw-maynard Date: Thu, 25 Aug 2022 12:54:41 -0700 Subject: [PATCH] Note that `become_user` is required for `runas` (#78603) --- .../rst/playbook_guide/playbooks_privilege_escalation.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/docsite/rst/playbook_guide/playbooks_privilege_escalation.rst b/docs/docsite/rst/playbook_guide/playbooks_privilege_escalation.rst index 44e4cab9fe0..3b28d385a8d 100644 --- a/docs/docsite/rst/playbook_guide/playbooks_privilege_escalation.rst +++ b/docs/docsite/rst/playbook_guide/playbooks_privilege_escalation.rst @@ -387,7 +387,9 @@ Become and Windows Since Ansible 2.3, ``become`` can be used on Windows hosts through the ``runas`` method. Become on Windows uses the same inventory setup and invocation arguments as ``become`` on a non-Windows host, so the setup and -variable names are the same as what is defined in this document. +variable names are the same as what is defined in this document with the exception +of ``become_user``. As there is no sensible default for ``become_user`` on Windows +it is required when using ``become``. See :ref:`ansible.builtin.runas become plugin ` for details. While ``become`` can be used to assume the identity of another user, there are other uses for it with Windows hosts. One important use is to bypass some of the