xDnsServer
2.0.0
This module contains DSC resources for the management and configuration of Windows Server DNS Server.
Minimum PowerShell version
5.0
Installation Options
Owners
Copyright
Copyright the DSC Community contributors. All rights reserved.
Package Details
Author(s)
- DSC Community
Tags
DesiredStateConfiguration DSC DSCResourceKit DSCResource
DSCResources
DnsRecordSrv DnsRecordSrvScoped xDnsRecord xDnsRecordMx xDnsServerADZone xDnsServerClientSubnet xDnsServerConditionalForwarder xDnsServerDiagnostics xDnsServerForwarder xDnsServerPrimaryZone xDnsServerRootHint xDnsServerSecondaryZone xDnsServerSetting xDnsServerZoneAging xDnsServerZoneScope xDnsServerZoneTransfer DnsRecordCname DnsRecordPtr DnsRecordA DnsRecordAaaa DnsRecordCnameScoped DnsRecordMx DnsServerEDns DnsServerScavenging DnsRecordAaaaScoped DnsRecordAScoped DnsRecordMxScoped
Dependencies
This module has no dependencies.
Release Notes
## [2.0.0] - 2021-03-26
### Deprecated
- **The module _xDnsServer_ will be renamed _DnsServerDsc_. Version `2.0.0`
will be the the last release of _xDnsServer_. Version `3.0.0` will be
release as _DnsServerDsc_, it will be released shortly after the `2.0.0`
release** ([issue #179](https://github.com/dsccommunity/xDnsServer/issues/179)).
The prefix 'x' will be removed from all resources in _DnsServerDsc_.
- xDnsRecord will be removed in the next release (of DnsServerDsc) ([issue #220](https://github.com/dsccommunity/xDnsServer/issues/220)).
Start migrate to the resources _DnsRecord*_.
- xDnsRecordMx will be removed in the next release (of DnsServerDsc) ([issue #228](https://github.com/dsccommunity/xDnsServer/issues/228)).
Start migrate to the resources _DnsRecordMx_.
- The properties `DefaultAgingState`, `ScavengingInterval`, `DefaultNoRefreshInterval`,
and `DefaultRefreshInterval` will be removed from the resource xDnsServerSetting
in the next release (of DnsServerDsc) ([issue #193](https://github.com/dsccommunity/xDnsServer/issues/193)).
Migrate to use the resource _DnsServerScavenging_ to enforce these properties.
- The properties `EnableEDnsProbes` and `EDnsCacheTimeout` will be removed from
the resource xDnsServerSetting in the next release (of DnsServerDsc) ([issue #195](https://github.com/dsccommunity/xDnsServer/issues/195)).
Migrate to use the resource _DnsServerEDns_ to enforce these properties.
- The properties `Forwarders` and `ForwardingTimeout` will be removed from the
resource xDnsServerSetting in the next release (of DnsServerDsc) ([issue #192](https://github.com/dsccommunity/xDnsServer/issues/192))
Migrate to use the resource _xDnsServerForwarder_ to enforce these properties.
### Added
- xDnsServer
- Added automatic release with a new CI pipeline.
- Add unit tests for the Get-LocalizedData, NewTerminatingError, and
Assert-Module helper functions.
- Added description README files for each resource.
- Add example files for resources
- OptIn to the following Dsc Resource Meta Tests:
- Common Tests - Validate Localization
- Common Tests - Validate Example Files To Be Published
- Standardize Resource Localization.
- Added the build task `Publish_GitHub_Wiki_Content` to publish content
to the GitHub repository wiki.
- Added new source folder `WikiSource` which content will be published
to the GitHub repository wiki.
- Add the markdown file `Home.md` which will be automatically updated
with the latest version before published to GitHub repository wiki.
- Updated the prerequisites in the GitHub repository wiki (`Home.md`)
that _Microsoft DNS Server_ is required on a node targeted by a resource,
and that the DSC resources requires the [DnsServer](https://docs.microsoft.com/en-us/powershell/module/dnsserver)
PowerShell module ([issue #37](https://github.com/dsccommunity/xDnsServer/issues/37)).
- Added the base class `ResourcePropertiesBase` to hold DSC properties that
can be inherited for all class-based resources.
- Added the base class `ResourceBase` to hold methods that should be
inherited for all class-based resources.
- Added new private function `ConvertTo-TimeSpan` to help when evaluating
properties that must be passed as strings and then converted to `[System.TimeSpan]`.
- Added new private function `Assert-TimeSpan` to help assert that a value
provided in a resource can be converted to a `[System.TimeSpan]` and
optionally evaluates so it is not below a minium value or over a maximum
value.
- Added `prefix.ps1` that is used to import dependent modules like _DscResource.Common_.
- Added new resource
- _DnsServerScavenging_ - resource to enforce scavenging settings ([issue #189](https://github.com/dsccommunity/xDnsServer/issues/189)).
- _DnsServerEDns_ - resource to enforce extension mechanisms for DNS
(EDNS) settings ([issue #194](https://github.com/dsccommunity/xDnsServer/issues/194)).
- xDNSServerClientSubnet
- Added integration tests.
- xDnsServerPrimaryZone
- Added integration tests ([issue #173](https://github.com/dsccommunity/xDnsServer/issues/173)).
- Added more examples.
- xDnsRecordMx
- Added new resource to manage MX records
- xDnsServerZoneScope
- Added integration tests ([issue #177](https://github.com/dsccommunity/xDnsServer/issues/177)).
- New read-only property `ZoneFile` was added to return the zone scope
file name used for the zone scope.
- xDnsServerZoneAging
- Added integration tests ([issue #176](https://github.com/dsccommunity/xDnsServer/issues/176)).
- xDnsServerForwarder
- Added integration tests ([issue #170](https://github.com/dsccommunity/xDnsServer/issues/170)).
- Added new properties `Timeout` and `EnableReordering` ([issue #191](https://github.com/dsccommunity/xDnsServer/issues/191)).
- xDnsServerRootHint
- Added integration tests ([issue #174](https://github.com/dsccommunity/xDnsServer/issues/174)).
- Added a class `DnsRecordBase` that is used as the base class for the resources that create DNS records.
- Added unit tests to get code coverage on unimplemented method calls (ensuring the `throw` statements get called)
- DnsRecordSrv
- Added new resource to manage SRV records
- DnsRecordSrvScoped
- Added new resource to manage scoped SRV records
- DnsRecordA
- Added new resource to manage A records
- DnsRecordAScoped
- Added new resource to manage scoped A records
- DnsRecordAaaa
- Added new resource to manage AAAA records
- DnsRecordAaaaScoped
- Added new resource to manage scoped AAAA records
- DnsRecordCname
- Added new resource to manage CNAME records
- DnsRecordCnameScoped
- Added new resource to manage scoped CNAME records
- DnsRecordPtr
- Added new resource to manage PTR records
- DnsRecordMx
- Added new resource to manage MX records
- DnsRecordMxScoped
- Added new resource to manage scoped MX records
### Changed
- xDnsServer
- BREAKING CHANGE: Set the minimum required PowerShell version to 5.0 to support classes used in the DnsRecordBase-derived resources.
- Resolve style guideline violations for hashtables
- Update pipeline files.
- Renamed the default branch to `main` ([issue #131](https://github.com/dsccommunity/xDnsServer/issues/131)).
- Uses `PublishPipelineArtifact` in _Azure Pipelines_ pipeline.
- Unit tests are now run in PowerShell 7 in the _Azure Pipelines_
pipeline ([issue #160](https://github.com/dsccommunity/xDnsServer/issues/160)).
- Merged the historic changelog into CHANGELOG.md ([issue #163](https://github.com/dsccommunity/xDnsServer/issues/163)).
- Only add required role in integration tests pipeline.
- Updated the pipeline to use new deploy tasks.
- Revert back to using the latest version of module Sampler for the pipeline ([issue #211](https://github.com/dsccommunity/xDnsServer/issues/211)).
- Fixed the sections in the GitHub issue and pull request templates to
have a bit higher font size. This makes it easier to distinguish the
section headers from the text.
- DnsRecordBase
- Changed class to inherit properties from 'ResourcePropertiesBase`.
- xDnsRecordSrv
- Now uses `[CimInstance]::new()` both in the resource code and the resource
unit test to clone the existing DNS record instead of using the method
`Clone()` that does not exist in PowerShell 7.
- xDnsServerSetting
- BREAKING CHANGE: The mandatory parameter was replaced by the mandatory
parameter `DnsServer`. This prevents the resource from being used twice
in the same configuration using the same value for the parameter `DnsServer`
([issue #156](https://github.com/dsccommunity/xDnsServer/issues/156)).
- xDnsServerDiagnostics
- BREAKING CHANGE: The mandatory parameter was replaced by the mandatory
parameter `DnsServer`. This prevents the resource from being used twice
in the same configuration using the same value for the parameter `DnsServer`
([issue #157](https://github.com/dsccommunity/xDnsServer/issues/157)).
- xDnsServerPrimaryZone
- Now the property `Name` is always returned from `Get-TargetResource`
since it is a `Key` property.
- xDnsServerForwarder
- When providing an empty collection the resource will enforce that no
forwarders are present.
- DnsRecordSrv
- Changed logic for calculating the record's hostname
### Removed
- xDnsServer
- BREAKING CHANGE: The DSC resource xDnsARecord was removed and are replaced
by the DSC resource xDnsRecord.
- Removing resource parameter information from README.md in favor of
GitHub repository wiki.
- Remove helper function `Remove-CommonParameter` in favor of the one in
module _DscResource.Common_ ([issue #166](https://github.com/dsccommunity/xDnsServer/issues/166)).
- Remove helper function `ConvertTo-CimInstance` in favor of the one in
module _DscResource.Common_ ([issue #167](https://github.com/dsccommunity/xDnsServer/issues/167)).
- Remove helper function `ConvertTo-HashTable` in favor of the one in
module _DscResource.Common_ ([issue #168](https://github.com/dsccommunity/xDnsServer/issues/168)).
- xDnServerSetting
- BREAKING CHANGE: The properties `LogIPFilterList`, `LogFilePath`, `LogFileMaxSize`,
and `EventLogLevel` have been removed. Use the resource _xDnsServerDiagnostics_
with the properties `FilterIPAddressList`, `LogFilePath`, `MaxMBFileSize`,
and `EventLogLevel` respectively to enforce these settings ([issue #190](https://github.com/dsccommunity/xDnsServer/issues/190)).
This is done in preparation to support more settings through the cmdlet
`Get-DnsServerSetting` for the resource _xDnServerSetting_, and these
values are not available through that cmdlet.
### Fixed
- xDnsServer
- Enable Unit Tests to be run locally.
- Rename integr
FileList
- xDnsServer.nuspec
- xDnsServer.psm1
- xDnsServer.psd1
- en-US\about_xDnsServer.help.txt
- en-US\DnsRecordSrvScoped.strings.psd1
- en-US\DnsServerScavenging.strings.psd1
- en-US\DnsRecordA.strings.psd1
- en-US\about_DnsServerEDns.help.txt
- en-US\DnsRecordBase.strings.psd1
- en-US\DnsRecordSrv.strings.psd1
- en-US\about_DnsRecordPtr.help.txt
- en-US\about_DnsRecordAScoped.help.txt
- en-US\DnsRecordAaaaScoped.strings.psd1
- en-US\about_DnsRecordA.help.txt
- en-US\DnsRecordAaaa.strings.psd1
- en-US\DnsRecordCnameScoped.strings.psd1
- en-US\about_DnsRecordCname.help.txt
- en-US\ResourcePropertiesBase.strings.psd1
- en-US\DnsServerEDns.strings.psd1
- en-US\about_DnsRecordAaaaScoped.help.txt
- en-US\about_DnsRecordMx.help.txt
- en-US\about_DnsRecordCnameScoped.help.txt
- en-US\about_DnsRecordSrv.help.txt
- en-US\about_DnsRecordMxScoped.help.txt
- en-US\about_DnsRecordAaaa.help.txt
- en-US\DnsRecordMxScoped.strings.psd1
- en-US\about_DnsServerScavenging.help.txt
- en-US\about_DnsRecordSrvScoped.help.txt
- en-US\DnsRecordCname.strings.psd1
- en-US\DnsRecordAScoped.strings.psd1
- en-US\DnsRecordMx.strings.psd1
- en-US\xDnsServer.strings.psd1
- en-US\DnsRecordPtr.strings.psd1
- DSCResources\MSFT_xDnsServerADZone\MSFT_xDnsServerADZone.schema.mof
- DSCResources\MSFT_xDnsServerADZone\MSFT_xDnsServerADZone.psm1
- DSCResources\MSFT_xDnsServerADZone\README.md
- DSCResources\MSFT_xDnsServerSetting\MSFT_xDnsServerSetting.psm1
- DSCResources\MSFT_xDnsServerSetting\MSFT_xDnsServerSetting.schema.mof
- DSCResources\MSFT_xDnsServerSetting\README.md
- DSCResources\MSFT_xDnsRecordMx\MSFT_xDnsRecordMx.schema.mof
- DSCResources\MSFT_xDnsRecordMx\MSFT_xDnsRecordMx.psm1
- DSCResources\MSFT_xDnsRecordMx\README.md
- DSCResources\MSFT_xDnsServerSecondaryZone\MSFT_xDnsServerSecondaryZone.schema.mof
- DSCResources\MSFT_xDnsServerSecondaryZone\MSFT_xDnsServerSecondaryZone.psm1
- DSCResources\MSFT_xDnsServerSecondaryZone\README.md
- DSCResources\MSFT_xDnsServerZoneTransfer\MSFT_xDnsServerZoneTransfer.psm1
- DSCResources\MSFT_xDnsServerZoneTransfer\MSFT_xDnsServerZoneTransfer.schema.mof
- DSCResources\MSFT_xDnsServerZoneTransfer\README.md
- DSCResources\MSFT_xDnsServerDiagnostics\MSFT_xDnsServerDiagnostics.psm1
- DSCResources\MSFT_xDnsServerDiagnostics\MSFT_xDnsServerDiagnostics.schema.mof
- DSCResources\MSFT_xDnsServerDiagnostics\README.md
- DSCResources\MSFT_xDnsRecord\MSFT_xDnsRecord.psm1
- DSCResources\MSFT_xDnsRecord\MSFT_xDnsRecord.schema.mof
- DSCResources\MSFT_xDnsRecord\README.md
- DSCResources\MSFT_xDnsServerZoneAging\MSFT_xDnsServerZoneAging.psm1
- DSCResources\MSFT_xDnsServerZoneAging\MSFT_xDnsServerZoneAging.schema.mof
- DSCResources\MSFT_xDnsServerZoneAging\README.md
- DSCResources\MSFT_xDnsServerClientSubnet\MSFT_xDnsServerClientSubnet.psm1
- DSCResources\MSFT_xDnsServerClientSubnet\MSFT_xDnsServerClientSubnet.schema.mof
- DSCResources\MSFT_xDnsServerClientSubnet\README.md
- DSCResources\MSFT_xDnsServerPrimaryZone\MSFT_xDnsServerPrimaryZone.schema.mof
- DSCResources\MSFT_xDnsServerPrimaryZone\MSFT_xDnsServerPrimaryZone.psm1
- DSCResources\MSFT_xDnsServerPrimaryZone\README.md
- DSCResources\MSFT_xDnsServerConditionalForwarder\MSFT_xDnsServerConditionalForwarder.psm1
- DSCResources\MSFT_xDnsServerConditionalForwarder\MSFT_xDnsServerConditionalForwarder.schema.mof
- DSCResources\MSFT_xDnsServerConditionalForwarder\README.md
- DSCResources\MSFT_xDnsServerZoneScope\MSFT_xDnsServerZoneScope.psm1
- DSCResources\MSFT_xDnsServerZoneScope\MSFT_xDnsServerZoneScope.schema.mof
- DSCResources\MSFT_xDnsServerZoneScope\README.md
- DSCResources\MSFT_xDnsServerRootHint\MSFT_xDnsServerRootHint.psm1
- DSCResources\MSFT_xDnsServerRootHint\MSFT_xDnsServerRootHint.schema.mof
- DSCResources\MSFT_xDnsServerRootHint\README.md
- DSCResources\MSFT_xDnsServerForwarder\MSFT_xDnsServerForwarder.schema.mof
- DSCResources\MSFT_xDnsServerForwarder\MSFT_xDnsServerForwarder.psm1
- DSCResources\MSFT_xDnsServerForwarder\README.md
- Modules\DnsServerDsc.Common\DnsServerDsc.Common.psd1
- Modules\DnsServerDsc.Common\DnsServerDsc.Common.psm1
- DSCResources\MSFT_xDnsServerADZone\en-US\about_xDnsServerADZone.help.txt
- DSCResources\MSFT_xDnsServerADZone\en-US\MSFT_xDnsServerADZone.strings.psd1
- DSCResources\MSFT_xDnsServerSetting\en-US\MSFT_xDnsServerSetting.strings.psd1
- DSCResources\MSFT_xDnsServerSetting\en-US\about_xDnsServerSetting.help.txt
- DSCResources\MSFT_xDnsRecordMx\en-US\about_xDnsRecordMx.help.txt
- DSCResources\MSFT_xDnsRecordMx\en-US\MSFT_xDnsRecordMx.strings.psd1
- DSCResources\MSFT_xDnsServerSecondaryZone\en-US\MSFT_xDnsServerSecondaryZone.strings.psd1
- DSCResources\MSFT_xDnsServerSecondaryZone\en-US\about_xDnsServerSecondaryZone.help.txt
- DSCResources\MSFT_xDnsServerZoneTransfer\en-US\about_xDnsServerZoneTransfer.help.txt
- DSCResources\MSFT_xDnsServerZoneTransfer\en-US\MSFT_xDnsServerZoneTransfer.strings.psd1
- DSCResources\MSFT_xDnsServerDiagnostics\en-US\about_xDnsServerDiagnostics.help.txt
- DSCResources\MSFT_xDnsServerDiagnostics\en-US\MSFT_xDnsServerDiagnostics.strings.psd1
- DSCResources\MSFT_xDnsRecord\en-US\about_xDnsRecord.help.txt
- DSCResources\MSFT_xDnsRecord\en-US\MSFT_xDnsRecord.strings.psd1
- DSCResources\MSFT_xDnsServerZoneAging\en-US\MSFT_xDnsServerZoneAging.strings.psd1
- DSCResources\MSFT_xDnsServerZoneAging\en-US\about_xDnsServerZoneAging.help.txt
- DSCResources\MSFT_xDnsServerClientSubnet\en-US\about_xDnsServerClientSubnet.help.txt
- DSCResources\MSFT_xDnsServerClientSubnet\en-US\MSFT_xDnsServerClientSubnet.strings.psd1
- DSCResources\MSFT_xDnsServerPrimaryZone\en-US\MSFT_xDnsServerPrimaryZone.strings.psd1
- DSCResources\MSFT_xDnsServerPrimaryZone\en-US\about_xDnsServerPrimaryZone.help.txt
- DSCResources\MSFT_xDnsServerConditionalForwarder\en-US\MSFT_xDnsServerConditionalForwarder.strings.psd1
- DSCResources\MSFT_xDnsServerConditionalForwarder\en-US\about_xDnsServerConditionalForwarder.help.txt
- DSCResources\MSFT_xDnsServerZoneScope\en-US\about_xDnsServerZoneScope.help.txt
- DSCResources\MSFT_xDnsServerZoneScope\en-US\MSFT_xDnsServerZoneScope.strings.psd1
- DSCResources\MSFT_xDnsServerRootHint\en-US\about_xDnsServerRootHint.help.txt
- DSCResources\MSFT_xDnsServerRootHint\en-US\MSFT_xDnsServerRootHint.strings.psd1
- DSCResources\MSFT_xDnsServerForwarder\en-US\about_xDnsServerForwarder.help.txt
- DSCResources\MSFT_xDnsServerForwarder\en-US\MSFT_xDnsServerForwarder.strings.psd1
- Modules\DnsServerDsc.Common\en-US\DnsServerDsc.Common.strings.psd1
- Modules\DscResource.Common\0.10.2\DscResource.Common.psm1
- Modules\DscResource.Common\0.10.2\DscResource.Common.psd1
- Modules\DscResource.Common\0.10.2\en-US\DscResource.Common.strings.psd1
- Modules\DscResource.Common\0.10.2\en-US\about_DscResource.Common.help.txt
Version History
Version | Downloads | Last updated |
---|---|---|
2.0.0 (current version) | 2,370,055 | 3/26/2021 |
2.0.0-previe... | 22 | 3/26/2021 |
2.0.0-previe... | 21 | 3/26/2021 |
2.0.0-previe... | 23 | 3/23/2021 |
2.0.0-previe... | 18 | 3/23/2021 |
2.0.0-previe... | 41 | 2/28/2021 |
2.0.0-previe... | 18 | 2/28/2021 |
2.0.0-previe... | 18 | 2/28/2021 |
2.0.0-previe... | 23 | 2/20/2021 |
2.0.0-previe... | 18 | 2/20/2021 |
2.0.0-previe... | 18 | 2/20/2021 |
2.0.0-previe... | 23 | 2/17/2021 |
2.0.0-previe... | 20 | 2/17/2021 |
2.0.0-previe... | 21 | 2/16/2021 |
2.0.0-previe... | 32 | 1/30/2021 |
2.0.0-previe... | 162 | 3/14/2020 |
1.16.0.0 | 1,033,201 | 10/30/2019 |
1.15.0.0 | 25,110 | 9/19/2019 |
1.14.0.0 | 13,206 | 8/8/2019 |
1.13.0.0 | 14,469 | 6/26/2019 |
1.12.0.0 | 16,875 | 5/15/2019 |
1.11.0.0 | 85,008 | 6/13/2018 |
1.10.0.0 | 3,137 | 5/2/2018 |
1.9.0.0 | 16,016 | 11/15/2017 |
1.8.0.0 | 1,772 | 8/23/2017 |
1.7.0.0 | 29,033 | 5/18/2016 |
1.6.0.0 | 558 | 3/31/2016 |
1.5.0.0 | 575 | 2/3/2016 |
1.4.0.0 | 262 | 12/3/2015 |
1.3.0.0 | 206 | 10/22/2015 |
1.2.0.0 | 774 | 9/11/2015 |
1.1 | 380 | 5/2/2015 |
1.0 | 257 | 6/6/2014 |