过滤器插件
过滤器插件用于操作数据。使用正确的过滤器,您可以提取特定值、转换数据类型和格式、执行数学计算、分割和连接字符串、插入日期和时间等等。Ansible 使用 Jinja2 附带的标准过滤器,并添加了一些专门的过滤器插件。您可以创建自定义 Ansible 过滤器作为插件。
启用过滤器插件
您可以通过将自定义过滤器插件放入 playbook 旁边的 filter_plugins
目录、角色内部,或将其放入 ansible.cfg 中配置的过滤器插件目录源之一来添加自定义过滤器插件。
使用过滤器插件
您可以在 Ansible 中使用模板的任何地方使用过滤器:在 playbook 中、在变量文件中或 template 模块的 Jinja2 模板中。有关使用过滤器插件的更多信息,请参见使用过滤器操作数据。过滤器可以返回任何类型的数据,但如果您希望始终返回布尔值(true
或 false
),则应该使用测试而不是过滤器。
vars:
yaml_string: "{{ some_variable|to_yaml }}"
过滤器是在 Ansible 中操作数据的首选方法,您可以通过其前面通常带有 |
来识别过滤器,其左侧的表达式是过滤器的第一个输入。可以将其他参数传递到过滤器本身,就像传递到大多数编程函数一样。这些参数可以是 positional
(按顺序传递)或 named
(作为键值对传递)。当同时传递这两种类型时,位置参数应放在前面。
passing_positional: {{ (x == 32) | ternary('x is 32', 'x is not 32') }}
passing_extra_named_parameters: {{ some_variable | to_yaml(indent=8, width=1337) }}
passing_both: {{ some_variable| ternary('true value', 'false value', none_val='NULL') }}
在文档中,过滤器将始终具有一个 C(_input) 选项,该选项对应于 c(| 左侧的表达式。文档中的 C(positional:) 字段将显示哪些选项是位置参数以及它们所需的顺序。
插件列表
您可以使用 ansible-doc -t filter -l
查看可用插件的列表。使用 ansible-doc -t filter <plugin name>
查看特定插件的文档和示例。