W3cubDocs

/Ansible 2.10

ansible.windows.win_tempfile – Creates temporary files and directories

Note

This plugin is part of the ansible.windows collection.

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

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


Authors

  • Dag Wieers (@dagwieers)

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