mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
066975e5d1
* added the utf-8 marker
* fixed the utf-8 marker where it was missde before
(cherry picked from commit 771e9de010)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
105 lines
3.7 KiB
Python
105 lines
3.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright 2018 Red Hat | Ansible
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
author: Unknown (!UNKNOWN)
|
|
name: nios_next_ip
|
|
short_description: Return the next available IP address for a network
|
|
deprecated:
|
|
why: Please install the infoblox.nios_modules collection and use the corresponding lookup from it.
|
|
alternative: infoblox.nios_modules.nios_next_ip
|
|
removed_in: 5.0.0
|
|
description:
|
|
- Uses the Infoblox WAPI API to return the next available IP addresses
|
|
for a given network CIDR
|
|
requirements:
|
|
- infoblox-client
|
|
extends_documentation_fragment:
|
|
- community.general.nios
|
|
|
|
options:
|
|
_terms:
|
|
description: The CIDR network to retrieve the next addresses from
|
|
required: True
|
|
num:
|
|
description: The number of IP addresses to return
|
|
required: false
|
|
default: 1
|
|
exclude:
|
|
description: List of IP's that need to be excluded from returned IP addresses
|
|
required: false
|
|
'''
|
|
|
|
EXAMPLES = """
|
|
- name: return next available IP address for network 192.168.10.0/24
|
|
ansible.builtin.set_fact:
|
|
ipaddr: "{{ lookup('community.general.nios_next_ip', '192.168.10.0/24', provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
|
|
|
|
- name: return the next 3 available IP addresses for network 192.168.10.0/24
|
|
ansible.builtin.set_fact:
|
|
ipaddr: "{{ lookup('community.general.nios_next_ip', '192.168.10.0/24', num=3, provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
|
|
|
|
- name: return the next 3 available IP addresses for network 192.168.10.0/24 excluding ip addresses - ['192.168.10.1', '192.168.10.2']
|
|
ansible.builtin.set_fact:
|
|
ipaddr: "{{ lookup('community.general.nios_next_ip', '192.168.10.0/24', num=3, exclude=['192.168.10.1', '192.168.10.2'],
|
|
provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"
|
|
"""
|
|
|
|
RETURN = """
|
|
_list:
|
|
description:
|
|
- The list of next IP addresses available
|
|
type: list
|
|
"""
|
|
|
|
from ansible.plugins.lookup import LookupBase
|
|
from ansible_collections.community.general.plugins.module_utils.net_tools.nios.api import WapiLookup
|
|
from ansible.module_utils.common.text.converters import to_text
|
|
from ansible.errors import AnsibleError
|
|
|
|
|
|
class LookupModule(LookupBase):
|
|
|
|
def run(self, terms, variables=None, **kwargs):
|
|
try:
|
|
network = terms[0]
|
|
except IndexError:
|
|
raise AnsibleError('missing argument in the form of A.B.C.D/E')
|
|
|
|
provider = kwargs.pop('provider', {})
|
|
wapi = WapiLookup(provider)
|
|
|
|
network_obj = wapi.get_object('network', {'network': network})
|
|
if network_obj is None:
|
|
raise AnsibleError('unable to find network object %s' % network)
|
|
|
|
num = kwargs.get('num', 1)
|
|
exclude_ip = kwargs.get('exclude', [])
|
|
|
|
try:
|
|
ref = network_obj[0]['_ref']
|
|
avail_ips = wapi.call_func('next_available_ip', ref, {'num': num, 'exclude': exclude_ip})
|
|
return [avail_ips['ips']]
|
|
except Exception as exc:
|
|
raise AnsibleError(to_text(exc))
|