ansible.builtin.file lookup – 读取文件内容

注意

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

概要

  • 此 lookup 返回 Ansible 控制器的文件系统上的文件内容。

术语

参数

注释

术语

字符串 / 必需

要读取的文件路径

关键字参数

这描述了 lookup 的关键字参数。这些是在以下示例中的值 key1=value1，key2=value2 等：lookup('ansible.builtin.file', key1=value1, key2=value2, ...) 和 query('ansible.builtin.file', key1=value1, key2=value2, ...)

参数

注释

lstrip

布尔值

是否从查找的文件开头删除空格

选项

  • false ← (默认)

  • true

rstrip

布尔值

是否从查找的文件结尾删除空格

选项

  • false

  • true ← (默认)

备注

注意

  • 当一起使用关键字参数和位置参数时，位置参数必须列在关键字参数之前：lookup('ansible.builtin.file', term1, term2, key1=value1, key2=value2) 和 query('ansible.builtin.file', term1, term2, key1=value1, key2=value2)

  • 如果在变量上下文中读取，如果内容对解析器有效，则文件可以解释为 YAML。

  • 此 lookup 不理解“通配符”，请改用 fileglob lookup。

另请参见

另请参见

任务路径

用于相对文件的搜索路径。

示例

- ansible.builtin.debug:
    msg: "the value of foo.txt is {{ lookup('ansible.builtin.file', '/etc/foo.txt') }}"

- name: display multiple file contents
  ansible.builtin.debug: var=item
  with_file:
    - "/path/to/foo.txt"
    - "bar.txt"  # will be looked in files/ dir relative to play or in role
    - "/path/to/biz.txt"

返回值

键

描述

返回值

列表 / 元素=字符串

文件内容

返回：成功

作者

  • Daniel Hokka Zakrisson

提示

每个条目类型的配置条目具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。