nios_host_record - Configure Infoblox NIOS host records
New in version 2.5.
Synopsis
- Adds and/or removes instances of host record objects from Infoblox NIOS servers. This module manages NIOS
record:host
objects using the Infoblox WAPI interface over REST. - Updates instances of host record object from Infoblox NIOS servers.
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. | ||
ipv4addrs | Configures the IPv4 addresses for this host record. This argument accepts a list of values (see suboptions) aliases: ipv4 | ||
ipv4addr required | Configures the IPv4 address for the host record aliases: address | ||
mac | Configures the hardware MAC address for the host record | ||
ipv6addrs | Configures the IPv6 addresses for the host record. This argument accepts a list of values (see options) aliases: ipv6 | ||
ipv6addr required | Configures the IPv6 address for the host record aliases: address | ||
name required | Specifies the fully qualified hostname to add or remove from the system. User can also update the hostname as it is possible to pass a dict containing new_name, old_name. See examples. | ||
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. | |
ttl | Configures the TTL to be associated with this host record | ||
view required | Default: "default" | Sets the DNS view to associate this host record with. The DNS view must already be configured on the system aliases: dns_view |
Notes
Note
- This module must be run locally, which can be achieved by specifying
connection: local
.
Examples
- name: configure an ipv4 host record nios_host_record: name: host.ansible.com ipv4: - address: 192.168.10.1 state: present provider: host: "{{ inventory_hostname_short }}" username: admin password: admin connection: local - name: add a comment to an existing host record nios_host_record: name: host.ansible.com ipv4: - address: 192.168.10.1 comment: this is a test comment state: present provider: host: "{{ inventory_hostname_short }}" username: admin password: admin connection: local - name: remove a host record from the system nios_host_record: name: host.ansible.com state: absent provider: host: "{{ inventory_hostname_short }}" username: admin password: admin connection: local - name: update an ipv4 host record nios_host_record: name: {new_name: host-new.ansible.com, old_name: host.ansible.com} ipv4: - address: 192.168.10.1 state: present 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_host_record_module.html