community.general.nios_next_ip – Return the next available IP address for a network
community.general.nios_next_ip – Return the next available IP address for a network
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.nios_next_ip
.
Synopsis
- Uses the Infoblox WAPI API to return the next available IP addresses for a given network CIDR
Requirements
The below requirements are needed on the local controller node that executes this lookup.
- infoblox-client
Parameters
Parameter | Choices/Defaults | Configuration | Comments | |
---|---|---|---|---|
_terms string / required |
The CIDR network to retrieve the next addresses from | |||
exclude string |
List of IP's that need to be excluded from returned IP addresses | |||
num string |
Default: 1 |
The number of IP addresses to return | ||
provider dictionary |
A dict object containing connection details. | |||
host string |
Specifies the DNS host name or address for connecting to the remote instance of NIOS WAPI over REST Value can also be specified using | |||
http_request_timeout integer |
Default: 10 |
The amount of time before to wait before receiving a response Value can also be specified using | ||
max_results integer |
Default: 1000 |
Specifies the maximum number of objects to be returned, if set to a negative number the appliance will return an error when the number of returned objects would exceed the setting. Value can also be specified using | ||
max_retries integer |
Default: 3 |
Configures the number of attempted retries before the connection is declared usable Value can also be specified using | ||
password string |
Specifies the password to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using | |||
username string |
Configures the username to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using | |||
validate_certs boolean |
|
Boolean value to enable or disable verifying SSL certificates Value can also be specified using
| ||
wapi_version string |
Default: "2.1" |
Specifies the version of WAPI to use Value can also be specified using Until ansible 2.8 the default WAPI was 1.4 |
Notes
Note
- This module must be run locally, which can be achieved by specifying
connection: local
. - Please read the Infoblox Guide for more detailed information on how to use Infoblox with Ansible.
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 Values
Common return values are documented here, the following are the fields unique to this lookup:
Key | Returned | Description |
---|---|---|
_list list / elements=string |
success |
The list of next IP addresses available
|
Authors
- Unknown (!UNKNOWN)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/nios_next_ip_lookup.html