nios_txt_record – Configure Infoblox NIOS txt records
New in version 2.7.
Synopsis
- Adds and/or removes instances of txt record objects from Infoblox NIOS servers. This module manages NIOS
record:txt
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. | ||
name - / required | Specifies the fully qualified hostname to add or remove from the system | ||
provider dictionary | A dict object containing connection details. | ||
host string / 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. | ||
http_request_timeout integer | 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_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 INFOBLOX_MAX_RESULTS environment variable. | |
max_retries integer | 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. | |
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. | ||
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 boolean |
| Boolean value to enable or disable verifying SSL certificates Value can also be specified using INFOBLOX_SSL_VERIFY environment variable.aliases: ssl_verify | |
wapi_version string | Default: "2.1" | 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 | |
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. | |
text - | Text associated with the record. It can contain up to 255 bytes per substring, up to a total of 512 bytes. To enter leading, trailing, or embedded spaces in the text, add quotes around the text to preserve the spaces. | ||
ttl - | Configures the TTL to be associated with this tst record | ||
view - / required | Default: "default" | Sets the DNS view to associate this tst 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
. - Please read the Infoblox Guide for more detailed information on how to use Infoblox with Ansible.
Examples
- name: Ensure a text Record Exists nios_txt_record: name: fqdn.txt.record.com text: mytext state: present view: External provider: host: "{{ inventory_hostname_short }}" username: admin password: admin - name: Ensure a text Record does not exist nios_txt_record: name: fqdn.txt.record.com text: mytext state: absent view: External provider: host: "{{ inventory_hostname_short }}" username: admin password: admin
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Corey Wanless (@coreywan)
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.8/modules/nios_txt_record_module.html