ansible / ansible.builtin / v2.9.27 / module / win_psexec Runs commands (remotely) as another (privileged) user | "added in version" 2.3 of ansible.builtin" Authors: Dag Wieers (@dagwieers) preview | supported by communityansible.builtin.win_psexec (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
Run commands (remotely) through the PsExec service.
Run commands as another (domain) user (with elevated privileges).
- name: Test the PsExec connection to the local system (target node) with your user win_psexec: command: whoami.exe
- name: Run regedit.exe locally (on target node) as SYSTEM and interactively win_psexec: command: regedit.exe interactive: yes system: yes
- name: Run the setup.exe installer on multiple servers using the Domain Administrator win_psexec: command: E:\setup.exe /i /IACCEPTEULA hostnames: - remote_server1 - remote_server2 username: DOMAIN\Administrator password: some_password priority: high
- name: Run PsExec from custom location C:\Program Files\sysinternals\ win_psexec: command: netsh advfirewall set allprofiles state off executable: C:\Program Files\sysinternals\psexec.exe hostnames: [ remote_server ] password: some_password priority: low
wait: default: true description: - Wait for the application to terminate. - Only use for non-interactive applications. type: bool chdir: description: - Run the command from this (remote) directory. type: path system: default: false description: - Run the remote command in the System account. type: bool command: description: - The command line to run through PsExec (limited to 260 characters). required: true type: str limited: default: false description: - Run the command as limited user (strips the Administrators group and allows only privileges assigned to the Users group). type: bool session: description: - Specifies the session ID to use. - This parameter works in conjunction with I(interactive). - It has no effect when I(interactive) is set to C(no). type: int version_added: '2.7' version_added_collection: ansible.builtin timeout: description: - The connection timeout in seconds type: int elevated: default: false description: - Run the command with elevated privileges. type: bool nobanner: default: false description: - Do not display the startup banner and copyright message. - This only works for specific versions of the PsExec binary. type: bool version_added: '2.4' version_added_collection: ansible.builtin password: description: - The password for the (remote) user to run the command as. - This is mandatory in order authenticate yourself. type: str priority: choices: - abovenormal - background - belownormal - high - low - realtime description: - Used to run the command at a different priority. username: description: - The (remote) user to run the command as. - If not provided, the current user is used. type: str hostnames: description: - The hostnames to run the command. - If not provided, the command is run locally. type: list noprofile: default: false description: - Run the command without loading the account's profile. type: bool executable: default: psexec.exe description: - The location of the PsExec utility (in case it is not located in your PATH). type: path extra_opts: description: - Specify additional options to add onto the PsExec invocation. - This module was undocumented in older releases and will be removed in Ansible 2.10. type: list interactive: default: false description: - Run the program so that it interacts with the desktop on the remote system. type: bool
cmd: description: The complete command line used by the module, including PsExec call and additional options. returned: always sample: psexec.exe -nobanner \\remote_server -u "DOMAIN\Administrator" -p "some_password" -accepteula E:\setup.exe type: str pid: description: The PID of the async process created by PsExec. returned: when C(wait=False) sample: 1532 type: int rc: description: The return code for the command. returned: always sample: 0 type: int stderr: description: The error output from the command. returned: always sample: Error 15 running E:\setup.exe type: str stdout: description: The standard output from the command. returned: always sample: Success. type: str