community.general.nios_next_ip (3.8.10) — lookup

Install collection

Install with ansible-galaxy collection install community.general:==3.8.10

Add to requirements.yml

  collections:
    - name: community.general
      version: 3.8.10

Description

Uses the Infoblox WAPI API to return the next available IP addresses for a given network CIDR

Requirements

• infoblox-client

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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'}) }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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'}) }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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'}) }}"

Inputs

    
num:
    default: 1
    description: The number of IP addresses to return
    required: false

_terms:
    description: The CIDR network to retrieve the next addresses from
    required: true

exclude:
    description: List of IP's that need to be excluded from returned IP addresses
    required: false

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      host:
        description:
        - Specifies the DNS host name or address for connecting to the remote instance
          of NIOS WAPI over REST
        - Value can also be specified using C(INFOBLOX_HOST) environment variable.
        type: str
      http_pool_connections:
        default: 10
        description:
        - Number of pools to be used by the C(infoblox_client.Connector) object.
        - This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class.
        type: int
      http_pool_maxsize:
        default: 10
        description:
        - Maximum number of connections per pool to be used by the C(infoblox_client.Connector)
          object.
        - This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class.
        type: int
      http_request_timeout:
        default: 10
        description:
        - The amount of time before to wait before receiving a response
        - Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment
          variable.
        type: int
      max_results:
        default: 1000
        description:
        - 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 C(INFOBLOX_MAX_RESULTS) environment variable.
        type: int
      max_retries:
        default: 3
        description:
        - Configures the number of attempted retries before the connection is declared
          usable
        - Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment variable.
        type: int
      password:
        description:
        - Specifies the password to use to authenticate the connection to the remote instance
          of NIOS.
        - Value can also be specified using C(INFOBLOX_PASSWORD) environment variable.
        type: str
      silent_ssl_warnings:
        default: true
        description:
        - Disable C(urllib3) SSL warnings in the C(infoblox_client.Connector) object.
        - This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class.
        type: bool
      username:
        description:
        - Configures the username to use to authenticate the connection to the remote
          instance of NIOS.
        - Value can also be specified using C(INFOBLOX_USERNAME) environment variable.
        type: str
      validate_certs:
        aliases:
        - ssl_verify
        default: false
        description:
        - Boolean value to enable or disable verifying SSL certificates
        - Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment variable.
        type: bool
      wapi_version:
        default: '2.1'
        description:
        - Specifies the version of WAPI to use
        - Value can also be specified using C(INFOBLOX_WAP_VERSION) environment variable.
        - Until ansible 2.8 the default WAPI was 1.4
        type: str
    type: dict

Outputs

_list:
  description:
  - The list of next IP addresses available
  type: list