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

Note

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

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

  • 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.

See Also

See also

ansible.builtin.tempfile

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 with custom prefix
  ansible.windows.win_tempfile:
    state: file
    prefix: customlog_

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