ansible.builtin.template 查找 - 使用 Jinja2 模板化后检索文件内容
注意
此查找插件是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，您可以使用简短的插件名称 template。但是，我们建议您使用 完全限定集合名称 (FQCN) ansible.builtin.template 以方便链接到插件文档并避免与可能具有相同查找插件名称的其他集合发生冲突。
概要
返回一个字符串列表；对于您传递的模板列表中的每个模板，返回一个包含处理该模板结果的字符串。
术语
参数 |
注释 |
|---|---|
要模板化的文件列表 |
关键字参数
这描述了查找的关键字参数。这些是在以下示例中的值 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，则没有影响。 与模板模块相比，这提供了更大的灵活性，模板模块根本不使用 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='#]') }}"
返回值
键 |
描述 |
|---|---|
模板化后的文件内容 返回：成功 |