ansible.windows.win_tempfile module – Creates temporary files and directories

Note

This module is part of the ansible.windows collection (version 2.5.0).

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.

Synopsis
Parameters
See Also
Examples
Return Values

Synopsis

Creates temporary files and directories.
For non-Windows targets, please use the ansible.builtin.tempfile module instead.

Parameters

Parameter	Comments
path aliases: dest path	Location where temporary file or directory should be created. If path is not specified default system temporary directory (%TEMP%) will be used. Default: `"%TEMP%"`
prefix string	Prefix of file/directory name created by module. Default: `"ansible."`
state string	Whether to create file or directory. Choices: `"directory"` `"file"` ← (default)
suffix string	Suffix of file/directory name created by module.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
path string	The absolute path to the created file or directory. Returned: success Sample: `"C:\\Users\\Administrator\\AppData\\Local\\Temp\\ansible.bMlvdk"`

Authors

Dag Wieers (@dagwieers)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2024 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