.. _ansible.utils.ip_test:


****************
ansible.utils.ip
****************

**Test if something in an IP address or network**


Version added: 2.2.0

.. contents::
   :local:
   :depth: 1


Synopsis
--------
- This plugin checks if the provided value is a valid host or network IP address




Parameters
----------

.. raw:: html

    <table  border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="1">Parameter</th>
            <th>Choices/<font color="blue">Defaults</font></th>
                <th>Configuration</th>
            <th width="100%">Comments</th>
        </tr>
            <tr>
                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-"></div>
                    <b>ip</b>
                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                         / <span style="color: red">required</span>
                    </div>
                </td>
                <td>
                </td>
                    <td>
                    </td>
                <td>
                        <div>A string that represents the value against which the test is going to be performed</div>
                        <div>For example: <code>10.1.1.1</code>, <code>2001:db8:a::123</code>, or <code>&quot;hello-world&quot;</code></div>
                </td>
            </tr>
    </table>
    <br/>




Examples
--------

.. code-block:: yaml

    #### 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 }}"

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

    - name: Check if 2001:db8:a::123 is a valid IP address
      ansible.builtin.set_fact:
        data: "{{ '2001:db8:a::123' is ansible.utils.ip }}"

    # TASK [Check if 2001:db8:a::123 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 }}"

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

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

    # TASK [Check if 300.1.1.1 is a valid IP address] ****************************
    # ok: [localhost] => {
    #     "ansible_facts": {
    #         "data": false
    #     },
    #     "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 }}"

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



Return Values
-------------
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this test:

.. raw:: html

    <table border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="1">Key</th>
            <th>Returned</th>
            <th width="100%">Description</th>
        </tr>
            <tr>
                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-"></div>
                    <b>data</b>
                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">-</span>
                    </div>
                </td>
                <td></td>
                <td>
                            <div>If jinja test satisfies plugin expression <code>true</code></div>
                            <div>If jinja test does not satisfy plugin expression <code>false</code></div>
                    <br/>
                </td>
            </tr>
    </table>
    <br/><br/>


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.
