ansible.builtin.powershell shell – Windows PowerShell
Note
This shell plugin is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
plugin name
powershell
.
However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.powershell
for easy linking to the
plugin documentation and to avoid conflicting with other collections that may have
the same shell plugin name.
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.
Aliases: formerly_core_powershell
Parameters
Parameter |
Comments |
---|---|
Directory in which ansible will keep async job information. Before Ansible 2.8, this was set to Default: Configuration:
|
|
List of dictionaries of environment variables and their values to use when executing commands. Default: |
|
Temporary directory to use on targets when copying files to the host. Default: Configuration:
|
|
Controls if we set the locale for modules when executing on the target. Windows only supports Choices:
|
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.