xDnsServerSetting

xDnsServerSetting

⚠️ DEPRECATED! The resource has been replaced by DnsServerSetting and DnsServerSettingLegacy in the DSC resource module DnsServerDsc.

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
DnsServer	Key	String	Specifies the DNS server to connect to, or use 'localhost' for the current node.
AddressAnswerLimit	Write	UInt32	Maximum number of host records returned in response to an address request. Values between 5 and 28 are valid.
AllowUpdate	Write	UInt32	Specifies whether the DNS Server accepts dynamic update requests.
AutoCacheUpdate	Write	Boolean	Indicates whether the DNS Server attempts to update its cache entries using data from root servers.
AutoConfigFileZones	Write	UInt32	Indicates which standard primary zones that are authoritative for the name of the DNS Server must be updated when the name server changes.
BindSecondaries	Write	Boolean	Determines the AXFR message format when sending to non-Microsoft DNS Server secondaries.
BootMethod	Write	UInt32	Initialization method for the DNS Server.
DisableAutoReverseZones	Write	Boolean	Indicates whether the DNS Server automatically creates standard reverse look up zones.
DisjointNets	Write	Boolean	Indicates whether the default port binding for a socket used to send queries to remote DNS Servers can be overridden.
DsPollingInterval	Write	UInt32	Interval, in seconds, to poll the DS-integrated zones.
DsTombstoneInterval	Write	UInt32	Lifetime of tombstoned records in Directory Service integrated zones, expressed in seconds.
EDnsCacheTimeout	Write	UInt32	Lifetime, in seconds, of the cached information describing the EDNS version supported by other DNS Servers.
EnableDirectoryPartitions	Write	Boolean	Specifies whether support for application directory partitions is enabled on the DNS Server.
EnableDnsSec	Write	UInt32	Specifies whether the DNS Server includes DNSSEC-specific RRs, KEY, SIG, and NXT in a response.
EnableEDnsProbes	Write	Boolean	Specifies the behavior of the DNS Server. When TRUE, the DNS Server always responds with OPT resource records according to RFC 2671, unless the remote server has indicated it does not support EDNS in a prior exchange. If FALSE, the DNS Server responds to queries with OPTs only if OPTs are sent in the original query.
ForwardDelegations	Write	UInt32	Specifies whether queries to delegated sub-zones are forwarded.
IsSlave	Write	Boolean	TRUE if the DNS server does not use recursion when name-resolution through forwarders fails.
ListenAddresses	Write	StringArray[]	Enumerates the list of IP addresses on which the DNS Server can receive queries.
LocalNetPriority	Write	Boolean	Indicates whether the DNS Server gives priority to the local net address when returning A records.
LogLevel	Write	UInt32	Indicates which policies are activated in the Event Viewer system log.
LooseWildcarding	Write	Boolean	Indicates whether the DNS Server performs loose wildcarding.
MaxCacheTTL	Write	UInt32	Maximum time, in seconds, the record of a recursive name query may remain in the DNS Server cache.
MaxNegativeCacheTTL	Write	UInt32	Maximum time, in seconds, a name error result from a recursive query may remain in the DNS Server cache.
NameCheckFlag	Write	UInt32	Indicates the set of eligible characters to be used in DNS names.
NoRecursion	Write	Boolean	Indicates whether the DNS Server performs recursive look ups. TRUE indicates recursive look ups are not performed.
RecursionRetry	Write	UInt32	Elapsed seconds before retrying a recursive look up.
RecursionTimeout	Write	UInt32	Elapsed seconds before the DNS Server gives up recursive query.
RoundRobin	Write	Boolean	Indicates whether the DNS Server round robins multiple A records.
RpcProtocol	Write	SInt16	RPC protocol or protocols over which administrative RPC runs.
SecureResponses	Write	Boolean	Indicates whether the DNS Server exclusively saves records of names in the same subtree as the server that provided them.
SendPort	Write	UInt32	Port on which the DNS Server sends UDP queries to other servers.
StrictFileParsing	Write	Boolean	Indicates whether the DNS Server parses zone files strictly.
UpdateOptions	Write	UInt32	Restricts the type of records that can be dynamically updated on the server, used in addition to the AllowUpdate settings on Server and Zone objects.
WriteAuthorityNS	Write	Boolean	Specifies whether the DNS Server writes NS and SOA records to the authority section on successful response.
XfrConnectTimeout	Write	UInt32	Time, in seconds, the DNS Server waits for a successful TCP connection to a remote server when attempting a zone transfer.
DsAvailable	Read	Boolean	Indicates whether there is an available DS on the DNS Server.

Description

The xDnsServerSetting DSC resource manages the Domain Name System (DNS) server settings and properties.

If the parameter DnsServer is set to 'localhost' then the resource can normally use the default credentials (SYSTEM) to configure the DNS server settings. If using any other value for the parameter DnsServer make sure that the credential the resource is run as have the correct permissions at the target node and the necessary network traffic is permitted (WsMan protocol). It is possible to run the resource with specific credentials using the built-in parameter PsDscRunAsCredential.

Examples

Example 1

This configuration will manage the DNS server settings on the current node.

Configuration xDnsServerSetting_CurrentNode_Config
{
    Import-DscResource -ModuleName 'xDnsServer'

    Node localhost
    {
        xDnsServerSetting 'DnsServerProperties'
        {
            DnsServer           = 'localhost'
            ListenAddresses    = '10.0.0.4'
            IsSlave            = $true
            RoundRobin         = $true
            LocalNetPriority   = $true
            SecureResponses    = $true
            NoRecursion        = $false
            BindSecondaries    = $false
            StrictFileParsing  = $false
            LogLevel           = 50393905
        }
    }
}

Example 2

This configuration will manage the DNS server settings on the current node.

Configuration xDnsServerSetting_RemoteNode_Config
{
    Import-DscResource -ModuleName 'xDnsServer'

    Node localhost
    {
        xDnsServerSetting 'DnsServerProperties'
        {
            DnsServer           = 'dns1.company.local'
            ListenAddresses    = '10.0.0.4'
            IsSlave            = $true
            RoundRobin         = $true
            LocalNetPriority   = $true
            SecureResponses    = $true
            NoRecursion        = $false
            BindSecondaries    = $false
            StrictFileParsing  = $false
            LogLevel           = 50393905
        }
    }
}