ansible.utils.ipv4_address_test.rst

ansible.utils.ipv4_address

Test if something is an IPv4 address

Version added: 2.2.0

• Synopsis
• Parameters
• Examples
• Return Values
• Status

Synopsis

• This plugin checks if the provided value is a valid host IP address with IPv4 addressing scheme

Parameters

Parameter	Choices/Defaults	Configuration	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, 10.0.0.0/8, or fe80::216:3eff:fee4:16f3

Examples

#### Simple examples

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

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

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

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

- name: Check if fe80::216:3eff:fee4:16f3 is not a valid IPv4 address
  ansible.builtin.set_fact:
    data: "{{ 'fe80::216:3eff:fee4:16f3' is not ansible.utils.ipv4_address }}"

# TASK [Check if fe80::216:3eff:fee4:16f3 is not a valid IPv4 address] *********
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

Return Values

Common return values are documented here, the following are the fields unique to this test:

Key	Returned	Description
data -		If jinja test satisfies plugin expression true If jinja test does not satisfy plugin expression false

Status

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.