win_tempfile - Creates temporary files and directories.
New in version 2.3.
Synopsis
- Creates temporary files and directories.
- For non-Windows targets, please use the tempfile module instead.
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| path | no | %TEMP% | Location where temporary file or directory should be created. If path is not specified default system temporary directory (%TEMP%) will be used. | |
| prefix | no | ansible. | Prefix of file/directory name created by module. | |
| state | no | file |
| Whether to create file or directory. |
| suffix | no | Suffix of file/directory name created by module. |
Examples
- name: Create temporary build directory
win_tempfile:
state: directory
suffix: build
- name: Create temporary file
win_tempfile:
state: file
suffix: temp
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| path | Path to created file or directory | success | string | C:\Users\Administrator\AppData\Local\Temp\ansible.bMlvdk |
Notes
Note
- For non-Windows targets, please use the tempfile module instead.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/win_tempfile_module.html