ansible.utils.loopback (4.0.0) — test

Test if an IP address is a loopback

| "added in version" 2.2.0 of ansible.utils"

Authors: Priyam Sahoo (@priyamsahoo)

Install collection

Install with ansible-galaxy collection install ansible.utils:==4.0.0


Add to requirements.yml

  collections:
    - name: ansible.utils
      version: 4.0.0

Description

This plugin checks if the provided value is a valid loopback IP address

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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 }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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 }}"

Inputs

    
ip:
    description:
    - 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)'
    required: true
    type: str

Outputs

data:
  description:
  - If jinja test satisfies plugin expression C(true)
  - If jinja test does not satisfy plugin expression C(false)