ansible.utils.reserved_test.rst

ansible.utils.reserved

Test for a reserved IP address

Version added: 2.2.0

• Synopsis
• Parameters
• Examples
• Return Values
• Status

Synopsis

• This plugin checks if the provided value is a reserved IP address

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: 253.0.0.1 or 128.146.1.7

Examples

- name: Check if 253.0.0.1 is a reserved IP address
  ansible.builtin.set_fact:
    data: "{{ '253.0.0.1' is ansible.utils.reserved }}"

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

- name: Check if 128.146.1.7 is not a reserved IP address
  ansible.builtin.set_fact:
    data: "{{ '128.146.1.7' is not ansible.utils.reserved }}"

# TASK [Check if 128.146.1.7 is not a reserved IP 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.