nios_network - Configure Infoblox NIOS network object¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Status
Maintenance
- Support
- Author

Synopsis ¶

Adds and/or removes instances of network objects from Infoblox NIOS servers. This module manages NIOS network 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		Choices/Defaults	Comments
comment			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.
extattrs			Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration.
network required			Specifies the network to add or remove from the system. The value should use CIDR notation. aliases: name, cidr
network_view required		Default: default	Configures the name of the network view to associate with this configured instance.
options			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.
	vendor_class	Default: DHCP	The name of the space this DHCP option is associated to
	num		The number of the DHCP option to configure
	name		The name of the DHCP option to configure
	value required		The value of the DHCP option specified by `name`
	use_option bool	Choices: no yes ←	Only applies to a subset of options (see NIOS API documentation)
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 bool	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.
state		Choices: present ← absent	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.

Notes ¶

Note

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

Examples ¶

- name: configure a network ipv4
  nios_network:
    network: 192.168.10.0/24
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local
- name: configure a network ipv6
  nios_network:
    network: fe80::/64
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local
- name: set dhcp options for a network ipv4
  nios_network:
    network: 192.168.10.0/24
    comment: this is a test comment
    options:
      - name: domain-name
        value: ansible.com
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local
- name: remove a network ipv4
  nios_network:
    network: 192.168.10.0/24
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as core which means that it is maintained by the Ansible Core Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Core Team, see here.

Support ¶

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author ¶

Peter Sprygada (@privateip)

Hint

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