nios_next_network – Return the next available network range for a network-container

From Get docs
< Lookup PluginsAnsible/docs/2.7/plugins/lookup/nios next network


nios_next_network – Return the next available network range for a network-container

New in version 2.7.


Synopsis

  • Uses the Infoblox WAPI API to return the next available network 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 Configuration Comments

_terms

- / required

The CIDR network to retrieve the next network from next available network within the specified container.

cidr

- / required

Default:

24

The CIDR of the network to retrieve the next network from next available network within the specified container. Also, Requested CIDR must be specified and greater than the parent CIDR.

exclude

-

Default:

""

Network addresses returned from network-container excluding list of user's input network range

num

-

Default:

1

The number of network addresses to return from network-container

provider

-

A dict object containing connection details.

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.

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_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.

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.

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.

ssl_verify

boolean

  • no

  • yes

Boolean value to enable or disable verifying SSL certificates

Value can also be specified using INFOBLOX_SSL_VERIFY environment variable.

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.

wapi_version

-

Default:

1.4

Specifies the version of WAPI to use

Value can also be specified using INFOBLOX_WAP_VERSION environment variable.



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 network for network-container 192.168.10.0/24
  set_fact:
    networkaddr: "{{ lookup('nios_next_network', '192.168.10.0/24', cidr=25, provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"

- name: return the next 2 available network addresses for network-container 192.168.10.0/24
  set_fact:
    networkaddr: "{{ lookup('nios_next_network', '192.168.10.0/24', cidr=25, num=2,
                        provider={'host': 'nios01', 'username': 'admin', 'password': 'password'}) }}"

- name: return the available network addresses for network-container 192.168.10.0/24 excluding network range '192.168.10.0/25'
  set_fact:
    networkaddr: "{{ lookup('nios_next_network', '192.168.10.0/24', cidr=25, exclude=['192.168.10.0/25'],
                        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 network addresses available





Status

Authors

  • UNKNOWN

Hint

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


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/plugins/lookup/nios_next_network.html