ansible.utils.in_any_network test – Test if an IP or network falls in any network

Note

This test plugin is part of the ansible.utils collection (version 5.1.2).

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.in_any_network.

New in ansible.utils 2.2.0

Synopsis
Keyword parameters
Examples
Return Value

Synopsis

This plugin checks if the provided IP or network address belongs to the provided list 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.in_any_network(key1=value1, key2=value2, ...) and input is not ansible.utils.in_any_network(key1=value1, key2=value2, ...)

Parameter	Comments
ip string / required	A string that represents an IP address of a host or network For example: `10.1.1.1`
networks list / elements=string / required	A list of string and each string represents a network address in CIDR form For example: `['10.0.0.0/8', '192.168.1.0/24']`

Examples

#### Simple examples

- name: Set network list
  ansible.builtin.set_fact:
    networks:
      - "10.0.0.0/8"
      - "192.168.1.0/24"

- name: Check if 10.1.1.1 is in the provided network list
  ansible.builtin.set_fact:
    data: "{{ '10.1.1.1' is ansible.utils.in_any_network networks }}"

# TASK [Check if 10.1.1.1 is in the provided network list] **************************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

- name: Set network list
  ansible.builtin.set_fact:
    networks:
      - "10.0.0.0/8"
      - "192.168.1.0/24"
      - "172.16.0.0/16"

- name: Check if 8.8.8.8 is not in the provided network list
  ansible.builtin.set_fact:
    data: "{{ '8.8.8.8' is not ansible.utils.in_any_network networks }}"

# TASK [Check if 8.8.8.8 is not in the provided network list] ************************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

Return Value

Key	Description
data string	If jinja test satisfies plugin expression `true` If jinja test does not satisfy plugin expression `false` Returned: success

Authors

Priyam Sahoo (@priyamsahoo)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/utils/in_any_network_test.html