Ansible常用Filter

最新推荐文章于 2024-01-15 23:31:26 发布
最新推荐文章于 2024-01-15 23:31:26 发布
阅读量3.6k 收藏 5
点赞数
分类专栏： Ansible 文章标签： Ansible Filter
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/L835311324/article/details/103354692
版权

文章目录

Ansible 常用Filter

Ansible中的过滤器来自Jinja2，用于在模板表达式中转换数据。在写playbook的时候，偶尔需要对变量进行处理，比如在一段json文件中查找某些值进行循环，又比如获取了一段地址但是需要对它进行切分取basename，又比如直接从对一段url进行切分处理，等等等等，在Ansible内部实现了许多Filter对上述的这些场景都提供了比较健全的Filter，这里列出一些常用的Filter，更全面的可以查看ansible的官方文档，和jinja2的文档，地址都已在参考文档章节中给出，

示例json文件

// 示例字符串
// $ cat domain_definition.json
{
        "domain": {
            "cluster": [
                {
                    "name": "cluster1"
                },
                {
                    "name": "cluster2"
                }
            ],
            "server": [
                {
                    "name": "server11",
                    "cluster": "cluster1",
                    "port": "8080"
                },
                {
                    "name": "server12",
                    "cluster": "cluster1",
                    "port": "8090"
                },
                {
                    "name": "server21",
                    "cluster": "cluster2",
                    "port": "9080"
                },
                {
                    "name": "server22",
                    "cluster": "cluster2",
                    "port": "9090"
                }
            ],
            "library": [
                {
                    "name": "lib1",
                    "target": "cluster1"
                },
                {
                    "name": "lib2",
                    "target": "cluster2"
                }
            ]
        }
}

from_json

from_json filter从json格式变量中加载成字典变量


# 查看playbook内容，从加载json文件
$ cat from_json.yml
- hosts: 192.168.240.33
  gather_facts: no # 本次playbook 不收集fact信息
  tasks:
    - name: from_json filter test
      debug:
        var:  domain_definition
  vars:
    domain_definition: "{{ lookup('file','/home/ansible/ADT/domain_definition.json') | from_json  }}"
    
# 执行
$ ansible-playbook from_json.yml

PLAY [192.168.240.33] ***********************************************************************************************************************************************

TASK [from_json filter test] ****************************************************************************************************************************************
ok: [192.168.240.33] => {
    "domain_definition": {
        "domain": {
            "cluster": [
                {
                    "name": "cluster1"
                },
                {
                    "name": "cluster2"
                }
            ],
            "library": [
                {
                    "name": "lib1",
                    "target": "cluster1"
                },
                {
                    "name": "lib2",
                    "target": "cluster2"
                }
            ],
            "server": [
                {
                    "cluster": "cluster1",
                    "name": "server11",
                    "port": "8080"
                },
                {
                    "cluster": "cluster1",
                    "name": "server12",
                    "port": "8090"
                },
                {
                    "cluster": "cluster2",
                    "name": "server21",
                    "port": "9080"
                },
                {
                    "cluster": "cluster2",
                    "name": "server22",
                    "port": "9090"
                }
            ]
        }
    }
}

PLAY RECAP **********************************************************************************************************************************************************
192.168.240.33             : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

json query filter

json查询过滤器,测试的playbook如下，#注释部分表示对应task的输出信息

$ cat json_query.yml
---

- hosts: 192.168.240.33
  gather_facts: no
  vars:
    domain_definition: "{{ lookup('file','/home/ansible/ADT/domain_definition.json') | from_json  }}"
  tasks:
    - name: "Display all cluster names"
      debug:
        var:  item
      loop: "{{ domain_definition | json_query('domain.cluster[*].name') }}"

#TASK [Display all cluster names] ************************************************************************************************************************************
#ok: [192.168.240.33] => (item=cluster1) => {
#    "ansible_loop_var": "item",
#    "item": "cluster1"
#}
#ok: [192.168.240.33] => (item=cluster2) => {
#    "ansible_loop_var": "item",
#    "item": "cluster2"
#}


    - name: "Display all server names"
      debug:
        var: item
      loop: "{{ domain_definition | json_query('domain.server[*].name') }}"

#TASK [Display all server names] *************************************************************************************************************************************
#ok: [192.168.240.33] => (item=server11) => {
#    "ansible_loop_var": "item",
#    "item": "server11"
#}
#ok: [192.168.240.33] => (item=server12) => {
#    "ansible_loop_var": "item",
#    "item": "server12"
#}
#ok: [192.168.240.33] => (item=server21) => {
#    "ansible_loop_var": "item",
#    "item": "server21"
#}
#ok: [192.168.240.33] => (item=server22) => {
#    "ansible_loop_var": "item",
#    "item": "server22"
#}
#


    - name: "Display all server ports and names from cluster1"
      debug:
        var: item
      loop: "{{ domain_definition | json_query(server_name_cluster1_query) }}"
      vars:
        server_name_cluster1_query: "domain.server[?cluster=='cluster1'].port"

