ansible.builtin.template lookup – 使用 Jinja2 模板化后检索文件内容
注意
此 lookup 插件是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，您可以使用简短的插件名称 template。但是，我们建议您使用 完全限定集合名称 (FQCN) ansible.builtin.template 以便轻松链接到插件文档，并避免与可能具有相同 lookup 插件名称的其他集合发生冲突。
摘要
返回一个字符串列表；对于您传入的模板列表中的每个模板，返回一个包含处理该模板结果的字符串。
术语
参数 |
注释 |
|---|---|
要模板化的文件列表 |
关键字参数
此描述了 lookup 的关键字参数。这些是在以下示例中的 key1=value1、key2=value2 等值：lookup('ansible.builtin.template', key1=value1, key2=value2, ...) 和 query('ansible.builtin.template', key1=value1, key2=value2, ...)
参数 |
注释 |
|---|---|
标记注释语句结束的字符串。 默认值： |
|
标记注释语句开始的字符串。 默认值： |
|
是否将 YAML 转换为数据。如果为 False，则 YAML 字符串将保持不变。 与 jinja2_native 选项互斥。 选项
|
|
控制是否使用 Jinja2 原生类型。 即使全局 jinja2_native 为 True，默认情况下也关闭。 如果全局 jinja2_native 为 False，则无效。 这提供了比 template 模块更多的灵活性，template 模块根本不使用 Jinja2 原生类型。 与 convert_data 选项互斥。 选项
|
|
一个字典，键成为可用于模板化的附加变量。 默认值： |
|
标记打印语句结束的字符串。 默认值： |
|
标记打印语句开始的字符串。 默认值： |
备注
注意
当一起使用关键字和位置参数时，必须先列出位置参数，然后再列出关键字参数：
lookup('ansible.builtin.template', term1, term2, key1=value1, key2=value2)和query('ansible.builtin.template', term1, term2, key1=value1, key2=value2)
另请参阅
另请参阅
- 任务路径
用于相对模板的搜索路径。
示例
- name: show templating results
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.template', './some_template.j2') }}"
- name: show templating results with different variable start and end string
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.template', './some_template.j2', variable_start_string='[%', variable_end_string='%]') }}"
- name: show templating results with different comment start and end string
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.template', './some_template.j2', comment_start_string='[#', comment_end_string='#]') }}"
返回值
键 |
描述 |
|---|---|
模板化后的文件内容 返回：成功 |