DnsServerSetting class

  • Article

Represents the settings for a DNS server.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[ClassVersion("1.0.0"), dynamic, provider("DnsServerPSProvider"), AMENDMENT]
class DnsServerSetting
{
  string   ComputerName;
  uint32   NameCheckFlag;
  uint32   AddressAnswerLimit;
  uint32   XfrConnectTimeout;
  uint32   BootMethod;
  uint32   UpdateOptions;
  boolean  AllowUpdate;
  boolean  DsAvailable;
  boolean  DisableAutoReverseZone;
  boolean  AutoCacheUpdate;
  boolean  RoundRobin;
  boolean  LocalNetPriority;
  uint32   LocalNetPriorityMask;
  boolean  StrictFileParsing;
  boolean  LooseWildcarding;
  boolean  BindSecondaries;
  boolean  WriteAuthorityNs;
  boolean  ForwardDelegations;
  uint32   AutoConfigFileZones;
  boolean  EnableDirectoryPartitions;
  uint32   RpcProtocol;
  uint32   EnableVersionQuery;
  boolean  EnableDuplicateQuerySuppression;
  datetime LameDelegationTtl;
  uint32   AutoCreateDelegation;
  boolean  AllowCNameAtNs;
  uint32   RemoteIPv4RankBoost;
  uint32   RemoteIPv6RankBoost;
  boolean  EnableRsoForRodc;
  uint32   MaximumRodcRsoQueueLength;
  uint32   MaximumRodcRsoAttemptsPerCycle;
  boolean  OpenAclOnProxyUpdates;
  boolean  NoUpdateDelegations;
  boolean  EnableUpdateForwarding;
  uint32   MaxResourceRecordsInNonSecureUpdate;
  boolean  EnableWinsR;
  boolean  DeleteOutsideGlue;
  boolean  AppendMsZoneTransferTag;
  boolean  AllowReadOnlyZoneTransfer;
  uint32   MaximumUdpPacketSize;
  uint32   TcpReceivePacketSize;
  boolean  EnableSendErrorSuppression;
  uint32   SelfTest;
  uint32   XfrThrottleMultiplier;
  boolean  SilentlyIgnoreCNameUpdateConflicts;
  boolean  EnableIQueryResponseGeneration;
  uint32   SocketPoolSize;
  boolean  AdminConfigured;
  string   ForestDirectoryPartitionBaseName;
  string   DomainDirectoryPartitionBaseName;
  string   ServerLevelPluginDll;
  string   SocketPoolExcludedPortRanges[];
  uint32   EnableRegistryBoot;
  boolean  PublishAutoNet;
  uint32   QuietRecvFaultInterval;
  uint32   QuietRecvLogInterval;
  boolean  ReloadException;
  uint32   SyncDsZoneSerial;
  uint32   SendPort;
  string   AllIPAddress[];
  string   ListeningIPAddress[];
  uint32   MajorVersion;
  uint32   MinorVersion;
  uint32   BuildNumber;
  boolean  IsReadOnlyDC;
  boolean  EnableDnsSec;
  boolean  EnableOnlineSigning;
  datetime MaximumSignatureScanPeriod;
  datetime MaximumTrustAnchorActiveRefreshInterval;
  boolean  EnableIPv6;
  string   RootTrustAnchorsURL;
  datetime ZoneWritebackInterval;
  uint32   ScopeOptionValue;
  boolean  IgnoreServerLevelPolicies;
  boolean  IgnoreAllPolicies;
  uint32   VirtualizationInstanceOptionValue;
};

Members

The DnsServerSetting class has these types of members:

Properties

The DnsServerSetting class has these properties.

AddressAnswerLimit

Data type: uint32

Access type: Read/write

Specifies the maximum number of A (host IP address) resource records that the DNS server can insert in the answer section of a response to an A record query (a query for an IP address). The value of this entry also influences the setting of the truncation bit. If the value of this entry is between 5 and 28, the truncation bit is not set on the response, even when the packet space is exceeded.

0

Range: 5 28

AdminConfigured

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the server has been configured by an administrator.

AllIPAddress

Data type: string array

Access type: Read-only

An array that contains all of the IP addresses managed by the DNS server.

