Skip to content

private

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 value is a private IP address

Parameters

Parameter Defaults / Choices Comments
ip
str
required		 A string that represents the value against which the test is going to be performed
For example: C(10.1.1.1), C(8.8.8.8), or C(192.168.1.250)

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 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)