Docs4dev
Docs
ansible / 2.6 / modules / win_tempfile_module.html

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.

Parameters

Parameter Choices/Defaults Comments
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.
prefix Default:
"ansible."
Prefix of file/directory name created by module.
state
    Choices:
  • directory
  • file ←
Whether to create file or directory.
suffix Default:
""
Suffix of file/directory name created by module.

Notes

Note

  • For non-Windows targets, please use the tempfile module instead.

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, 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


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Dag Wieers (@dagwieers)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/win_tempfile_module.html