nios_next_ip - Return the next available IP address for a network¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

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 master node that executes this lookup.

infoblox_client

Parameters ¶

Parameter	Choices/Defaults	Comments
_terms required		The CIDR network to retrieve the next addresses from
num	Default: yes	The number of IP addresses to return
provider		A dict object containing connection details.
username		Configures the username to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using `INFOBLOX_USERNAME` environment variable.
http_request_timeout	Default: 10	The amount of time before to wait before receiving a response Value can also be specified using `INFOBLOX_HTTP_REQUEST_TIMEOUT` environment variable.
max_retries	Default: 3	Configures the number of attempted retries before the connection is declared usable Value can also be specified using `INFOBLOX_MAX_RETRIES` environment variable.
wapi_version	Default: 1.4	Specifies the version of WAPI to use Value can also be specified using `INFOBLOX_WAP_VERSION` environment variable.
ssl_verify	Choices: no ← yes	Boolean value to enable or disable verifying SSL certificates Value can also be specified using `INFOBLOX_SSL_VERIFY` environment variable.
max_results	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 `INFOBLOX_MAX_RESULTS` environment variable.
host required		Specifies the DNS host name or address for connecting to the remote instance of NIOS WAPI over REST Value can also be specified using `INFOBLOX_HOST` environment variable.
password		Specifies the password to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using `INFOBLOX_PASSWORD` environment variable.

Notes ¶

Note

This module must be run locally, which can be achieved by specifying connection: local.

Examples ¶

- name: return next available IP address for network 192.168.10.0/24
  set_fact:
    ipaddr: "{{ lookup('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
  set_fact:
    ipaddr: "{{ lookup('nios_next_ip', '192.168.10.0/24', num=3, 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	always	The list of next IP addresses available

Status ¶

Author ¶

UNKNOWN

Hint

If you notice any issues in this documentation you can edit this document to improve it.