community.general.nios_network – Configure Infoblox NIOS network object
community.general.nios_network – Configure Infoblox NIOS network object
Note
This plugin is part of the community.general collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.nios_network
.
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 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. | ||
container boolean |
|
If set to true it'll create the network container to be added or removed from the system. | |
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. | ||
network string / required |
Specifies the network to add or remove from the system. The value should use CIDR notation.
| ||
network_view string |
Default: "default" |
Configures the name of the network view to associate with this configured instance. | |
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 string |
The name of the DHCP option to configure. The standard options are | ||
num integer |
The number of the DHCP option to configure | ||
use_option boolean |
|
Only applies to a subset of options (see NIOS API documentation) | |
value string / required |
The value of the DHCP option specified by | ||
vendor_class string |
Default: "DHCP" |
The name of the space this DHCP option is associated to | |
provider dictionary |
A dict object containing connection details. | ||
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 | ||
http_pool_connections integer |
Default: 10 |
Number of pools to be used by the This is passed as-is to the underlying | |
http_pool_maxsize integer |
Default: 10 |
Maximum number of connections per pool to be used by the This is passed as-is to the underlying | |
http_request_timeout integer |
Default: 10 |
The amount of time before to wait before receiving a response Value can also be specified using | |
max_results integer |
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 | |
max_retries integer |
Default: 3 |
Configures the number of attempted retries before the connection is declared usable Value can also be specified using | |
password string |
Specifies the password to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using | ||
silent_ssl_warnings boolean |
|
Disable This is passed as-is to the underlying | |
username string |
Configures the username to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using | ||
validate_certs boolean |
|
Boolean value to enable or disable verifying SSL certificates Value can also be specified using
| |
wapi_version string |
Default: "2.1" |
Specifies the version of WAPI to use Value can also be specified using Until ansible 2.8 the default WAPI was 1.4 | |
state string |
|
Configures the intended state of the instance of the object on the NIOS server. When this value is set to |
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: Configure a network ipv4
community.general.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
community.general.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
community.general.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
community.general.nios_network:
network: 192.168.10.0/24
state: absent
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Configure a ipv4 network container
community.general.nios_network:
network: 192.168.10.0/24
container: true
comment: test network container
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Configure a ipv6 network container
community.general.nios_network:
network: fe80::/64
container: true
comment: test network container
state: present
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
- name: Remove a ipv4 network container
community.general.nios_network:
networkr: 192.168.10.0/24
container: true
comment: test network container
state: absent
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local
Authors
- Peter Sprygada (@privateip)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/nios_network_module.html