---
title: "MX Record"
canonical: "https://docs.infoblox.com/space/niosmodulesansible/44624185/MX%20Record"
format: markdown
---
Use the `nios_mx_record` module to create, update, or remove an MX record object from a NIOS Grid.

The following table describes the parameters you can define in the `nios_mx_record` module:

| **Parameter** | **Required/Optional** | **Description** |
| --- | --- | --- |
| `name` | Required | Specifies the fully qualified host name of the record to add, update, or remove from NIOS.<br>To update the name of an MX record object, define a dictionary object that contains the following parameters:<br>- `old_name`: Specifies the existing name that must be changed.
- `new_name`: Specifies the new name. |
| `view` | Optional | Specifies the DNS view to associate the MX record with.  
If a value is not specified, the default DNS view configured in NIOS is used. |
| `mail_exchanger` | Required | Specifies the mail exchanger FQDN for this MX record. |
| `preference` | Required | Specifies the preference value in the range of 0 to 65535 that is formatted as a 32-bit unsigned integer. |
| `ttl` | Optional | Specifies the Time To Live (TTL) value for the record.  
The duration that the record is valid for in seconds (cached). |
| `extattrs` | Optional | Specifies extensible attributes for the MX record object. |
| `state` | Optional | Specifies the state of the MX record instance on the NIOS server.  
Set one of the following values:<br>- `present` (default): Configures the record.
- `absent`: Removes the record. |
| `comment` | Optional | Describes the MX record object. |
| `provider` | Required | Defines the details of the connection:<br>- `host`: DNS host name or IP address to connect to the remote instance of NIOS.
- `username`: User name to use for authenticating the connection to the remote instance.
- `password`: Password to use for authenticating the connection to the remote instance.<br>For information on additional fields you can define, see <span style="color: #172b4d">the list of subparameters in the </span><span style="color: #172b4d">*[NIOS Modules for Ansible Collections](https://infoblox-docs.atlassian.net/wiki/spaces/niosmodulesansible/pages/44525470)*</span><span style="color: #172b4d"> topic.</span> |
| `connection` | Required | The `nios_mx_record` module must be run locally. |

## <span style="color: #000000">Examples</span>

`name: Configure an MX record`  
`infoblox.nios_modules.nios_mx_record:`  
`  name: ansible.com`  
`  mx: mailhost.ansible.com`  
`  preference: 0`  
`  state: present`  
`  provider:`  
`    host: <nios_hostname_or_hostip>`  
`    username: <nios_username>`  
`    password: <nios_password>`  
`connection: local`


`name: Add a comment to an existing MX record`  
`infoblox.nios_modules.nios_mx_record:`  
`  name: ansible.com`  
`  mx: mailhost.ansible.com`  
`  preference: 0`  
`  comment: this is a test comment  state: present`  
`  provider:`  
`    host: <nios_hostname_or_hostip>`  
`    username: <nios_username>`  
`    password: <nios_password>`  
`connection: local`  


`name: Update the name of an MX Record`  
`infoblox.nios_modules.nios_mx_record:`  
`  name: {old_name: ansible.com, new_name: newAnsible.com}`  
`  mx: mailhost.ansible.com`  
`  preference: 0`  
`  state: present`  
`  provider:`  
`    host: <nios_hostname_or_hostip>`  
`    username: <nios_username>`  
`    password: <nios_password>`  
`connection: local`