ansible.utils.in_network test – Test if IP address falls in the 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_network
.
New in ansible.utils 2.2.0
Synopsis
This plugin checks if the provided IP address belongs to the provided network
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_network(key1=value1, key2=value2, ...)
and input is not ansible.utils.in_network(key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
A string that represents an IP address For example: |
|
A string that represents the network address in CIDR form For example: |
Examples
#### Simple examples
- name: Check if 10.1.1.1 is in 10.0.0.0/8
ansible.builtin.set_fact:
data: "{{ '10.1.1.1' is ansible.utils.in_network '10.0.0.0/8' }}"
# TASK [Check if 10.1.1.1 is in 10.0.0.0/8] ***********************************
# ok: [localhost] => {
# "ansible_facts": {
# "data": true
# },
# "changed": false
# }
- name: Check if 10.1.1.1 is not in 192.168.1.0/24
ansible.builtin.set_fact:
data: "{{ '10.1.1.1' is not ansible.utils.in_network '192.168.1.0/24' }}"
# TASK [Check if 10.1.1.1 is not in 192.168.1.0/24] ****************************
# ok: [localhost] => {
# "ansible_facts": {
# "data": true
# },
# "changed": false
# }
- name: Check if 2001:db8:a::123 is in 2001:db8:a::/64
ansible.builtin.set_fact:
data: "{{ '2001:db8:a::123' is ansible.utils.in_network '2001:db8:a::/64' }}"
# TASK [Check if 2001:db8:a::123 is in 2001:db8:a::/64] ****************************
# task path: /home/prsahoo/playbooks/collections/localhost_test/utils_in_network.yml:16
# ok: [localhost] => {
# "ansible_facts": {
# "data": true
# },
# "changed": false
# }
- name: Check if 2001:db8:a::123 is not in 10.0.0.0/8
ansible.builtin.set_fact:
data: "{{ '2001:db8:a::123' is not ansible.utils.in_network '10.0.0.0/8' }}"
# TASK [Check if 2001:db8:a::123 is not in 10.0.0.0/8] *********************************
# task path: /home/prsahoo/playbooks/collections/localhost_test/utils_in_network.yml:20
# 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 |