For community users, you are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible community documentation . For Red Hat customers, see the Red Hat AAP platform lifecycle.

powershell – Windows PowerShell¶

Synopsis
Parameters
Status

Synopsis ¶

The only option when using ‘winrm’ or ‘psrp’ as a connection plugin.
Can also be used when using ‘ssh’ as a connection plugin and the DefaultShell has been configured to PowerShell.

Parameters ¶

Parameter	Choices/Defaults	Configuration	Comments
async_dir - added in 2.8	Default: "%USERPROFILE%\\.ansible_async"	ini entries: [powershell] async_dir = %USERPROFILE%\.ansible_async var: ansible_async_dir	Directory in which ansible will keep async job information. Before Ansible 2.8, this was set to `remote_tmp + "\.ansible_async"`.
environment dictionary	Default: {}		Dictionary of environment variables and their values to use when executing commands.
remote_tmp -	Default: "%TEMP%"	ini entries: [powershell] remote_tmp = %TEMP% var: ansible_remote_tmp	Temporary directory to use on targets when copying files to the host.
set_module_language boolean	Choices: no ← yes		Controls if we set the locale for moduels when executing on the target. Windows only supports `no` as an option.

Status ¶

This shell is not guaranteed to have a backwards compatible interface. [preview]
This shell is maintained by the Ansible Community. [community]

Authors¶

UNKNOWN

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

Hint

Configuration entries for each entry type 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.