#TASK [Display all server ports and names from cluster1] *************************************************************************************************************
#ok: [192.168.240.33] => (item=8080) => {
#    "ansible_loop_var": "item",
#    "item": "8080"
#}
#ok: [192.168.240.33] => (item=8090) => {
#    "ansible_loop_var": "item",
#    "item": "8090"
#}


    - name: "Display all ports from cluster1 as a string"
      debug:
        msg: "{{ domain_definition | json_query('domain.server[?cluster==`cluster1`].port') | join(', ') }}"

#TASK [Display all ports from cluster1 as a string] ******************************************************************************************************************
#ok: [192.168.240.33] => {
#    "msg": "8080, 8090"
#}


    - name: "Display all server ports and names from cluster1"
      debug:
        var: item
      loop: "{{ domain_definition | json_query(server_name_cluster1_query) }}"
      vars:
        server_name_cluster1_query: "domain.server[?cluster=='cluster2'].{name: name, port: port}"



#TASK [Display all server ports and names from cluster1] *************************************************************************************************************
#ok: [192.168.240.33] => (item={u'name': u'server21', u'port': u'9080'}) => {
#    "ansible_loop_var": "item",
#    "item": {
#        "name": "server21",
#        "port": "9080"
#    }
#}
#ok: [192.168.240.33] => (item={u'name': u'server22', u'port': u'9090'}) => {
#    "ansible_loop_var": "item",
#    "item": {
#        "name": "server22",
#        "port": "9090"
#    }
#}

list filters

列表过滤器

# 求列表最小值
$ ansible 192.168.240.33 -m debug -a 'msg="{{ [1,2,3,4] | min }}"'
192.168.240.33 | SUCCESS => {
    "msg": "1"
}
# 求列表最大值
$ ansible 192.168.240.33 -m debug -a 'msg="{{ [1,2,3,4] | max }}"'
192.168.240.33 | SUCCESS => {
    "msg": "4"
}
# 将列表展开，这个在某些场景下非常有用
$ ansible 192.168.240.33 -m debug -a 'msg="{{ [1,2,[3,4]] | flatten }}"'
192.168.240.33 | SUCCESS => {
    "msg": [
        1,
        2,
        3,
        4
    ]
}

# 也可以指定展开多少层
$ ansible 192.168.240.33 -m debug -a 'msg="{{ [1,2,[3,[4]]] | flatten(levels=1) }}"'
192.168.240.33 | SUCCESS => {
    "msg": [
        1,
        2,
        3,
        [
            4
        ]
    ]
}

# 对列表去重
$ ansible 192.168.240.33 -m debug -a 'msg="{{ [1,2,3,3,3,4,5,5]| unique }}"'
192.168.240.33 | SUCCESS => {
    "msg": [
        1,
        2,
        3,
        4,
        5
    ]
}

# 对比两个列表去除不同的值
$ ansible 192.168.240.33 -m debug -a 'msg="{{ [1,2,3,3,3,4,5,5]| difference([1,2,3]) }}"'
192.168.240.33 | SUCCESS => {
    "msg": [
        4,
        5
    ]
}

random number filter

随机数生成器

# 60以内随机生成一个整数
$ ansible 192.168.240.33 -m debug -a 'msg="{{ 60 | random }}"'
192.168.240.33 | SUCCESS => {
    "msg": "1"
}

$ ansible 192.168.240.33 -m debug -a 'msg="{{ 60 | random }}"'
192.168.240.33 | SUCCESS => {
    "msg": "21"
}

# 从列表中随机选择一个数字
$ ansible 192.168.240.33 -m debug -a 'msg="{{ [1,2,4,5] | random }}"'
192.168.240.33 | SUCCESS => {
    "msg": "5"
}

$ ansible 192.168.240.33 -m debug -a 'msg="{{ [1,2,4,5] | random }}"'
192.168.240.33 | SUCCESS => {
    "msg": "2"
}

IP address filter

ip地址过滤器,此filter需要安装netaddr模块，安装方法如下pip install netaddr，否则会报错，报错信息如下：

fatal: [192.168.240.33]: FAILED! => {"msg": "The ipaddr filter requires python's netaddr be installed on the ansible controller"}

示例：

{{ '192.0.2.1/24' | ipaddr('address') }}

Hashing filters

hash过滤器

# 示例playbook
$ cat hash_filter.yml
---
- hosts: 192.168.240.33
  gather_facts: no
  vars:
    str: 'string'
  tasks:
    - debug:
        msg: "{{ str | hash('md5') }}"

