FileMgr

✏️ /lib/python3.9/site-packages/ansible_collections/ansible/utils/plugins/test/reserved.py

✕ Tutup

# -*- coding: utf-8 -*-
# Copyright 2021 Red Hat
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

"""
Test plugin file for netaddr tests: reserved
"""

from __future__ import absolute_import, division, print_function

from ansible_collections.ansible.utils.plugins.plugin_utils.base.ipaddress_utils import (
    _need_ipaddress,
    ip_address,
)
from ansible_collections.ansible.utils.plugins.plugin_utils.base.utils import _validate_args

__metaclass__ = type

DOCUMENTATION = """
    name: reserved
    author: Priyam Sahoo (@priyamsahoo)
    version_added: "2.2.0"
    short_description: Test for a reserved IP address
    description:
        - This plugin checks if the provided value is a reserved IP address
    options:
        ip:
            description:
            - A string that represents the value against which the test is going to be performed
            - 'For example: C(253.0.0.1) or C(128.146.1.7)'
            type: str
            required: True
    notes:
"""

EXAMPLES = r"""

- 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 = """
  data:
    description:
      - If jinja test satisfies plugin expression C(true)
      - If jinja test does not satisfy plugin expression C(false)
"""

@_need_ipaddress
def _reserved(ip):
    """Test for a reserved IP address"""

params = {"ip": ip}
    _validate_args("reserved", DOCUMENTATION, params)

try:
        return ip_address(ip).is_reserved
    except Exception:
        return False

class TestModule(object):
    """network jinja test"""

test_map = {"reserved": _reserved}

def tests(self):
        return self.test_map

Batal

⬅ plugins 26 item

Nama	Tipe	Ukuran	Diubah	Perm	Aksi
📁 __pycache__	dir	—	16/09/24 06:47	0755	📂
🐍 in_any_network.py	py	2.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 in_network.py	py	3.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 in_one_network.py	py	2.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ip.py	py	3.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ip_address.py	py	2.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ipv4.py	py	2.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ipv4_address.py	py	2.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ipv4_hostmask.py	py	2.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ipv4_netmask.py	py	2.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ipv6.py	py	2.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ipv6_address.py	py	2.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ipv6_ipv4_mapped.py	py	2.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ipv6_sixtofour.py	py	2.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 ipv6_teredo.py	py	2.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 loopback.py	py	2.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 mac.py	py	3.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 multicast.py	py	2.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 private.py	py	2.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 public.py	py	2.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 reserved.py	py	2.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 resolvable.py	py	3.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 subnet_of.py	py	2.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 supernet_of.py	py	2.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 unspecified.py	py	2.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 validate.py	py	5.7 KB	08/11/23 12:12	0644	✏️ ⬇

✏️ Rename

🔑 Ubah Permission