1
2
3
4
5
| 作者：李晓辉
微信联系：Lxh_Chat
联系邮箱: 939958092@qq.com
|
深入浅出 Ansible 过滤器
在Ansible里，用过滤器处理变量其实挺方便的！它就像是一个工具箱，帮你把数据整理成想要的样子。比如说，你可以用to_upper让字符串全变成大写，或者用default设置一个备用值，防止变量没定义的时候任务报错。
还有一种常见情况就是对复杂的数据结构下手，比如从JSON里扒拉出你需要的内容，或者把列表里的重复项剔除干净。总之，过滤器能让你的Playbook看起来更清晰，也省得写一堆额外的脚本，直接在模板里搞定数据转换，效率杠杠的！
在 Jinja2 表达式里，想用过滤器的时候，就在变量名或者值后面加一个管道符号 |。比如说：
1
2
| - debug:
msg: "{{ my_variable | to_upper }}"
|
default 过滤器
你可以用 default 过滤器来处理那些没定义的变量，还能给它们设置默认值。
忽略未定义的变量
如果一个变量未定义，直接使用它会导致 playbook 报错。不过通过 default，你可以让 Ansible 安静地处理这些情况：
如果 my_variable 没有被定义，它就会取 '未定义变量的默认值'，这样任务就能顺利继续下去。
1
2
| - debug:
msg: "{{ my_variable | default('未定义变量的默认值') }}"
|
default过滤器还有多种用法：
如果 item['groups'] 没有定义，就会忽略 groups 参数。例如，在以下数据中，未定义 groups 的条目不会报错：
1
2
3
4
| - name: Manage user groups
ansible.builtin.user:
name: "example_user"
groups: "{{ item['groups'] | default(omit) }}"
|
在这个示例中，item['system'] 表示从变量 item 中获取 system 字段的值。如果这个字段未定义，也就是说 item 中没有 system 的数据，Ansible 会通过 default 过滤器赋予它一个默认值 false。
这里的默认值 false 指的是用户的类型设置为普通用户（非系统用户）。在 Linux 系统中，系统用户通常用于运行系统服务，UID 范围较低，而普通用户通常是供实际用户登录和使用系统的账户，UID 范围较高。
1
2
3
4
| - name: Manage system users
ansible.builtin.user:
name: "{{ item['name'] }}"
system: "{{ item['system'] | default(false) }}"
|
如果未定义 item[‘shell’]，它将使用默认的 /bin/bash。例如：
1
2
3
4
| - name: Manage user shell
ansible.builtin.user:
name: "{{ item['name'] }}"
shell: "{{ item['shell'] | default('/bin/bash') }}"
|
通常情况下，default 过滤器只在变量未定义时才生效。但是，有时候你可能遇到变量虽然定义了，但值是空字符串或者布尔值为 false 的情况。如果想让过滤器在这些情况下也生效，只需要在 default 里加一个 true 参数就行，这样就能强制提供一个默认值。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
| - name: Example Playbook with default filter
hosts: localhost
gather_facts: false
vars:
user_data:
- name: "user1"
groups: "admin"
system: true
shell: "/bin/zsh"
- name: "user2"
groups: ""
system: false
shell: ""
- name: "user3"
tasks:
- name: Manage users
ansible.builtin.user:
name: "{{ item['name'] }}"
groups: "{{ item['groups'] | default(omit, true) }}"
system: "{{ item['system'] | default(false, true) }}"
shell: "{{ item['shell'] | default('/bin/bash', true) }}"
loop: "{{ user_data }}"
|
代码解析：
vars 部分：
tasks 部分：
groups 使用了 default(omit, true)，确保即使是空字符串也会被忽略。
system 使用了 default(false, true)，空值或未定义时默认为 false。
shell 使用了 default('/bin/bash', true)，空值或未定义时设置为 /bin/bash。
执行结果：
user1：
- 会被设置为组
admin，是系统用户，Shell 为 /bin/zsh。
user2：
user3：
了解变量类型
在 Ansible 中，变量的值类型非常关键，因为它决定了如何处理数据以及如何使用过滤器操作这些数据。变量的类型通常由 YAML 中的结构或内容定义。以下是一些常见的变量值类型和简要说明：
| 值类型 | 描述 |
|---|
| 字符串 (String) | 表示一段文本，比如 "hello world" 或 '123'，可以通过过滤器操作，如拼接、转换大小写等。 |
| 整数 (Integer) | 纯数字类型，比如 42 或 -10，可以用于算术运算或比较。 |
| 浮点数 (Float) | 包含小数的数字，比如 3.14 或 -0.5，常用于更精确的数学计算。 |
| 布尔值 (Boolean) | 表示逻辑真/假，比如 true 或 false，常用于条件判断。 |
| 列表 (List) | 表示一组有序的值，比如 [1, 2, 3] 或 ['a', 'b', 'c']，可以迭代处理。 |
| 字典 (Dictionary) | 表示键值对的数据结构，比如 {'key': 'value', 'age': 30}，常用于存储结构化数据。 |
| 空值 (Null) | 表示未定义值，通常为 null 或 ~，与 default 过滤器搭配使用时非常有用。 |
| 日期 (Date) | 通常以字符串格式存储日期信息，比如 '2025-03-07' 或带时间戳的 '2025-03-07T15:47:00'。需要用 Jinja2 过滤器（如 strptime 和 strftime |
整数或浮点数
举例来说：
在 Ansible 中，有时候我们需要将变量的值转换为特定的数据类型，比如整数或浮点数，以便进行数学运算或逻辑处理。这时可以使用 int 和 float 过滤器。
假设变量是一个字符串类型的数字，我们想把它转换成整数：
效果：”42” 被转换为整数 42，加上 10 后的结果是 52。
1
2
3
4
5
6
7
8
9
10
| - name: Example Playbook for max, min, and sum filters
hosts: localhost
gather_facts: false
vars:
string_number: "42"
tasks:
- name: Convert to integer
debug:
msg: "{{ string_number | int + 10 }}"
|
对于需要小数的情况，可以用 float 过滤器：
效果：”3.14” 被转换为浮点数 3.14，乘以 2 后的结果是 6.28。
1
2
3
4
5
6
7
8
9
10
| - name: Example Playbook for max, min, and sum filters
hosts: localhost
gather_facts: false
vars:
string_number: "3.14"
tasks:
- name: Convert to float
debug:
msg: "{{ string_number | float * 2 }}"
|
如果变量的值不是一个有效的数字（比如空字符串或 None），可以结合 default 来确保健壮性：
1
2
3
4
5
6
7
8
9
10
| - name: Example Playbook for max, min, and sum filters
hosts: localhost
gather_facts: false
vars:
invalid_number: ""
tasks:
- name: Use default with int
debug:
msg: "{{ invalid_number | int(0) }}"
|
如果列表中有数字，max、min 和 sum 过滤器特别有用，可以分别用来获取最大值、最小值或者总和。以下是具体的示例代码和效果：
max过滤器
1
2
3
4
5
6
7
8
9
10
| - name: Example Playbook for max, min, and sum filters
hosts: localhost
gather_facts: false
vars:
my_numbers: [3, 8, 15, 42, 7]
tasks:
- name: Find maximum number in the list
debug:
msg: "The maximum value is {{ my_numbers | max }}"
|
min过滤器
1
2
3
4
5
6
7
8
9
10
| - name: Example Playbook for max, min, and sum filters
hosts: localhost
gather_facts: false
vars:
my_numbers: [3, 8, 15, 42, 7]
tasks:
- name: Find minimum number in the list
debug:
msg: "The minimum value is {{ my_numbers | min }}"
|
sum过滤器
1
2
3
4
5
6
7
8
9
10
| - name: Example Playbook for max, min, and sum filters
hosts: localhost
gather_facts: false
vars:
my_numbers: [3, 8, 15, 42, 7]
tasks:
- name: Calculate the sum of the list
debug:
msg: "The sum of the values is {{ my_numbers | sum }}"
|
在 Ansible 和 Jinja2 中，你可以轻松地获取列表的相关信息，比如首位元素、末位元素以及列表的长度。
first过滤器
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook to get first elements using filters
hosts: localhost
gather_facts: false
vars:
my_list: [10, 20, 30, 40, 50]
tasks:
- name: Get the first element of the list
debug:
msg: "The first element is {{ my_list | first }}"
|
last过滤器
1
2
3
4
5
6
7
8
9
10
11
12
| - name: Example Playbook to get last elements using filters
hosts: localhost
gather_facts: false
vars:
my_list: [10, 20, 30, 40, 50]
tasks:
- name: Get the last element of the list
debug:
msg: "The last element is {{ my_list | last }}"
|
length过滤器
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook to get the length of a list
hosts: localhost
gather_facts: false
vars:
my_list: [10, 20, 30, 40, 50]
tasks:
- name: Get the length of the list
debug:
msg: "The length of the list is {{ my_list | length }}"
|
random 过滤器
random 过滤器可以从列表中返回一个随机的元素，特别适合处理需要随机选择的场景！
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook to demonstrate random filter
hosts: localhost
gather_facts: false
vars:
my_list: [apple, banana, cherry, mango, orange]
tasks:
- name: Get a random element from the list
debug:
msg: "The randomly selected element is {{ my_list | random }}"
|
sort 过滤器
sort 过滤器能帮你把列表里的元素按自然顺序排好，比如从小到大或者按字母顺序排列。 reverse 过滤器会把列表的顺序直接反过来，头尾交换。 shuffle 过滤器就比较随性了，会把列表里的元素随机打乱，原来的顺序完全不保留。
效果：列表 [50, 10, 30, 20, 40] 会被排序成 [10, 20, 30, 40, 50]。
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook to sort a list
hosts: localhost
gather_facts: false
vars:
my_list: [50, 10, 30, 20, 40]
tasks:
- name: Sort the list in ascending order
debug:
msg: "The sorted list is {{ my_list | sort }}"
|
效果：列表 [50, 10, 30, 20, 40] 会被反转成 [40, 20, 30, 10, 50]。
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook to shuffle a list
hosts: localhost
gather_facts: false
vars:
my_list: [50, 10, 30, 20, 40]
tasks:
- name: Shuffle the list randomly
debug:
msg: "The shuffled list is {{ my_list | shuffle }}"
|
效果：列表 [50, 10, 30, 20, 40] 会被打乱成随机顺序，比如 [30, 50, 10, 40, 20]，每次运行结果可能不同。
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook to shuffle a list
hosts: localhost
gather_facts: false
vars:
my_list: [50, 10, 30, 20, 40]
tasks:
- name: Shuffle the list randomly
debug:
msg: "The shuffled list is {{ my_list | shuffle }}"
|
flatten 过滤器
有时候，把多个列表合并成一个列表会更方便，尤其是在需要迭代处理时。flatten 过滤器就是用来干这个的！它会以递归的方式，取出所有内部列表的值，并将它们添加到外部列表中，让你最终得到一个平铺的单一列表。
比如说，如果你有嵌套的列表：
1
2
3
4
5
6
7
8
9
| - name: Example Playbook to shuffle a list
hosts: localhost
gather_facts: false
vars:
nested_list: [1, [2, 3], [4, [5, 6]]]
tasks:
- name: Flatten the nested list
debug:
msg: "{{ nested_list | flatten }}"
|
使用 flatten 过滤器后的最终输出的结果是：
unique 过滤器
unique 过滤器可以帮你移除列表中的重复元素，让结果中只保留唯一的值。
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook to use unique filter
hosts: localhost
gather_facts: false
vars:
my_list: [1, 2, 2, 3, 4, 4, 4, 5]
tasks:
- name: Remove duplicate elements from the list
debug:
msg: "The unique list is {{ my_list | unique }}"
|
运行上述 Playbook 时，unique 过滤器会移除列表中的重复项。
intersect 过滤器
intersect 过滤器是一个很实用的工具，它可以找出两个列表之间的交集，也就是那些在两个列表中同时存在的元素。
1
2
3
4
5
6
7
8
9
10
11
12
| - name: Example Playbook to demonstrate intersect filter
hosts: localhost
gather_facts: false
vars:
list1: [1, 2, 3, 4, 5]
list2: [3, 4, 5, 6, 7]
tasks:
- name: Find the intersection of two lists
debug:
msg: "The intersection is {{ list1 | intersect(list2) }}"
|
运行该 Playbook 时，两个列表 [1, 2, 3, 4, 5] 和 [3, 4, 5, 6, 7] 的交集是 [3, 4, 5]
difference 过滤器
difference 过滤器在 Ansible 中用于找出两个列表的差集，返回存在于第一个列表但不在第二个列表中的元素。
1
2
3
4
5
6
7
8
9
10
11
12
| - name: Example Playbook to demonstrate difference filter
hosts: localhost
gather_facts: false
vars:
list1: [1, 2, 3, 4, 5]
list2: [3, 4, 5, 6, 7]
tasks:
- name: Find the difference between two lists
debug:
msg: "The difference is {{ list1 | difference(list2) }}"
|
运行该 Playbook 时，list1 是 [1, 2, 3, 4, 5]，list2 是 [3, 4, 5, 6, 7]。两者的差集是 [1, 2]
combine 过滤器
combine 过滤器非常强大，它可以将多个字典合并为一个新的字典，第⼆个字典中条⽬的优先级⾼于第⼀个词典中的条⽬，这在处理动态变量或多组配置时特别有用。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| - name: Example Playbook to demonstrate combine filter
hosts: localhost
gather_facts: false
vars:
dict1:
key1: value1
key2: value2
dict2:
key2: new_value2
key3: value3
tasks:
- name: Combine two dictionaries
debug:
msg: "{{ dict1 | combine(dict2) }}"
|
代码解析
变量部分 (vars)：
任务部分 (tasks)：
dict2items 过滤器
dict2items 过滤器用于将字典转换为键值对的列表，这在需要迭代字典中的键和值时非常有用。
使用 dict2items 将 my_dict 转换为列表格式，其中每个元素是一个带有 key 和 value 的字典。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
| - name: Example Playbook to demonstrate dict2items filter
hosts: localhost
gather_facts: false
vars:
my_dict:
key1: value1
key2: value2
key3: value3
tasks:
- name: Convert dictionary to list of key-value pairs
debug:
msg: "{{ my_dict | dict2items }}"
|
运行该 Playbook 时，my_dict 会被转换为以下列表：
1
2
3
4
5
| [
{"key": "key1", "value": "value1"},
{"key": "key2", "value": "value2"},
{"key": "key3", "value": "value3"}
]
|
items2dict 过滤器
items2dict 过滤器是 dict2items 的逆操作，它将键值对列表转换回一个字典。这在需要从列表重新构建字典时非常有用。
使用 items2dict 过滤器将键值对列表转换回字典格式。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
| - name: Example Playbook to demonstrate items2dict filter
hosts: localhost
gather_facts: false
vars:
key_value_list:
- key: key1
value: value1
- key: key2
value: value2
- key: key3
value: value3
tasks:
- name: Convert key-value pairs list back to dictionary
debug:
msg: "{{ key_value_list | items2dict }}"
|
运行该 Playbook 时，key_value_list 会被转换为字典：
1
2
3
4
5
| {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
|
hash 过滤器
hash 过滤器在 Jinja2 中是一个非常有用的工具，它可以创建基于键值对的字典，这在动态生成数据结构时非常方便。
1
2
3
4
5
6
7
8
9
10
11
| - name: Hash a simple string
hosts: localhost
gather_facts: false
vars:
my_string: "lixiaohui"
tasks:
- name: Hash the string using md5
debug:
msg: "{{ my_string | hash('md5') }}"
|
password_hash 过滤器
password_hash 过滤器用于为密码生成一个安全的哈希值，通常用来存储密码时以加密方式保护敏感数据
1
2
3
4
5
6
7
8
9
10
11
12
13
| - name: Example Playbook to demonstrate password_hash filter
hosts: localhost
gather_facts: false
vars:
my_password: "secure_password"
hash_algorithm: "sha512"
salt: "random_salt"
tasks:
- name: Generate a hashed password
debug:
msg: "{{ my_password | password_hash(hash_algorithm, salt) }}"
|
b64encode 过滤器
b64encode 过滤器可以用来将字符串或二进制数据编码为 Base64 格式，这在需要对数据进行传输或保存时非常有用。
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook to demonstrate b64encode filter
hosts: localhost
gather_facts: false
vars:
my_string: "Hello, world!"
tasks:
- name: Encode the string using b64encode
debug:
msg: "{{ my_string | b64encode }}"
|
b64decode 过滤器
b64decode 过滤器可以将 Base64 编码的字符串解码回原始字符串，这在需要还原数据时非常实用。
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook to demonstrate b64decode filter
hosts: localhost
gather_facts: false
vars:
base64_string: "SGVsbG8sIHdvcmxkIQ=="
tasks:
- name: Decode the Base64 string
debug:
msg: "{{ base64_string | b64decode }}"
|
quote 过滤器
quote 过滤器会将一个字符串转换为一个可被安全引用的格式，通常用于需要插入字符串到命令或配置文件中时，确保其不会因为特殊字符而导致错误。
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook to demonstrate quote filter
hosts: localhost
gather_facts: false
vars:
my_string: "Hello, world!"
tasks:
- name: Quote the string
debug:
msg: "{{ my_string | quote }}"
|
lower 过滤器
将字符串中的所有字母转换为小写。
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook for lower filter
hosts: localhost
gather_facts: false
vars:
my_string: "Hello, World!"
tasks:
- name: Convert string to lowercase
debug:
msg: "{{ my_string | lower }}"
|
upper 过滤器
将字符串中的所有字母转换为大写。
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook for upper filter
hosts: localhost
gather_facts: false
vars:
my_string: "Hello, World!"
tasks:
- name: Convert string to uppercase
debug:
msg: "{{ my_string | upper }}"
|
capitalize 过滤器
将字符串的第一个字母大写，其余字母小写。
1
2
3
4
5
6
7
8
9
10
11
| - name: Example Playbook for capitalize filter
hosts: localhost
gather_facts: false
vars:
my_string: "hello, world!"
tasks:
- name: Capitalize the string
debug:
msg: "{{ my_string | capitalize }}"
|
replace 过滤器
replace 过滤器可以将字符串中的一部分内容替换为另一部分内容。
1
2
3
4
5
6
7
8
9
10
11
12
13
| - name: Example Playbook for replace filter
hosts: localhost
gather_facts: false
vars:
my_string: "Hello, world!"
old_text: "world"
new_text: "Ansible"
tasks:
- name: Replace a substring in the string
debug:
msg: "{{ my_string | replace(old_text, new_text) }}"
|
效果：
原字符串是 "Hello, world!"，replace 过滤器会将 "world" 替换为 "Ansible"
regex_search 过滤器
regex_search 过滤器用于在字符串中根据指定的正则表达式模式搜索第一个匹配的内容。如果找到了匹配项，它会返回匹配的字符串；如果没有找到匹配项，则返回 None。
1
2
3
4
5
6
7
8
9
10
11
12
| - name: Example Playbook for regex_search filter
hosts: localhost
gather_facts: false
vars:
my_string: "User: admin, ID: 12345"
pattern: "ID: ([0-9]+)"
tasks:
- name: Extract ID from the string
debug:
msg: "{{ my_string | regex_search(pattern) }}"
|
regex_replace 过滤器
regex_replace 过滤器用于在字符串中查找匹配的模式并替换为指定的内容。
1
2
3
4
5
6
7
8
9
10
11
12
13
| - name: Example Playbook for regex_replace filter
hosts: localhost
gather_facts: false
vars:
my_string: "User: admin, ID: 12345"
pattern: "admin"
replacement: "root"
tasks:
- name: Replace username in the string
debug:
msg: "{{ my_string | regex_replace(pattern, replacement) }}"
|
selectattr 和 map 过滤器
selectattr 和 map 过滤器是 Ansible 和 Jinja2 中强大的工具，用于操作和处理复杂的数据结构，如列表或字典。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| - name: Playbook to demonstrate selectattr and map filters
hosts: localhost
gather_facts: false
vars:
servers:
- name: server1
status: active
region: us-east
- name: server2
status: inactive
region: us-west
- name: server3
status: active
region: eu-central
- name: server4
status: inactive
region: ap-south
- name: server5
status: active
region: us-east
tasks:
- name: Filter servers with status equal to 'active'
debug:
msg: "{{ servers | selectattr('status', 'equalto', 'active') | list }}"
- name: Extract names of active servers
debug:
msg: "{{ servers | selectattr('status', 'equalto', 'active') | map(attribute='name') | list }}"
- name: Filter and extract regions of active servers in 'us-east'
debug:
msg: "{{ servers | selectattr('status', 'equalto', 'active') | selectattr('region', 'equalto', 'us-east') | map(attribute='region') | list }}"
|
代码解析
变量定义 (vars)：
- 列表
servers 包含多个字典，每个字典代表一台服务器的信息，包括名称 (name)、状态 (status) 和区域 (region)。
任务解析 (tasks)：
任务 1：筛选 status 为 'active' 的服务器，返回完整的服务器字典。
任务 2：在任务 1 的基础上，提取筛选结果中服务器的 name 属性，生成一个仅包含名称的列表。
任务 3：进一步筛选出位于 'us-east' 区域的活跃服务器，并提取其 region。
to_json 过滤器
将数据（如字典或列表）转换为 JSON 格式的字符串。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| - name: Example Playbook for to_json filter
hosts: localhost
gather_facts: false
vars:
my_data:
key1: value1
key2: value2
key3:
- item1
- item2
tasks:
- name: Convert data to JSON
debug:
msg: "{{ my_data | to_json }}"
|
to_yaml 过滤器
将数据（如字典或列表）转换为 YAML 格式的字符串。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| - name: Example Playbook for to_yaml filter
hosts: localhost
gather_facts: false
vars:
my_data:
key1: value1
key2: value2
key3:
- item1
- item2
tasks:
- name: Convert data to YAML
debug:
msg: "{{ my_data | to_yaml }}"
|
to_nice_json 过滤器
将数据转换为带有良好格式（包括缩进和换行）的 JSON 字符串。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| - name: Example Playbook for to_nice_json filter
hosts: localhost
gather_facts: false
vars:
my_data:
key1: value1
key2: value2
key3:
- item1
- item2
tasks:
- name: Convert data to nicely formatted JSON
debug:
msg: "{{ my_data | to_nice_json }}"
|
to_nice_yaml 过滤器
将数据转换为带有良好格式（包括缩进和层级结构）的 YAML 字符串。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| - name: Example Playbook for to_nice_yaml filter
hosts: localhost
gather_facts: false
vars:
my_data:
key1: value1
key2: value2
key3:
- item1
- item2
tasks:
- name: Convert data to nicely formatted YAML
debug:
msg: "{{ my_data | to_nice_yaml }}"
|
微信