AllowCNameAtNs

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the server will permit the target domain names of NS records to resolve to CNAME records. If true, this pattern of DNS records will be allowed; otherwise, the DNS server will return errors when encountering this pattern of DNS records while resolving queries.

AllowReadOnlyZoneTransfer

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will allow zone transfers for zones that are stored in the directory server when the directory server does not support write operations.

AllowUpdate

Data type: boolean

Access type: Read/write

true to allow any DNS update operation; otherwise, false.

AppendMsZoneTransferTag

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will indicate to the remote DNS servers that it supports multiple DNS records in each zone transfer response message by appending the characters MS at the end of zone transfer requests. The value SHOULD be limited to 0x00000000 and 0x00000001, but it MAY be any value. The default value SHOULD be 0x00000000, and the value zero MUST be allowed and treated literally.

AutoCacheUpdate

Data type: boolean

Access type: Read/write

true to cache delegation information; otherwise, false.

AutoConfigFileZones

Data type: uint32

Access type: Read/write

The type of zones for which SOA and NS records will be automatically configured with the DNS server's local host name as the primary DNS server for the zone when the zone is loaded from file.

AutoCreateDelegation

Data type: uint32

Access type: Read/write

The possible settings for automatic delegation creation for new zones on the DNS server. The value SHOULD be limited to the range from 0x00000000 to 0x00000002, inclusive, but it MAY be any value. The default value SHOULD be 0x00000002, and the value zero MUST be allowed and treated literally

BindSecondaries

Data type: boolean

Access type: Read/write

true to cache delegation information; otherwise, false.

A Boolean value indicating whether the server will permit send DNS zone transfer response messages with more than one record in each response if the zone transfer request did not have the characters MS appended to it. If true, the DNS server will include only one record in each response if the zone transfer request did not have the characters MS appended to it.

BootMethod

Data type: uint32

Access type: Read/write

Indicates the boot method used by the DNS server.

BuildNumber

Data type: uint32

Access type: Read-only

The build version of the OS of the DNS server.

ComputerName

Data type: string

Access type: Read-only

The computer name of the DNS server.

DeleteOutsideGlue

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will delete DNS glue records found outside a delegated subzone when reading records from persistent storage.

DisableAutoReverseZone

Data type: boolean

Access type: Read/write

true to disables automatic reverse zones; otherwise, false.

DomainDirectoryPartitionBaseName

Data type: string

Access type: Read-only

Applicable only for active directory integrated DNS server. The application directory partition for the domain the DNS server belongs to.

DsAvailable

Data type: boolean

Access type: Read-only

true if the DNS server has Active Directory integrated DNS enabled; otherwise, false.

EnableDirectoryPartitions

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will support application directory partitions.

EnableDnsSec

Data type: boolean

Access type: Read/write

true to enable DNSSEC validation on the DNS server; otherwise, false.

EnableDuplicateQuerySuppression

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will not send remote queries when there is already a remote query with the same name and query type outstanding.

EnableIPv6

Data type: boolean

Access type: Read/write

true to enable IPv6 on the DNS server; otherwise, false.

EnableIQueryResponseGeneration

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will fabricate IQUERY responses. If set to true, the DNS server MUST fabricate IQUERY responses when it receives queries of type IQUERY. Otherwise, the DNS server will return an error when such queries are received.

EnableOnlineSigning

Data type: boolean

Access type: Read/write

true to enable online signing; otherwise, false.

EnableRegistryBoot

Data type: uint32

Access type: Read/write

A value which, if present in local persistent configuration at boot time, indicates that the DNS server MUST rewrite the value of the BootMethod property

EnableRsoForRodc

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will attempt to replicate single updated DNS objects from remote directory servers ahead of normally scheduled replication when operating on a directory server that does not support write operations.

EnableSendErrorSuppression

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will attempt to suppress large volumes of DNS error responses sent to remote IP addresses that may be attempting to attack the DNS server.

EnableUpdateForwarding

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will forward updates received for secondary zones to the primary DNS server for the zone.

EnableVersionQuery

Data type: uint32

Access type: Read/write

This property controls what version information the DNS server will respond with when a DNS query with class set to CHAOS and type set to TXT is received. The default value MUST be 0x00000001.

