ansible.utils.ip_address test – Test if something in an IP address

Note

This test plugin is part of the ansible.utils collection (version 4.1.0).

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.ip_address.

New in ansible.utils 2.2.0

Synopsis

  • This plugin checks if the provided value is a valid host 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.ip_address(key1=value1, key2=value2, ...) and input is not ansible.utils.ip_address(key1=value1, key2=value2, ...)

Parameter

Comments

ip

string / required

A string that represents the value against which the test is going to be performed

For example: 10.1.1.1 or "hello-world"

Examples

#### Simple examples

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

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

- name: Check if "hello-world" is not a valid IP address
  ansible.builtin.set_fact:
    data: "{{ 'hello-world' is not ansible.utils.ip_address }}"

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

- name: Check if 10.0.0.0/8 is a valid IP address
  ansible.builtin.set_fact:
    data: "{{ '10.0.0.0/8' is ansible.utils.ip_address }}"

# TASK [Check if 10.0.0.0/8 is a valid IP address] ***********************************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": false
#     },
#     "changed": false
# }

Return Value

Key

Description

data

string

If jinja test satisfies plugin expression true

If jinja test does not satisfy plugin expression false

Returned: success

Authors

  • Priyam Sahoo (@priyamsahoo)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/utils/ip_address_test.html