xDnsServer

2.0.0

DSCResources/MSFT_xDnsRecordMx/en-US/about_xDnsRecordMx.help.txt

.NAME
    xDnsRecordMx
 
.DESCRIPTION
    The xDnsRecordMx DSC resource manages MX DNS records against a specific zone
    on a Domian Name System (DNS) server.
 
.PARAMETER Name
    Key - String
    Specifies the name of the DNS server resource record object. For records in the apex of the domain, use a period.
 
.PARAMETER Zone
    Key - String
    Specifies the name of a DNS zone.
 
.PARAMETER Target
    Key - String
    Specifies the Target Hostname or IP Address.
 
.PARAMETER Priority
    Required - UInt16
    Specifies the Priority value of the MX record.
 
.PARAMETER TTL
    Write - String
    Specifies the TTL value of the MX record. Value must be in valid TimeSpan format.
 
.PARAMETER DnsServer
    Write - String
    Name of the DnsServer to create the record on.
 
.PARAMETER Ensure
    Write - String
    Allowed values: Present, Absent
    Should this DNS resource record be present or absent
 
.EXAMPLE 1
 
This configuration will manage a DNS MX record
 
Configuration xDnsRecordMx_config
{
    Import-DscResource -ModuleName 'xDnsServer'
 
    Node localhost
    {
        xDnsRecordMx 'TestRecord'
        {
            Name = '@'
            Target = 'mail.contoso.com.'
            Zone = 'contoso.com'
            Priority = 10
            TTL = '01:00:00'
            Ensure = 'Present'
        }
    }
}
 
.EXAMPLE 2
 
This configuration will remove a DNS MX record
 
Configuration xDnsRecordMx_Remove_config
{
    Import-DscResource -ModuleName 'xDnsServer'
 
    Node localhost
    {
        xDnsRecordMx 'RemoveTestRecord'
        {
            Name = '@'
            Target = 'mail.contoso.com.'
            Zone = 'contoso.com'
            Priority = 10
            Ensure = 'Absent'
        }
    }
}