nios_mx_record - Configure Infoblox NIOS MX records¶

New in version 2.7.

Synopsis
- Requirements
Parameters
Notes
Examples
Status
Maintenance
- Author

Synopsis ¶

Adds and/or removes instances of MX record objects from Infoblox NIOS servers. This module manages NIOS record:mx 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.
mail_exchanger required			Configures the mail exchanger FQDN for this MX record. aliases: mx
name required			Specifies the fully qualified hostname to add or remove from the system
preference required			Configures the preference (0-65535) for this MX record.
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.
ttl			Configures the TTL to be associated with this host record
view required		Default: default	Sets the DNS view to associate this a 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: configure an MX record
  nios_mx_record:
    name: ansible.com
    mx: mailhost.ansible.com
    preference: 0
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: add a comment to an existing MX record
  nios_mx_record:
    name: ansible.com
    mx: mailhost.ansible.com
    preference: 0
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: remove an MX record from the system
  nios_mx_record:
    name: ansible.com
    mx: mailhost.ansible.com
    preference: 0
    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 certified which means that it is maintained by an Ansible Partner. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by an Ansible Partner, see here.

Author ¶

Blair Rampling (@brampling)

Hint

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