Skip to content

DnsRecordAaaaScoped

dscbot edited this page Aug 19, 2024 · 4 revisions

DnsRecordAaaaScoped

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key System.String Specifies the name of a DNS server resource record object. (Key Parameter)
IPv6Address Key System.String Specifies the IPv6 address of a host. (Key Parameter)
ZoneScope Key System.String Specifies the name of a zone scope. (Key Parameter)

Description

The DnsRecordAaaaScoped DSC resource manages AAAA DNS records against a specific zone and zone scope 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 DnsRecordAaaaScoped_Mandatory_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'

    Node localhost
    {
        DnsRecordAaaaScoped 'TestRecord'
        {
            ZoneName    = 'contoso.com'
            ZoneScope   = 'external'
            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 DnsRecordAaaaScoped_Full_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'

    Node localhost
    {
        DnsRecordAaaaScoped 'TestRecord'
        {
            ZoneName    = 'contoso.com'
            ZoneScope   = 'external'
            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 DnsRecordAaaaScoped_Remove_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'

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