EnableWinsR

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will perform NetBIOS name resolution in order to map IP addresses to machine names while processing queries in zones where WINS-R information has been configured.

ForestDirectoryPartitionBaseName

Data type: string

Access type: Read-only

Applicable only for active directory integrated DNS server. The application directory partition for the forest the DNS server belongs to.

ForwardDelegations

Data type: boolean

Access type: Read/write

A Boolean value indicating how the DNS server will handle forwarding and delegations. If set to true, the DNS server MUST use forwarders instead of a cached delegation when both are available. Otherwise, the DNS server MUST use a cached delegation instead of forwarders when both are available.

IgnoreAllPolicies

Data type: boolean

Access type: Read/write

true to ignore all policies on the DNS server; otherwise, false.

Windows Server 2012 R2 and Windows Server 2012: Not supported.

IgnoreServerLevelPolicies

Data type: boolean

Access type: Read/write

true to ignore the server level policies of the DNS server; otherwise, false.

Windows Server 2012 R2 and Windows Server 2012: Not supported.

IsReadOnlyDC

Data type: boolean

Access type: Read-only

true to enable write operations on the directory server; otherwise, false.

LameDelegationTtl

Data type: datetime

Access type: Read/write

The time span that must elapse before the DNS server will re-query DNS servers of the parent zone when a lame delegation is encountered. The value SHOULD be limited to the range from 0x00000000 to 0x00278D00 30 days, inclusive, but it MAY be any value.

ListeningIPAddress

Data type: string array

Access type: Read/write

An array that contains the listening IP addresses of the DNS server.

LocalNetPriority

Data type: boolean

Access type: Read/write

true to return A records in order of their similarity to the IP address of the querying client.; otherwise, false.

LocalNetPriorityMask

Data type: uint32

Access type: Read/write

A value which specifies the network mask the DNS server will use to sort IPv4 addresses. A value of 0xFFFFFFFF indicates that the DNS server MUST use traditional IPv4 network mask for the address. Any other value is a network mask, in host byte order that the DNS server MUST use to retrieve network masks from IP addresses for sorting purposes. The value's range MUST be unlimited. The default value MUST be 0x000000FF, and the value zero MUST be allowed and treated literally.

LooseWildcarding

Data type: boolean

Access type: Read/write

true to cache delegation information; otherwise, false.

A Boolean value indicating the type of algorithm that the DNS server will use to locate a wildcard node when using a DNS wildcard record RFC1034 to answer a query. If true, the DNS server will use the first node it encounters with a record of the same type as the query type. Otherwise, the DNS server will use the first node it encounters that has records of any type.

MajorVersion

Data type: uint32

Access type: Read-only

The major version of the OS of the DNS server.

MaximumRodcRsoAttemptsPerCycle

Data type: uint32

Access type: Read/write

The maximum number of queued single object replication operations that should be attempted during each five minute interval of DNS server operation. The value MUST be limited to the range from 0x00000001 to 0x000F4240, inclusive. The default value MUST be 0x00000064.

MaximumRodcRsoQueueLength

Data type: uint32

Access type: Read/write

The maximum number of single object replication operations that may be queued at any given time by the DNS server. The value MUST be limited to the range from 0x00000000 to 0x000F4240, inclusive. If the value is 0x00000000 the DNS server MUST NOT enforce an upper bound on the number of single object replication operations queued at any given time. The default value MUST be 0x0000012C, and the value zero MUST be allowed.

MaximumSignatureScanPeriod

Data type: datetime

Access type: Read/write

The maximum period between zone scans to update DnsSec signatures for resource records.

MaximumTrustAnchorActiveRefreshInterval

Data type: datetime

Access type: Read/write

The maximum value for the active refresh interval for a trust anchor.

MaximumUdpPacketSize

Data type: uint32

Access type: Read-only

The maximum UDP packet size, in bytes, that the DNS server can accept. The value MUST be limited to 0x00000200 to 0x00004000.<138> The server MUST return an error if an attempt is made to change the value of this property through this protocol. This property may only be changed by modifying the value in persistent storage.

MaxResourceRecordsInNonSecureUpdate

