如何通过CLI查看Ansible所有可用的Jinja2过滤器列表

方法1：Ansible 2.10及以上版本原生查询 #

• 执行命令ansible-doc -t filter -l，可直接输出所有内置Jinja2过滤器的名称和简要说明
• 若要查询单个过滤器的详细用法、参数、使用示例，执行ansible-doc -t filter 过滤器名称即可，比如查询default过滤器的用法可执行ansible-doc -t filter default

方法2：低版本Ansible兼容查询方案 #

如果使用的Ansible版本低于2.10，不支持filter类型的文档查询，可以通过临时执行调试playbook的方式输出全量过滤器：

• 新建一个临时yaml文件，写入如下内容：

- name: 打印所有可用Jinja2过滤器
  hosts: localhost
  gather_facts: no
  tasks:
    - name: 输出排序后的过滤器列表
      debug:
        msg: "{{ ansible_filters.keys() | sort }}"

• 执行ansible-playbook 刚才新建的文件名.yaml，运行后即可在输出中看到所有可用的过滤器名称

注意事项 #

• 上述两种方法输出的内容既包含Jinja2原生自带的过滤器，也包含Ansible额外扩展的自定义过滤器，完全覆盖日常使用场景
• 红帽Ansible相关认证考试的官方环境默认预装了完整的ansible-doc文档包，直接执行上述命令即可正常查询，无需联网操作

内容的提问来源于stack exchange，提问作者kungfubamba