# 执行结果
$ ansible-playbook hash_filter.yml

PLAY [192.168.240.33] *******************************************************************************************************************

TASK [debug] ****************************************************************************************************************************
ok: [192.168.240.33] => {
    "msg": "b45cffe084dd3d20d928bee85e7b0f21"
}

PLAY RECAP ******************************************************************************************************************************
192.168.240.33             : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

URL Split Filter

url切分过滤器

$ cat url_split_filter.yml
---
- hosts: 192.168.240.33
  gather_facts: no
  vars:
    url: 'http://user:password@www.acme.com:9000/dir/index.html?query=term#fragment'
  tasks:
    - name: "get url hostname"
      debug:
        msg: "{{ url | urlsplit('hostname')  }}"
        
# ==> "msg": "www.acme.com"

    - name: "get url netloc"
      debug:
        msg: "{{ url | urlsplit('netloc')  }}"
# ==> "user:password@www.acme.com:9000"
    - name: "get url path"
      debug:
        msg: "{{ url | urlsplit('path')  }}"

# ==> "msg": "/dir/index.html"
    - name: "get url port"
      debug:
        msg: "{{ url | urlsplit('port')  }}"

# ==> "msg": "9000"

    - name: "get url scheme"
      debug:
        msg: "{{ url | urlsplit('scheme')  }}"

# ==> "msg": "http"

    - name: "get url query"
      debug:
        msg: "{{ url | urlsplit('query') }}"

# ==> "msg": "query=term"

path Filter

路径filter

# 获取basename
$ ansible 192.168.240.33 -m debug -a 'msg={{  "/home/archforce/ADT/hosts.ini" | basename }}'
192.168.240.33 | SUCCESS => {
    "msg": "hosts.ini"
}

# 获取目录
$ ansible 192.168.240.33 -m debug -a 'msg={{  "/home/archforce/ADT/hosts.ini" | dirname }}'
192.168.240.33 | SUCCESS => {
    "msg": "/home/archforce/ADT"
}

# 获取绝对路径
$ ansible 192.168.240.33 -m debug -a 'msg={{  "./hosts.ini" | realpath }}'
192.168.240.33 | SUCCESS => {
    "msg": "/home/ansible/ADT/hosts.ini"
}

Debug Filters

用于debug的filter

$ ansible 192.168.240.33 -m debug -a 'msg={{  "hello world" | type_debug }}'
192.168.240.33 | SUCCESS => {
    "msg": "str"
}

Debug Filters

用于debug的filter

$ ansible 192.168.240.33 -m debug -a 'msg={{  "hello world" | type_debug }}'
192.168.240.33 | SUCCESS => {
    "msg": "str"
}

参考文档

  • Ansible 官方文档：https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html#filters-for-formatting-data
  • jinja2官方文档：https://jinja.palletsprojects.com/en/2.10.x/templates/#builtin-filters
  • ip address filter官方文档：https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters_ipaddr.html
