ansible.utils.private test – Test if an IP address is private
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.private
.
New in ansible.utils 2.2.0
Synopsis
This plugin checks if the provided value is a private IP address
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.private(key1=value1, key2=value2, ...)
and input is not ansible.utils.private(key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
A string that represents the value against which the test is going to be performed For example: |
Examples
- name: Check if 10.1.1.1 is a private IP address
ansible.builtin.set_fact:
data: "{{ '10.1.1.1' is ansible.utils.private }}"
# TASK [Check if 10.1.1.1 is a private IP address] *******************************
# ok: [localhost] => {
# "ansible_facts": {
# "data": true
# },
# "changed": false
# }
- name: Check if 8.8.8.8 is not a private IP address
ansible.builtin.set_fact:
data: "{{ '8.8.8.8' is not ansible.utils.private }}"
# TASK [Check if 8.8.8.8 is not a private IP address] ******************************
# 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 |