Data type: uint32

Access type: Read/write

The maximum number of resource records that the DNS server will accept in a single DNS update request. The value SHOULD be limited to the range from 0x0000000A to 0x00000078, inclusive, but it MAY be any value. The default value SHOULD be 0x0000001E, and the value zero SHOULD be treated as a flag value for the default, but it MAY be allowed and treated literally.

MinorVersion

Data type: uint32

Access type: Read-only

The minor version of the OS of the DNS server.

NameCheckFlag

Data type: uint32

Access type: Read/write

Indicates the level of domain name checking and validation on the DNS server.

NoUpdateDelegations

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will accept DNS updates to delegation records of type NS.

OpenAclOnProxyUpdates

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server allows sharing of DNS records with the DnsUpdateProxy group when processing updates in secure zones that are stored in the directory service.

PublishAutoNet

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will publish local IPv4 addresses in the 169.254.x.x subnet as IPv4 addresses for the local machine's domain name.

QuietRecvFaultInterval

Data type: uint32

Access type: Read/write

A property used to debug reception of UDP traffic for a recursive query. This property is the minimum time interval, in seconds, starting when the server begins waiting for the query to arrive on the network, after which the server MAY log a debug message indicating that the server is to stop running. If the value is zero or is less than the value of QuietRecvLogInterval, then the value of QuietRecvLogInterval MUST be used. If the value is greater than or equal to the value of QuietRecvLogInterval, then the literal value of QuietRecvFaultInterval MUST be used. The value's range MUST be unlimited. The default value MUST be 0x00000000. The server MAY ignore this property.

QuietRecvLogInterval

Data type: uint32

Access type: Read/write

A property used to debug reception of UDP traffic for a recursive query. This property is the minimum time interval, in seconds, starting when the server begins waiting for the query to arrive on the network, or when the server logs an eponymous debug message for the query, after which the server MUST log a debug message indicating that the server is still waiting to receive network traffic. If the value is zero, logging associated with the two QuietRecv properties MUST be disabled, and the QuietRecvFaultInterval property MUST be ignored. If the value is non-zero, logging associated with the two QuietRecv properties MUST be enabled, and the QuietRecvFaultInterval property MUST NOT be ignored. The value's range MUST be unlimited. The default value MUST be 0x00000000. The server MAY ignore this property.

ReloadException

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will perform an internal restart if an unexpected fatal error is encountered.

RemoteIPv4RankBoost

Data type: uint32

Access type: Read/write

A value to add to all IPv4 addresses for remote DNS servers when selecting between IPv4 and IPv6 remote DNS server addresses. The value MUST be limited to the range from 0x00000000 to 0x0000000A, inclusive. The default value MUST be 0x00000000, and the value zero MUST be allowed and treated literally.

RemoteIPv6RankBoost

Data type: uint32

Access type: Read/write

A value to add to all IPv6 addresses for remote DNS servers when selecting between IPv4 and IPv6 remote DNS server addresses. The value MUST be limited to the range from 0x00000000 to 0x0000000A, inclusive. The default value MUST be 0x00000000, and the value zero MUST be allowed and treated literally.

RootTrustAnchorsURL

Data type: string

Access type: Read/write

The URL of the root trust anchor on the DNS server.

Windows Server 2012: Not supported.

RoundRobin

Data type: boolean

Access type: Read/write

true to enable Round-robin DNS on the DNS server; otherwise, false.

RpcProtocol

Data type: uint32

Access type: Read/write

The DNS_RPC_PROTOCOLS section 2.2.1.1.2 value corresponding to the RPC protocols to which the DNS server will respond. If this value is set to 0x00000000, the DNS server MUST NOT respond to RPC requests for any protocol. The value's range MUST be unlimited, for example, from 0x00000000 to 0xFFFFFFFF. The default value SHOULD be 0x00000005

ScopeOptionValue

Data type: uint32

Access type: Read/write

The extension mechanism for the DNS (ENDS0) scope setting on the DNS server.

Windows Server 2012 R2 and Windows Server 2012: Not supported.

SelfTest

Data type: uint32

Access type: Read/write

