ansible.builtin.tempfile 模块 – 创建临时文件和目录

注意

此模块是 ansible-core 的一部分,包含在所有 Ansible 安装中。在大多数情况下,即使不指定 collections 关键字,您也可以使用简短的模块名称 tempfile。但是,我们建议您使用 完全限定的集合名称 (FQCN) ansible.builtin.tempfile,以便轻松链接到模块文档并避免与可能具有相同模块名称的其他集合冲突。

摘要

  • ansible.builtin.tempfile 模块创建临时文件和目录。mktemp 命令在不同的系统上采用不同的参数,此模块有助于避免与此相关的麻烦。模块创建的文件/目录仅创建者可访问。如果您需要使它们对所有人可访问,则需要使用 ansible.builtin.file 模块。

  • 对于 Windows 目标,请改用 ansible.windows.win_tempfile 模块。

参数

参数

注释

path

path

应在其中创建临时文件或目录的位置。

如果未指定 path,则将使用默认的系统临时目录。

prefix

字符串

模块创建的文件/目录名称的前缀。

默认值: "ansible."

state

字符串

是要创建文件还是目录。

选项

  • "directory"

  • "file" ← (默认)

suffix

字符串

模块创建的文件/目录名称的后缀。

默认值: ""

属性

属性

支持

描述

check_mode

支持: 不支持

可以在 check_mode 中运行并返回已更改状态预测,而无需修改目标,如果不受支持,则操作将被跳过。

diff_mode

支持: 不支持

在差异模式下,将返回有关已更改内容(或可能需要在 check_mode 中更改的内容)的详细信息

platform

平台: posix

可以对其进行操作的目标操作系统/系列

另请参见

另请参见

ansible.builtin.file

管理文件和文件属性。

ansible.windows.win_tempfile

ansible.windows.win_tempfile 模块的官方文档。

示例

- name: Create temporary build directory
  ansible.builtin.tempfile:
    state: directory
    suffix: build

- name: Create temporary file
  ansible.builtin.tempfile:
    state: file
    suffix: temp
  register: tempfile_1

- name: Create a temporary file with a specific prefix
  ansible.builtin.tempfile:
     state: file
     suffix: txt
     prefix: myfile_

- name: Use the registered var and the file module to remove the temporary file
  ansible.builtin.file:
    path: "{{ tempfile_1.path }}"
    state: absent
  when: tempfile_1.path is defined

返回值

此处记录了常见的返回值 此处,以下是此模块特有的字段

描述

path

字符串

已创建文件或目录的路径。

已返回:成功

示例: "/tmp/ansible.bMlvdk"

作者

  • Krzysztof Magosa (@krzysztof-magosa)