Skip to content

loopback

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 valid loopback 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(127.0.0.1) or C(2002::c0a8:6301:1)

Examples

- name: Check if 127.10.10.10 is a valid loopback address
  ansible.builtin.set_fact:
    data: "{{ '127.10.10.10' is ansible.utils.loopback }}"

# TASK [Check if 127.10.10.10 is a valid loopback address] *************************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

- name: Check if 10.1.1.1 is not a valid loopback address
  ansible.builtin.set_fact:
    data: "{{ '10.1.1.1' is not ansible.utils.loopback }}"

# TASK [Check if 10.1.1.1 is not a valid loopback address] *************************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

- name: Check if ::1 is a valid loopback address
  ansible.builtin.set_fact:
    data: "{{ '::1' is ansible.utils.loopback }}"

# TASK [Check if ::1 is a valid loopback 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)