
    Vh                     n    d Z ddlmZmZmZ ddlmZmZ ddlm	Z	 e
ZdZdZdZed        Z G d	 d
e      Zy)z(
Test plugin file for netaddr tests: ip
    )absolute_importdivisionprint_function)_need_ipaddress
ip_network)_validate_argsa!  
    name: ip
    author: Priyam Sahoo (@priyamsahoo)
    version_added: "2.2.0"
    short_description: Test if something in an IP address or network
    description:
        - This plugin checks if the provided value is a valid host or network IP address
    options:
        ip:
            description:
            - A string that represents the value against which the test is going to be performed
            - 'For example: C(10.1.1.1), C(2001:db8:a::123), or C("hello-world")'
            type: str
            required: True
    notes:
aY  

#### 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
# }
z
  data:
    description:
      - If jinja test satisfies plugin expression C(true)
      - If jinja test does not satisfy plugin expression C(false)
c                 d    d| i}t        dt        |       	 t        |        y# t        $ r Y yw xY w)z-Test if something in an IP address or networkipTF)r   DOCUMENTATIONr   	Exception)r
   paramss     a/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/ansible/utils/plugins/test/ip.py_ipr   o   s:     BZF4/2 s   # 	//c                       e Zd ZdZdeiZd Zy)
TestModuleznetwork jinja testr
   c                     | j                   S )N)test_map)selfs    r   testszTestModule.tests   s    }}    N)__name__
__module____qualname____doc__r   r   r    r   r   r   r   }   s    c{Hr   r   N)r   
__future__r   r   r   Kansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utilsr   r   Aansible_collections.ansible.utils.plugins.plugin_utils.base.utilsr   type__metaclass__r   EXAMPLESRETURNr   objectr   r   r   r   <module>r$      s[    A @ ] "?B
 
 
 r   