in_one_network¶

Collection Note

This module is part of the ansible.utils collection. To install the collection, use:

ansible-galaxy collection install ansible.utils

Added in version 2.2.0.

Synopsis¶

This plugin checks if the provided IP address belongs to the provided list network addresses

Parameters¶

Parameter	Defaults / Choices	Comments
ip str required		A string that represents an IP address For example: C(10.1.1.1)
networks list required		A list of string and each string represents a network address in CIDR form For example: C(['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_one_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"
      - "10.1.1.0/24"

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

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

Return Values¶

Key	Data Type	Description	Returned
data		If jinja test satisfies plugin expression C(true) If jinja test does not satisfy plugin expression C(false)

Authors¶

Priyam Sahoo (@priyamsahoo)