ansible.utils.in_one_network test – Test if IP address belongs in any one of the networks in the list
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.in_one_network
.
New in ansible.utils 2.2.0
Synopsis
This plugin checks if the provided IP 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_one_network(key1=value1, key2=value2, ...)
and input is not ansible.utils.in_one_network(key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
A string that represents an IP address For example: |
|
A list of string and each string represents a network address in CIDR form For example: |
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 Value
Key |
Description |
---|---|
If jinja test satisfies plugin expression If jinja test does not satisfy plugin expression Returned: success |