You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

infoblox.nios_modules.nios_range module – Configure Infoblox NIOS network range object

Note

This module is part of the infoblox.nios_modules collection (version 1.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install infoblox.nios\_modules. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: infoblox.nios_modules.nios_range.

New in infoblox.nios_modules 1.4.0

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis 

Adds and/or removes instances of range objects from Infoblox NIOS servers. This module manages NIOS DHCP range objects using the Infoblox WAPI interface over REST.
Supports both IPV4 and IPV6 internet protocols.

Requirements 

The below requirements are needed on the host that executes this module.

infoblox-client

Parameters 

Parameter	Comments
comment string	Configures a text string comment to be associated with the instance of this object. The provided text string will be configured on the object instance.
disable boolean	Determines whether a range is disabled or not. When this is set to False, the range is enabled. Choices: `false` ← (default) `true`
end_addr aliases: end, last_addr, last string / required	Configures IP address this object instance is to end at. If ‘new_end_addr’ is defined during a create operation this value is overridden with the value of ‘new_end_addr’
extattrs dictionary	Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration.
failover_association string	The name of the DHCP failover association which will be configured to server this object instance. A failover of MS or Nios members can be configured. Can not be configured when ‘ms_server’ or ‘member’ are configured.
member string	The hostname of the Nios member which will be configured to server this object instance. Can not be configured when ‘ms_server’ or ‘failover_association’ are configured.
ms_server string	The hostname of the MS member which will be configured to server this object instance. Can not be configured when ‘member’ or ‘failover_association’ are configured.
name string	Congifured the name of the Microsoft scope for the instance of the object on the NIOS server.
network aliases: cidr string / required	Specifies the network to add or remove DHCP range to. The value should use CIDR notation.
network_view string	Configures the name of the network view to associate with this configured instance. Default: `"default"`
new_end_addr aliases: new_end, new_last_addr, new_last string	Configures IP address to update this object instance to end at.
new_start_addr aliases: new_start, new_first_addr, new_first string	Configures IP address to update this object instance to begin from.
options list / elements=dictionary	Configures the set of DHCP options to be included as part of the configured network instance. This argument accepts a list of values (see suboptions). When configuring suboptions at least one of `name` or `num` must be specified.
name string	The name of the DHCP option to configure. The standard options are `router`, `router-templates`, `domain-name-servers`, `domain-name`, `broadcast-address`, `broadcast-address-offset`, `dhcp-lease-time`, and `dhcp6.name-servers`.
num integer	The number of the DHCP option to configure
use_option boolean	Only applies to a subset of options (see NIOS API documentation) Choices: `false` `true` ← (default)
value string / required	The value of the DHCP option specified by `name`
vendor_class string	The name of the space this DHCP option is associated to Default: `"DHCP"`
provider dictionary	A dict object containing connection details.
cert string	Specifies the client certificate file with digest of x509 config for extra layer secure connection the remote instance of NIOS. Value can also be specified using `INFOBLOX_CERT` environment variable.
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 `INFOBLOX_HOST` environment variable.
http_pool_connections integer	Insert decription here Default: `10`
http_pool_maxsize integer	Insert description here Default: `10`
http_request_timeout integer	The amount of time before to wait before receiving a response Value can also be specified using `INFOBLOX_HTTP_REQUEST_TIMEOUT` environment variable. Default: `10`
key string	Specifies private key file for encryption with the certificate in order to connect with remote instance of NIOS. Value can also be specified using `INFOBLOX_KEY` environment variable.
max_results integer	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. Default: `1000`
max_retries integer	Configures the number of attempted retries before the connection is declared usable Value can also be specified using `INFOBLOX_MAX_RETRIES` environment variable. Default: `3`
password string	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.
silent_ssl_warnings boolean	Insert description here Choices: `false` `true` ← (default)
username string	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.
validate_certs aliases: ssl_verify boolean	Boolean value to enable or disable verifying SSL certificates Value can also be specified using `INFOBLOX_SSL_VERIFY` environment variable. Choices: `false` ← (default) `true`
wapi_version string	Specifies the version of WAPI to use Value can also be specified using `INFOBLOX_WAP_VERSION` environment variable. Until ansible 2.8 the default WAPI was 1.4 Default: `"2.9"`
server_association_type string	Configured the type of server association that will be assigned to serve this object instance. This value is not required and will be set as needed automatically during module execution. Choices: `"NONE"` `"FAILOVER"` `"MEMBER"` `"FAILOVER_MS"` `"MS_SERVER"`
start_addr aliases: start, first_addr, first string / required	Configures IP address this object instance is to begin from. If ‘new_start_addr’ is defined during a create operation this value is overridden with the value of ‘new_start_addr’
state string	Configures the intended state of the instance of the object on the NIOS server. When this value is set to `present`, the object is configured on the device and when this value is set to `absent` the value is removed (if necessary) from the device. Choices: `"present"` ← (default) `"absent"`

Notes 

Note

This module supports check_mode.
This module must be run locally, which can be achieved by specifying connection: local.
Please read the :ref:`nios_guide` for more detailed information on how to use Infoblox with Ansible.

Examples 

- name: Configure a ipv4 reserved range
  infoblox.nios_modules.nios_range:
    network: 192.168.10.0/24
    start: 192.168.10.10
    end: 192.168.10.20
    name: Test Range 1
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Upadtes a ipv4 reserved range
  infoblox.nios_modules.nios_range:
    network: 192.168.10.0/24
    start: 192.168.10.10
    new_start: 192.168.10.5
    end: 192.168.10.20
    new_end: 192.168.10.50
    name: Test Range 1
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Configure a ipv4 range served by a member
  infoblox.nios_modules.nios_range:
    network: 192.168.10.0/24
    start: 192.168.10.10
    end: 192.168.10.20
    name: Test Range 1
    member: infoblox1.localdomain
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Configure a ipv4 range served by a failover association
  infoblox.nios_modules.nios_range:
    network: 192.168.10.0/24
    start: 192.168.10.10
    end: 192.168.10.20
    name: Test Range 1
    failover_association: fo_association_01
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Configure a ipv4 range with options
  infoblox.nios_modules.nios_range:
    network: 18.10.0.0/24
    network_view: custom
    start_addr: 18.10.0.12
    end_addr: 18.10.0.14
    options:
     - name: domain-name
       value: zone1.com
    comment: Created with Ansible
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Configure a ipv4 range served by a MS Server
  infoblox.nios_modules.nios_range:
    network: 192.168.10.0/24
    start: 192.168.10.10
    end: 192.168.10.20
    name: Test Range 1
    ms_server: dc01.ad.localdomain
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Authors

Matthew Dennett (@matthewdennett)

Collection links

Issue Tracker Homepage Repository (Sources)

infoblox.nios_modules.nios_range module – Configure Infoblox NIOS network range object

Synopsis

Requirements

Parameters

Notes

Examples