Docs4dev
Docs
ansible / 2.6 / modules / tempfile_module.html

tempfile - Creates temporary files and directories.

New in version 2.3.

Synopsis

  • The tempfile module creates temporary files and directories. mktemp command takes different parameters on various systems, this module helps to avoid troubles related to that. Files/directories created by module are accessible only by creator. In case you need to make them world-accessible you need to use file module.
  • For Windows targets, use the win_tempfile module instead.

Parameters

Parameter Choices/Defaults Comments
path
Location where temporary file or directory should be created. If path is not specified default system temporary directory 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

Examples

- name: create temporary build directory
  tempfile:
    state: directory
    suffix: build

- name: create temporary file
  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
Path to created file or directory

Sample:
/tmp/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

  • Krzysztof Magosa

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/tempfile_module.html