nios_zone - Configure Infoblox NIOS DNS zones
New in version 2.5.
Synopsis
- Adds and/or removes instances of DNS zone objects from Infoblox NIOS servers. This module manages NIOS
zone_auth
objects using the Infoblox WAPI interface over REST.
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. | ||
fqdn required | Specifies the qualified domain name to either add or remove from the NIOS instance based on the configured state value.aliases: name | ||
grid_primary | Configures the grid primary servers for this zone. | ||
name required | The name of the grid primary server | ||
grid_secondaries | Configures the grid secondary servers for this zone. | ||
name required | The name of the grid secondary server | ||
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. | ||
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. | ||
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 bool |
| Boolean value to enable or disable verifying SSL certificates Value can also be specified using INFOBLOX_SSL_VERIFY 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. | |
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. | |
state |
| 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. | |
view required | Default: "default" | Configures the DNS view name for the configured resource. The specified DNS zone must already exist on the running NIOS instance prior to configuring zones. aliases: dns_view |
Notes
Note
- This module must be run locally, which can be achieved by specifying
connection: local
.
Examples
- name: configure a zone on the system nios_zone: name: ansible.com state: present provider: host: "{{ inventory_hostname_short }}" username: admin password: admin connection: local - name: update the comment and ext attributes for an existing zone nios_zone: name: ansible.com comment: this is an example comment extattrs: Site: west-dc state: present provider: host: "{{ inventory_hostname_short }}" username: admin password: admin connection: local - name: remove the dns zone nios_zone: name: ansible.com 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.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/nios_zone_module.html