ansible.utils.supernet_of_test.rst

ansible.utils.supernet_of

Test if a network is a supernet of another network

Version added: 2.2.0

• Synopsis
• Parameters
• Examples
• Return Values
• Status

Synopsis

• This plugin checks if the first network is a supernet of the second network amongst the provided network addresses

Parameters

Parameter	Choices/Defaults	Configuration	Comments
network_a string / required			A string that represents the first network address For example: 10.1.1.0/24
network_b string / required			A string that represents the second network address For example: 10.0.0.0/8

Examples

- name: Check if 10.0.0.0/8 is a supernet of 10.1.1.0/24
  ansible.builtin.set_fact:
    data: "{{ '10.0.0.0/8' is ansible.utils.supernet_of '10.1.1.0/24' }}"

# TASK [Check if 10.0.0.0/8 is a supernet of 10.1.1.0/24] ************************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

- name: Check if 10.0.0.0/8 is not a supernet of 192.168.1.0/24
  ansible.builtin.set_fact:
    data: "{{ '10.0.0.0/8' is not ansible.utils.supernet_of '192.168.1.0/24' }}"

# TASK [Check if 10.0.0.0/8 is not a supernet of 192.168.1.0/24] *****************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

Return Values

Common return values are documented here, the following are the fields unique to this test:

Key	Returned	Description
data -		If jinja test satisfies plugin expression true If jinja test does not satisfy plugin expression false

Status

Authors

• Priyam Sahoo (@priyamsahoo)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.