Note: This article contains references to the term slave—a term that Microsoft doesn't condone, and has stopped using in new products and documentation. When the term is removed from the software, we’ll remove it from this article.
Note: This article contains references to the term master server—a term that Microsoft doesn't condone, and has stopped using in new products and documentation. When the term is removed from the software, we’ll remove it from this article.
The MicrosoftDNS_Zone class describes a DNS Zone. Every instance of the MicrosoftDNS_Zone class must be assigned to exactly one DNS Server. Zones may be associated with multiple instances of MicrosoftDNS_Domain or MicrosoftDNS_ResourceRecord classes.
The following syntax is simplified from MOF code.
Syntax
class MicrosoftDNS_Zone : MicrosoftDNS_Domain
{
uint32 ZoneType;
boolean DsIntegrated;
uint32 AllowUpdate;
string DataFile;
boolean DisableWINSRecordReplication;
uint32 Notify;
uint32 SecureSecondaries;
boolean Paused;
boolean Shutdown;
boolean Reverse;
boolean AutoCreated;
boolean UseWins;
boolean UseNBStat;
boolean Aging;
uint32 RefreshInterval;
uint32 NoRefreshInterval;
uint32 AvailForScavengeTime;
string MasterServers[];
string LocalMasterServers[];
string ScavengeServers[];
string SecondaryServers[];
string NotifyServers[];
uint32 ForwarderTimeout;
boolean ForwarderSlave;
uint32 LastSuccessfulSoaCheck;
uint32 LastSuccessfulXfr;
};
Members
The MicrosoftDNS_Zone class has these types of members:
Methods
The MicrosoftDNS_Zone class has these methods.
| Method | Description |
|---|---|
| AgeAllRecords | Enables aging for some or all non-NS and non-SOA records. |
| ChangeZoneType | Changes zone types. Qualifiers: Implemented |
| CreateZone | Creates a new zone. Qualifiers: None. |
| ForceRefresh | Forces an update of the secondary from the Master DNS Server. Qualifiers: Implemented |
| GetDistinguishedName | Obtains DS distinguished Name for the zone. Qualifiers: Implemented |
| PauseZone | Pauses the Zone. Qualifiers: Implemented |
| ReloadZone | Reloads the Zone. Qualifiers: Implemented |
| ResetSecondaries | Resets the secondary ip address array. Qualifiers: Implemented |
| ResumeZone | Resumes the Zone. Qualifiers: Implemented |
| UpdateFromDS | Forces an update of the Zone from the Directory Service (DS). For this method to be valid, the ZoneType must be 0 the Zone must indeed be stored in the DS. Qualifiers: Implemented |
| WriteBackZone | Saves Zone data to its zone file. Qualifiers: Implemented, static |
Properties
The MicrosoftDNS_Zone class has these properties.
Aging
Data type: boolean
Access type: Read-only
Specifies the aging and scavenging behavior of the zone. Zero indicates scavenging is disabled. When scavenging is disabled, the timestamps of records in the zone are not refreshed, and the records are not subjected to scavenging. When set to one, records are subjected to scavenging and their timestamps are refreshed when the server receives the dynamic update request for the records. For Active Directory-integrated zones, this value is set to the DefaultAgingState property of the DNS Server where the zone is created. For standard primary zones, the default value is zero.
AllowUpdate
Data type: uint32
Access type: Read-only
Indicates whether the Zone accepts dynamic update requests.
AutoCreated
Data type: boolean
Access type: Read-only
Indicates whether the Zone is autocreated.
AvailForScavengeTime
Data type: uint32
Access type: Read-only
Specifies the time when the server may attempt scavenging the zone. Even if the zone is configured to enable scavenging the DNS server will not attempt scavenging this zone until after this moment. This value is set to the current time plus the Refresh Interval of the zone whenever the zone is loaded. This parameter is stored locally, and is not replicated to other copies of the zone.
DataFile
Data type: string
Access type: Read-only
Indicates the name of the zone file.
DisableWINSRecordReplication
Data type: boolean
Access type: Read-only
Indicates whether the WINS record is replicated. If set to TRUE, WINS record replication is disabled.
DsIntegrated
Data type: boolean
Access type: Read-only
Specifies whether the zone is DS integrated.
ForwarderSlave
Data type: boolean
Access type: Read-only
Indicates whether the DNS uses recursion when resolving the names for the specified forward zone. Applicable to Conditional Forwarding zones only.
ForwarderTimeout
Data type: uint32
Access type: Read-only
Indicates the time, in seconds, a DNS server forwarding a query for the name under the forward zone waits for resolution from the forwarder before attempting to resolve the query itself. This parameter is applicable to the Forward zones only.
LastSuccessfulSoaCheck
Data type: uint32
Access type: Read-only
Number of seconds since the beginning of January 1, 1970 GMT, since the SOA serial number for the zone was last checked.
LastSuccessfulXfr
Data type: uint32
Access type: Read-only
Number of seconds since the beginning of January 1, 1970 GMT, since the zone was last transferred from a master server.
LocalMasterServers
Data type: string array
Access type: Read-only
Local IP addresses of the master DNS servers for this zone. If set, these masters over-ride the MasterServers found in Active Directory.
MasterServers
Data type: string array
Access type: Read-only
IP addresses of the master DNS servers for this zone.
NoRefreshInterval
Data type: uint32
Access type: Read-only
Specifies the time interval between the last update of a record's timestamp and the earliest moment when the timestamp can be refreshed.
Notify
Data type: uint32
Access type: Read-only
Indicates whether the master Zone notifies secondaries of any changes in its RRs database. Set to 1 to notify secondaries.
NotifyServers
Data type: string array
Access type: Read-only
Array of strings enumerating IP addresses of DNS servers to be notified of changes in this zone.
Paused
Data type: boolean
Access type: Read-only
Indicates whether the Zone is paused.
RefreshInterval
Data type: uint32
Access type: Read-only
Specifies the refresh interval, during which the records with nonzero timestamp are expected to be refreshed to remain in the zone. Records that have not been refreshed by expiration of the Refresh interval could be removed by the next scavenging performed by a server. This value should never be less than the longest refresh period of the records registered in the zone. Values that are too small may lead to removal of valid DNS records. values that are too large prolong the lifetime of stale records. This value is set to the DefaultRefreshInterval property of the DNS server where the zone is created.
Reverse
Data type: boolean
Access type: Read-only
Indicates whether the Zone is reverse (TRUE) or forward (FALSE).
ScavengeServers
Data type: string array
Access type: Read-only
Array of strings that enumerates the list of IP addresses of DNS servers that are allowed to perform scavenging of stale records of this zone. If the list is not specified, any primary DNS server authoritative for the zone is allowed to scavenge the zone when other prerequisites are met.
SecondaryServers
Data type: string array
Access type: Read-only
Array of strings enumerating IP addresses of DNS servers allowed to receive this zone through zone replication.
SecureSecondaries
Data type: uint32
Access type: Read-only
Indicates whether zone transfer is allowed to designated secondaries only. Designated secondaries are DNS Servers whose IP addresses are listed in SecondariesIPAddressesArray.
Shutdown
Data type: boolean
Access type: Read-only
Indicates whether the copy of the Zone is expired. If TRUE, the Zone is expired, or shut down.
UseNBStat
Data type: boolean
Access type: Read-only
This Boolean indicates whether the Zone uses NBStat reverse lookup.
UseWins
Data type: boolean
Access type: Read-only
Indicates whether the Zone uses WINS look up.
ZoneType
Data type: uint32
Access type: Read-only
Indicates the type of the Zone. Valid values are:
- DS integrated
- Primary
- Secondary
**Windows Server 2003: **
Additional values:
- Cache
- Stub
- Forwarder
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | None supported |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Namespace | Root\MicrosoftDNS |
| MOF | Dnsprov.mof |
See also
AgeAllRecords Method of the MicrosoftDNS_Zone Class
ChangeZoneType Method of the MicrosoftDNS_Zone Class
CreateZone Method of the MicrosoftDNS_Zone Class
ForceRefresh Method of the MicrosoftDNS_Zone Class
GetDistinguishedName Method of the MicrosoftDNS_Zone Class
PauseZone Method of the MicrosoftDNS_Zone Class
ReloadZone Method of the MicrosoftDNS_Zone Class
ResetSecondaries Method of the MicrosoftDNS_Zone Class
ResumeZone Method of the MicrosoftDNS_Zone Class
UpdateFromDS Method of the MicrosoftDNS_Zone Class
WriteBackZone Method of the MicrosoftDNS_Zone Class
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
