DnsServerDsc

3.0.0-preview0005

en-US/about_DnsRecordSrvScoped.help.txt

.NAME
    DnsRecordSrvScoped
 
.SYNOPSIS
    The DnsRecordSrvScoped DSC resource manages SRV DNS records against a specific zone and zone scope on a Domain Name System (DNS) server.
 
.DESCRIPTION
    The DnsRecordSrvScoped DSC resource manages SRV DNS records against a specific zone and zone scope on a Domain Name System (DNS) server.
 
.PARAMETER ZoneScope
    Key - System.String
    Specifies the name of a zone scope. (Key Parameter)
 
.EXAMPLE 1
 
This configuration will ensure a DNS SRV record exists
in the external scope for XMPP that points to
chat.contoso.com with a priority of 10, weight of 20.
 
Configuration DnsRecordSrvScoped_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'
 
    Node localhost
    {
        DnsRecordSrvScoped 'TestRecord'
        {
            ZoneName = 'contoso.com'
            ZoneScope = 'external'
            SymbolicName = 'xmpp'
            Protocol = 'tcp'
            Port = 5222
            Target = 'chat.contoso.com'
            Priority = 10
            Weight = 20
            Ensure = 'Present'
        }
    }
}
 
.EXAMPLE 2
 
This configuration will ensure a DNS SRV record exists in the
external scope for XMPP that points to chat.contoso.com with
a priority of 20, weight of 50 and Time To Live of 5 hours.
 
Configuration DnsRecordSrvScoped_full_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'
 
    Node localhost
    {
        DnsRecordSrvScoped 'TestRecord Full'
        {
            ZoneName = 'contoso.com'
            ZoneScope = 'external'
            SymbolicName = 'xmpp'
            Protocol = 'tcp'
            Port = 5222
            Target = 'chat.contoso.com'
            Priority = 20
            Weight = 50
            TimeToLive = '05:00:00'
            Ensure = 'Present'
        }
    }
}
 
.EXAMPLE 3
 
This configuration will remove a specified DNS SRV record in the
external scope. Note that Priority and Weight are mandatory
attributes, but their values are not used to determine which
record to remove.
 
Configuration DnsRecordSrvScoped_Remove_config
{
    Import-DscResource -ModuleName 'DnsServerDsc'
 
    Node localhost
    {
        DnsRecordSrvScoped 'RemoveTestRecord'
        {
            ZoneName = 'contoso.com'
            ZoneScope = 'external'
            SymbolicName = 'xmpp'
            Protocol = 'tcp'
            Port = 5222
            Target = 'chat.contoso.com'
            Priority = 0
            Weight = 0
            Ensure = 'Absent'
        }
    }
}