ansible.windows.win_tempfile_module.rst

ansible.windows.win_tempfile

Creates temporary files and directories

• Synopsis
• Parameters
• See Also
• Examples
• Return Values
• Status

Synopsis

• Creates temporary files and directories.
• For non-Windows targets, please use the :ref:`ansible.builtin.tempfile <ansible.builtin.tempfile_module>` module instead.

Parameters

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	Choices: directory file ←	Whether to create file or directory.
suffix string	Default: ""	Suffix of file/directory name created by module.

See Also

.. seealso::

   :ref:`ansible.builtin.tempfile_module`
      The official documentation on the **ansible.builtin.tempfile** 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	Returned	Description
path string	success	The absolute path to the created file or directory. Sample: C:\Users\Administrator\AppData\Local\Temp\ansible.bMlvdk

Status

Authors

• Dag Wieers (@dagwieers)