十五十六
关注
专栏目录
Ansible中常用模块
weixin_56744753的博客
10-30 1649
Ad-Hoc 利用ansible命令直接完成管理，主要用于临时命令使用场景。playbook ansible脚本，主要用于大型项目场景，需要前期的规划。在ansible主机上修改文件内容，开启备份，再次发送 先修改一下文件。从受控主机把文件复制到ansible主机，但不支持目录。Linux中的很多通配符在command模块中不支持。在ansible主机中写好的脚本在受控主机中执行。直接输入文件内容，在受控主机上生成文件。从ansible主机复制文件到受控主机。在远程主机执行命令，此模块为默认模块。
Ansible中常用的模块
LRJ2034203479的博客
07-25 7073
ansible实现管理的方式、命令运行方式、基本颜色代表和常用模块 1.command模块；2.shell模块；3.script模块；4.copy模块5.fetch模块；6.file模块；7.unarchive模块；8.archive模块；9.hostname模块；10.cron模块；11.yum_repository模块；12.dnf模块；13.service模块；14.firewall15.user模块 16.group模块；17.lineinfile模块、replac、setup模块、 debug模块
ansible的Filter
weixin_34194551的博客
05-07 231
filter的格式: value..| filter() 　在python中就是类的实例化　filter(self,*args,**kwargs) self就是filter中管道符前的value。 本文基于ansible 2.4.2.0版本 core.py中核心过滤器 　　　　　　　 # jinja2 overrides 　　　　　　　 'groupby': do_groupby...
ansible filter_plugins插件实现jinja2自定义filter过滤器
weixin_34087503的博客
07-21 282
前言：   filter_plugins是什么？ 这个单词拆解下，filter ！  熟悉jinja2模板的人，到知道他是过滤器，可以在模板中以管道的方式用pyhton的代码处理字符串。　ansible模板调用的是jinja2，这个大家都知道 。 这个filter_plugins插件代码，就是为了更好的处理jinja2模板中的字符串和逻辑判断的。 先前，我和沈灿讨论一个模板的问题，实在蛋疼的要命，...
Ansible Filter
weixin_30437481的博客
06-20 132
没啥好说的. 自己看吧 http://docs.ansible.com/ansible/playbooks_filters.html 转载于:https://www.cnblogs.com/v394435982/p/5599615.html
ansible-playbook filter过滤器使用
魏志标的博客
01-08 939
过滤器（filters）"可以帮助我们对数据进行处理 跟字符串有关的操作 --- - hosts: test70 remote_user: root vars: testvar: "abc123ABC 666" testvar1: " abc " testvar2: '123456789' testvar3: "1a2b,@#$%^&" tasks: - debug: #将字符串转换成纯大写 msg: "{{ testvar
Ansible的filter
duke_ding2的博客
11-10 624
Ansible的filter
ansible常用模块
w2535636586的博客
10-23 1696
ansible常用模块
ansible的常用模块
S_K15的博客
11-08 1637
ansible的常用模块一、ansible Ad-Hoc命令集二、ansible的命令参数三、ansible的常用模块1、command模块2、shell模块、script模块3、copy模块、fetch模块4、file模块5、archive模块、unarchive模块6、hostname模块、cron模块 一、ansible Ad-Hoc命令集 1、ansible提供两种方式去完成任务，一是 Ad-Hoc 命令，一是写 ansible playbook。 2、Ad-Hoc更注重于解决一些简单或者平时工作中
全网最全的Ansible中常用模块讲解
好久没说梦想的博客
02-16 2689
本章内容主要讲解ansible中常用模块，ansible实现管理的方式、ansible命令运行方式及常用参数、ansible中的常用模块中的command、shell、script、copy、fetch、file、unarchive、archive、hostname、cron、dnf、service、firewalld、user、group、lineinfile、replace、setup、debug模块，每一个模块各自的作用。什么是模块？
Ansible Filter滤波器的使用（一）
m0_62856417的博客
01-14 2142
介绍一下Ansible的内置函数，也被称之为过滤器
Ansible - plugin - filter
chuckchen1222的博客
05-29 339
filter： {{ value | function}} 输出的就是function(value) 将 value 当参数，执行 | 后边的function，可以执行ansible带的，也可以自己定义。 在自定义中，先创建类，类名统一为 FilterModule, 类只需要建一个方法，filter，用来返回执行的函数。 具体执行的function可以写在类外边。 ====...
Ansible过滤器使用总结
果冻想
10-29 2918
前言不知道Python中的Jinja2模板语言有没有听过，没听过不要紧，它不是今天的重点，你也可以抽空去百度一下。今天的重点是Jinja2中内置的filter功能，这个filter可以用...
《Ansible变量篇：ansible中事实变量facts》
东城绝神
03-07 1860
《Ansible变量篇：ansible中事实变量facts》
Ansible Filter滤波器的使用（二）
最新发布
m0_62856417的博客
01-15 1212
总结一下ansible的过滤器
Ansible 自定义过滤器统计节点的运行结果
u010113413的博客
10-15 1792
Ansible是一个基于Python开发的自动化运维工具，用于批量配置系统、部署程序、运行命令等，其哲学是”Simplicity and ease-of-use”，堪称运维神器！ Ansible的基础知识详见官网，还有这篇博客写得挺不错。Ansible多用于批量机器的环境部署，官网上给的Examples上面的大多例子都是各种开发环境的配置，比如LAMP环境的配置。 --- # This pl...
ansible 模板
blackfwhite的博客
12-17 331
ansible 模板使用语法： 1. 使服务器执行一个shell 命令 - name: execute a shell command （ansible 任务名称，可写可不写，写了直观，同时可以直接根据任务名称定位到 任务行） shell : hostname (表示 在服务器上执行 hostname 这条命令) 或 - shell: hostname 2. co...
使用kuberspay部署高可用kubernetes集群
zhuchuangang的专栏
08-30 9899
环境 安装 ansible 设置免密登录 下载kuberspay源码 将grcio和quayio的镜像上传到阿里云 镜像替换 配置文件内容 生成集群配置 安装集群 troubles shooting 安装失败清理 参考 0 环境环境： 主机名 IP k8s-node01 172.16.120.151 k8s-node02 172.16.120.152 k8s-node03
ansible常用命令
09-01
在使用ansible时，有一些常用的命令可以帮助您完成自动化运维任务。其中最常用的命令是ansible和ansible-playbook。 ansible命令是用来管理和配置远程主机的工具，可以通过ssh协议连接到远程主机并执行命令。您可以...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值