A mask value indicating whether data consistency checking should be performed once, each time the service starts. If the check fails, the server posts an event log warning. If the least significant bit (regardless of other bits) of this value is one, the DNS server will verify for each active and update-allowing primary zone, that the IP address records are present in the zone for the zone's SOA record's master server. If the least significant bit (regardless of other bits) of this value is zero, no data consistency checking will be performed. The value's range MUST be from 0x00000000 to 0xFFFFFFFF, inclusive. The default value MUST be 0xFFFFFFFF.

SendPort

Data type: uint32

Access type: Read/write

The port number to use as the source port when sending UDP queries to a remote DNS server. If set to zero, the DNS server MUST allow the stack to select a random port. The value's range MUST be unlimited. The default value MUST be 0x00000000, and the value zero MUST be allowed and treated literally.

ServerLevelPluginDll

Data type: string

Access type: Read/write

Specifies the path of a custom plug-in. When DllPath specifies the fully qualified path name of a valid DNS server plug-in, the DNS server calls functions in the plug-in to resolve name queries that are outside the scope of all locally hosted zones. If a queried name is out of the scope of the plug-in, the DNS server performs name resolution using forwarding or recursion, as configured. If DllPath is not specified, the DNS server ceases to use a custom plug-in if a custom plug-in was previously configured.

SilentlyIgnoreCNameUpdateConflicts

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will ignore CNAME conflicts during DNS update processing.

SocketPoolExcludedPortRanges

Data type: string array

Access type: Read/write

Excluded port ranges

SocketPoolSize

Data type: uint32

Access type: Read/write

The number of UDP sockets per address family that the DNS server will use for sending remote queries.

StrictFileParsing

Data type: boolean

Access type: Read/write

true to cache delegation information; otherwise, false.

A Boolean value indicating whether the DNS server will treat errors encountered while reading zones from a file as fatal.

SyncDsZoneSerial

Data type: uint32

Access type: Read/write

The conditions under which the DNS server should immediately commit uncommitted zone serial numbers to persistent storage. The value SHOULD be limited to the range from 0x00000000 to 0x00000004, inclusive, but it MAY be any value. The default value SHOULD be 0x00000002, and the value zero MUST be allowed and treated literally.

TcpReceivePacketSize

Data type: uint32

Access type: Read/write

The maximum TCP packet size, in bytes, that the DNS server can accept. The value MUST be limited to the range from 0x00004000 to 0x00010000, inclusive. Values outside of this range MUST cause the server to return an error. The default value MUST be 0x00010000.

UpdateOptions

Data type: uint32

Access type: Read/write

Indicates the DNS update options used by the DNS server.

VirtualizationInstanceOptionValue

Data type: uint32

Access type: Read/write

Virtualization instance option to be sent in ENDS0.

Windows Server 2012 R2 and Windows Server 2012: This property is not supported before Windows Server 2016.

WriteAuthorityNs

Data type: boolean

Access type: Read/write

A Boolean value indicating whether the DNS server will include NS records for the root of a zone in DNS responses that are answered using authoritative zone data.

XfrConnectTimeout

Data type: uint32

Access type: Read/write

Determines the time span, in seconds, in which a primary DNS server waits for a transfer response from its secondary server. The default value is "30". After the time-out value expires, the connection is terminated.

XfrThrottleMultiplier

Data type: uint32

Access type: Read/write

The multiple used to determine how long the DNS server should refuse zone transfer requests after a successful zone transfer has been completed. The total time for which a zone will refuse another zone transfer request at the end of a successful zone transfer is computed as this value multiplied by the number of seconds required for the zone transfer that just completed. The server SHOULD refuse zone transfer requests for no more than ten minutes. The value SHOULD be limited to the range from 0x00000000 to 0x00000064, inclusive, but it MAY be any value. The default value MUST be 0x0000000A, and the value zero MUST be allowed and treated literally.

ZoneWritebackInterval

Data type: datetime

Access type: Read/write

The zone write back interval for file backed zones.

Windows Server 2012: Not supported.

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2012
Namespace
 Root\Microsoft\Windows\Dns
MOF
DnsServerPSProvider.mof
DLL
DnsServerPSProvider.dll

See also

DnsServerPSProvider Provider