Add-DnsServerResourceRecordMX

Add-DnsServerResourceRecordMX

Adds an MX resource record to a DNS server.

Syntax

Parameter Set: Add0
Add-DnsServerResourceRecordMX [-ZoneName] <String> [-Name] <String> [-MailExchange] <String> [-Preference] <UInt16> [-AgeRecord] [-AllowUpdateAny] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-TimeToLive <TimeSpan> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Add-DnsServerResourceRecordMX cmdlet adds a Mail Exchanger (MX) resource record to a Domain Name System (DNS) zone.

The MX resource record provides the name for a mail server for a domain. If there are multiple MX resource records for a domain, the client attempts to contact mail servers in the order of preference from lowest value to highest value.

Parameters

-AgeRecord

Indicates that the DNS server uses a time stamp for the resource record that this cmdlet adds. A DNS server can scavenge resource records that have become stale based on a time stamp.

-AllowUpdateAny

Indicates that any authenticated user can update a resource record that has the same owner name.

-AsJob

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

-ComputerName<String>

Specifies a DNS server. If you do not specify this parameter, the command runs on the local system. You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name.

-MailExchange<String>

Specifies an FQDN for a mail exchanger. This value must resolve to a corresponding host (A) resource record.

-Name<String>

Specifies the name of the host or child domain for the mail exchange record. To add an MX resource record for the parent domain, specify a dot (.)..

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-Preference<UInt16>

Specifies a priority, from 0 to 65535, for this MX resource record. A service attempts to contact mail servers in the order of preference from lowest priority value to highest priority value.

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

-TimeToLive<TimeSpan>

Specifies the Time to Live (TTL) value, in seconds, for a resource record. Other DNS servers use this length of time to determine how long to cache a record.

The Start of Authority (SOA) record defines the default TTL.

-ZoneName<String>

Specifies the name of a DNS zone.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord

Examples

Example 1: Add an MX resource record

This command adds an MX record named RecordNameMX for the zone western.contoso.com with a preference of 123. The mail exchanger is MAILSrv1.

PS C:\> Add-DnsServerResourceRecordMX -Preference 10  -Name "." -TimeToLive 01:00:00 -MailExchange "mail.contoso.com" -ZoneName "contoso.com"