ansible.utils.in_any_network_test.rst

ansible.utils.in_any_network

Test if an IP or network falls in any network

Version added: 2.2.0

• Synopsis
• Parameters
• Examples
• Return Values
• Status

Synopsis

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

Parameters

Parameter	Choices/Defaults	Configuration	Comments
ip string / required			A string that represents an IP address of a host or network For example: 10.1.1.1
networks list / 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 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.