DSCResources/DSC_DnsServerZoneAging/en-US/about_DnsServerZoneAging.help.txt

.NAME
    DnsServerZoneAging
 
.DESCRIPTION
    The DnsServerZoneAging DSC resource manages aging settings for a Domain Name System (DNS) server zone.
 
    A resource record can remain on a DNS server after the resource is no longer part of the network. Aging settings determine when a record can be removed, or scavenged, as a stale record.
 
.PARAMETER Name
    Key - String
    Name of the DNS forward or reverse lookup zone.
 
.PARAMETER Enabled
    Required - Boolean
    Option to enable scavenge stale resource records on the zone.
 
.PARAMETER RefreshInterval
    Write - UInt32
    Refresh interval for record scavenging in hours. Default value is 168, 7 days.
 
.PARAMETER NoRefreshInterval
    Write - UInt32
    No-refresh interval for record scavenging in hours. Default value is 168, 7 days.
 
.EXAMPLE 1
 
This configuration will manage aging of a DNS forward zone
 
Configuration DnsServerZoneAging_forward_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'
 
    Node localhost
    {
        DnsServerZoneAging 'DnsServerZoneAging'
        {
            Name = 'contoso.com'
            Enabled = $true
            RefreshInterval = 120 # 5 days
            NoRefreshInterval = 240 # 10 days
        }
    }
}
 
.EXAMPLE 2
 
This configuration will manage aging of a DNS reverse zone
 
Configuration DnsServerZoneAging_reverse_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'
 
    Node localhost
    {
        DnsServerZoneAging 'DnsServerReverseZoneAging'
        {
            Name = '168.192.in-addr-arpa'
            Enabled = $true
            RefreshInterval = 168 # 7 days
            NoRefreshInterval = 168 # 7 days
        }
    }
}