ansible.utils.subnet_of test – Test if a network is a subnet of another network
Note
This test 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.subnet_of
.
New in ansible.utils 2.2.0
Synopsis
This plugin checks if the first network is a subnet of the second network amongst the provided network addresses
Keyword parameters
This describes keyword parameters of the test. These are the values key1=value1
, key2=value2
and so on in the following
examples: input is ansible.utils.subnet_of(key1=value1, key2=value2, ...)
and input is not ansible.utils.subnet_of(key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
A string that represents the first network address For example: |
|
A string that represents the second network address For example: |
Examples
- name: Check if 10.1.1.0/24 is a subnet of 10.0.0.0/8
ansible.builtin.set_fact:
data: "{{ '10.1.1.0/24' is ansible.utils.subnet_of '10.0.0.0/8' }}"
# TASK [Check if 10.1.1.0/24 is a subnet of 10.0.0.0/8] **************************
# ok: [localhost] => {
# "ansible_facts": {
# "data": true
# },
# "changed": false
# }
- name: Check if 192.168.1.0/24 is not a subnet of 10.0.0.0/8
ansible.builtin.set_fact:
data: "{{ '192.168.1.0/24' is not ansible.utils.subnet_of '10.0.0.0/8' }}"
# TASK [Check if 192.168.1.0/24 is not a subnet of 10.0.0.0/8] *******************
# ok: [localhost] => {
# "ansible_facts": {
# "data": true
# },
# "changed": false
# }
Return Value
Key |
Description |
---|---|
If jinja test satisfies plugin expression If jinja test does not satisfy plugin expression Returned: success |