Note
This plugin is part of the ansible.windows collection (version 1.7.3).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ansible.windows
.
To use it in a playbook, specify: ansible.windows.win_tempfile
.
Parameter | Choices/Defaults | Comments |
---|---|---|
path path | Default: "%TEMP%" | Location where temporary file or directory should be created. If path is not specified default system temporary directory (%TEMP%) will be used. aliases: dest |
prefix string | Default: "ansible." | Prefix of file/directory name created by module. |
state string |
| Whether to create file or directory. |
suffix string | Default: "" | Suffix of file/directory name created by module. |
See also
The official documentation on the ansible.builtin.tempfile module.
- name: Create temporary build directory ansible.windows.win_tempfile: state: directory suffix: build - name: Create temporary file ansible.windows.win_tempfile: state: file suffix: temp
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
path string | success | The absolute path to the created file or directory. Sample: C:\Users\Administrator\AppData\Local\Temp\ansible.bMlvdk |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/windows/win_tempfile_module.html