Skip to content

DnsRecordAaaa

dscbot edited this page Apr 12, 2025 · 5 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
IPv6Address Key System.String Specifies the IPv6 address of a host. (Key Parameter)
Name Key System.String Specifies the name of a DNS server resource record object. (Key Parameter)
ZoneName Key System.String Specifies the name of a DNS zone. (Key Parameter)
DnsServer Write System.String The host name of the Domain Name System (DNS) server, or use 'localhost' for the current node. Defaults to 'localhost'.
Ensure Write Ensure Whether the host record should be present or removed. Present, Absent
TimeToLive Write System.String Specifies the TimeToLive value of the SRV record. Value must be in valid TimeSpan string format (i.e.: Days.Hours:Minutes:Seconds.Miliseconds or 30.23:59:59.999).

Description

The DnsRecordAaaa DSC resource manages AAAA DNS records against a specific zone on a Domain Name System (DNS) server.

Examples

Example 1

This configuration will ensure a DNS AAAA record exists when only the mandatory properties are specified.

Configuration DnsRecordAaaa_Mandatory_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'

    Node localhost
    {
        DnsRecordAaaa 'TestRecord'
        {
            ZoneName    = 'contoso.com'
            Name        = 'www'
            IPv6Address = '2001:db8:85a3::8a2e:370:7334'
            Ensure      = 'Present'
        }
    }
}

Example 2

This configuration will ensure a DNS AAAA record exists when all properties are specified.

Configuration DnsRecordAaaa_Full_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'

    Node localhost
    {
        DnsRecordAaaa 'TestRecord'
        {
            ZoneName    = 'contoso.com'
            Name        = 'www'
            IPv6Address = '2001:db8:85a3::8a2e:370:7334'
            TimeToLive  = '01:00:00'
            DnsServer   = 'localhost'
            Ensure      = 'Present'
        }
    }
}

Example 3

This configuration will ensure a DNS AAAA record does not exist when mandatory properties are specified.

Note that not all mandatory properties are necessarily key properties. Non-key property values will be ignored when determining whether the record is to be removed.

Configuration DnsRecordAaaa_Remove_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'

    Node localhost
    {
        DnsRecordAaaa 'TestRecord'
        {
            ZoneName    = 'contoso.com'
            Name        = 'www'
            IPv6Address = '2001:db8:85a3::8a2e:370:7334'
            Ensure      = 'Absent'
        }
    }
}
Clone this wiki locally