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 原生类型的 template 模块更大的灵活性。 与 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='#]') }}"
返回值
键 |
描述 |
---|---|
模板化后的文件内容 返回: 成功 |