Documentation

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.

Options

parameter required default choices comments
path
no
Location where temporary file or directory should be created. If path is not specified default system temporary directory will be used.
prefix
no ansible.
Prefix of file/directory name created by module.
state
no file
  • file
  • directory
Whether to create file or directory.
suffix
no
Suffix of file/directory name created by module.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
path Path to created file or directory success string /tmp/ansible.bMlvdk


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.