DSCResources/MSFT_xDnsServerPrimaryZone/en-US/about_xDnsServerPrimaryZone.help.txt

.NAME
    xDnsServerPrimaryZone
 
.DESCRIPTION
    The xDnsServerPrimaryZone DSC resource manages a standalone file-backed Primary zone on a given Domain Name System (DNS) server.
 
.PARAMETER Name
    Key - String
    Name of the DNS Server primary zone
 
.PARAMETER ZoneFile
    Write - String
    Name of the DNS Server primary zone file. If not specified, defaults to 'ZoneName.dns'.
 
.PARAMETER DynamicUpdate
    Write - String
    Allowed values: None, NonSecureAndSecure
    Primary zone dynamic DNS update option. Defaults to 'None'.
 
.PARAMETER Ensure
    Write - String
    Allowed values: Present, Absent
    Whether the DNS zone should be present or absent
 
.EXAMPLE 1
 
This configuration will add a file-backed classful reverse primary zone
using the resource default parameter values.
 
Configuration xDnsServerPrimaryZone_AddClassfulReversePrimaryZone_Config
{
    Import-DscResource -ModuleName 'xDnsServer'
 
    Node localhost
    {
        xDnsServerPrimaryZone 'AddPrimaryZone'
        {
            Name = '1.168.192.in-addr.arpa'
        }
    }
}
 
.EXAMPLE 2
 
This configuration will add a file-backed classless reverse primary zone
using the resource default parameter values.
 
Configuration xDnsServerPrimaryZone_AddClasslessReversePrimaryZone_Config
{
    Import-DscResource -ModuleName 'xDnsServer'
 
    Node localhost
    {
        xDnsServerPrimaryZone 'AddPrimaryZone'
        {
            Name = '64-26.100.168.192.in-addr.arpa'
        }
    }
}
 
.EXAMPLE 3
 
This configuration will add a file-backed primary zone using the resource
default parameter values.
 
Configuration xDnsServerPrimaryZone_AddPrimaryZoneUsingDefaults_Config
{
    Import-DscResource -ModuleName 'xDnsServer'
 
    Node localhost
    {
        xDnsServerPrimaryZone 'AddPrimaryZone'
        {
            Name = 'demo.contoso.com'
        }
    }
}
 
.EXAMPLE 4
 
This configuration will add a file-backed primary zone using the resource
default parameter values.
 
Configuration xDnsServerPrimaryZone_AddPrimaryZoneWithSpecificValues_Config
{
    Import-DscResource -ModuleName 'xDnsServer'
 
    Node localhost
    {
        xDnsServerPrimaryZone 'AddPrimaryZone'
        {
            Ensure = 'Present'
            Name = 'demo.contoso.com'
            ZoneFile = 'demo.contoso.com.dns'
            DynamicUpdate = 'NonSecureAndSecure'
        }
    }
}
 
.EXAMPLE 5
 
This configuration will remove a file-backed primary zone.
 
Configuration xDnsServerPrimaryZone_RemovePrimaryZone_Config
{
    Import-DscResource -ModuleName 'xDnsServer'
 
    Node localhost
    {
        xDnsServerPrimaryZone 'RemovePrimaryZone'
        {
            Ensure = 'Absent'
            Name = 'demo.contoso.com'
        }
    }
}
 
.EXAMPLE 6
 
This configuration will remove a file-backed primary zone.
 
Configuration xDnsServerPrimaryZone_RemoveReversePrimaryZone_Config
{
    Import-DscResource -ModuleName 'xDnsServer'
 
    Node localhost
    {
        xDnsServerPrimaryZone 'RemovePrimaryZone'
        {
            Ensure = 'Absent'
            Name = '1.168.192.in-addr.arpa'
        }
    }
}