/ home / ansible / ansible.utils / 4.0.0 / test / ipv6_address

ansible.utils.ipv6_address (4.0.0) — test

Test if something is an IPv6 address

| "added in version" 2.2.0 of ansible.utils"

Authors: Priyam Sahoo (@priyamsahoo)

Install collection

Install with ansible-galaxy collection install ansible.utils:==4.0.0

Add to requirements.yml

  collections:
    - name: ansible.utils
      version: 4.0.0

Description

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

Usage examples

Scanned by Steampunk Spotter


#### Simple examples

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

Scanned by Steampunk Spotter

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

- name: Check if 2001:db8:a::123/64 is not a valid IPv6 address
  ansible.builtin.set_fact:
    data: "{{ '2001:db8:a::123/64' is not ansible.utils.ipv6_address }}"

Scanned by Steampunk Spotter

# TASK [Check if 2001:db8:a::123/64 is not a valid IPv6 address] ***********************
# ok: [localhost] => {
#     "ansible_facts": {
#         "data": true
#     },
#     "changed": false
# }

- name: Check if 192.169.1.250 is not a valid IPv6 address
  ansible.builtin.set_fact:
    data: "{{ '192.169.1.250' is not ansible.utils.ipv6_address }}"

Inputs

    
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(10.0.0.0/8), or C(fe80::216:3eff:fee4:16f3)'
    required: true
    type: str

Outputs

data:
  description:
  - If jinja test satisfies plugin expression C(true)
  - If jinja test does not satisfy plugin expression C(false)