ansible.utils.cidr_merge filter – This filter can be used to merge subnets or individual addresses.
Note
This filter plugin is part of the ansible.utils collection (version 4.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ansible.utils
.
To use it in a playbook, specify: ansible.utils.cidr_merge
.
New in ansible.utils 2.5.0
Synopsis
This filter can be used to merge subnets or individual addresses into their minimal representation, collapsing
overlapping subnets and merging adjacent ones wherever possible.
Keyword parameters
This describes keyword parameters of the filter. These are the values key1=value1
, key2=value2
and so on in the following
example: input | ansible.utils.cidr_merge(key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
Action to be performed.example merge,span Default: |
|
list of subnets or individual address to be merged |
Examples
#### examples
- name: cidr_merge with merge action
ansible.builtin.set_fact:
value:
- 192.168.0.0/17
- 192.168.128.0/17
- 192.168.128.1
- debug:
msg: '{{ value|ansible.utils.cidr_merge }}'
# TASK [cidr_merge with merge action] **********************************************************************************
# ok: [localhost] => {
# "ansible_facts": {
# "value": [
# "192.168.0.0/17",
# "192.168.128.0/17",
# "192.168.128.1"
# ]
# },
# "changed": false
# }
# TASK [debug] *********************************************************************************************************
# ok: [loalhost] => {
# "msg": [
# "192.168.0.0/16"
# ]
# }
- name: Cidr_merge with span.
ansible.builtin.set_fact:
value:
- 192.168.1.1
- 192.168.1.2
- 192.168.1.3
- 192.168.1.4
- debug:
msg: '{{ value|ansible.utils.cidr_merge(''span'') }}'
# TASK [Cidr_merge with span.] ********************************************************************
# ok: [localhost] => {
# "ansible_facts": {
# "value": [
# "192.168.1.1",
# "192.168.1.2",
# "192.168.1.3",
# "192.168.1.4"
# ]
# },
# "changed": false
# }
#
# TASK [debug] ************************************************************************************
# ok: [localhost] => {
# "msg": "192.168.1.0/29"
# }
Return Value
Key |
Description |
---|---|
Returns a minified list of subnets or a single subnet that spans all of the inputs. Returned: success |