This is our biggest release yet!
It takes the records for the most merged pull requests in a release and the most modules we have ever released at once from GitHub!
This release includes updates to 27 DSC resource modules. In the past 6 weeks, 165 pull requests have been merged and 115 issues have been closed, all thanks to our amazing community!
The modules updated in this release are:
ActiveDirectoryCSDsc
AuditPolicyDsc
CertificateDsc
ComputerManagementDsc
DFSDsc
NetworkingDsc (previously xNetworking)
SecurityPolicyDsc
SharePointDsc
SqlServerDsc
xActiveDirectory
xBitlocker
xDatabase
xDhcpServer
xDismFeature
xDnsServer
xDscDiagnostics
xDSCResourceDesigner
xExchange
xHyper-V
xPowerShellExecutionPolicy
xPSDesiredStateConfiguration
xRemoteDesktopSessionHost
xSCSMA
xSystemSecurity
xTimeZone (deprecated since now included in ComputerManagementDsc)
xWebAdministration
xWinEventLog
For a detailed list of the resource modules and fixes in this release, see the Included in this Release section below.
Our last community call for the DSC Resource Kit was on June 6. A recording of our updates is available on YouTube here. Join us for the next call at 12PM (Pacific time) on July 18 to ask questions and give feedback about your experience with the DSC Resource Kit.
We strongly encourage you to update to the newest version of all modules using the PowerShell Gallery, and don’t forget to give us your feedback in the comments below, on GitHub, or on Twitter (@PowerShell_Team)!
Please see our documentation here for information on the support of these resource modules.
Included in this Release
You can see a detailed summary of all changes included in this release in the table below. For past release notes, go to the README.md or Changelog.md file on the GitHub repository page for a specific module (see the How to Find DSC Resource Modules on GitHub section below for details on finding the GitHub page for a specific module).
Module Name
Version
Release Notes
ActiveDirectoryCSDsc
3.0.0.0
Changed Assert-VerifiableMocks to be Assert-VerifiableMock to meet Pester standards.
Updated license year in LICENSE.MD and module manifest to 2018.
Removed requirement for Pester maximum version 4.0.8.
Added new resource EnrollmentPolicyWebService – see issue 43.
BREAKING CHANGE: New Key for AdcsCertificationAuthority, IsSingleInstance – see issue 47.
Added:
MSFT_xADCSOnlineResponder resource to install the Online Responder service.
Corrected filename of MSFT_AdcsCertificationAuthority integration test file.
AuditPolicyDsc
1.2.0.0
Moved auditpol call in the helper module to an external process to better control output
auditpol output is now converted to CSV to remove the need to parse the text output
All resources have been updated to use the new helper module functionality
Added the Ensure parameter default value of Present to the AuditPolicySubcategory resource Test-TargetResource function
CertificateDsc
4.1.0.0
PfxImport:
Changed so that PFX will be reimported if private key is not installed – fixes Issue 129.
Refactored to remove code duplication by creating Get-CertificateStorePath.
Improved unit tests to meet standards and provide better coverage.
Improved integration tests to meet standards and provide better coverage.
CertificateDsc.Common:
Corrected to meet style guidelines.
Added function Get-CertificateStorePath for generating Certificate Store path.
Remove false verbose message from Test-Thumbprint – fixes Issue 127.
CertReq:
Added detection for FIPS mode in Test-Thumbprint – fixes Issue 107.
ComputerManagementDsc
5.1.0.0
TimeZone:
Migrated xTimeZone resource from xTimeZone and renamed to TimeZone – fixes Issue 157.
Moved Test-Command from ComputerManagementDsc.ResourceHelper to ComputerManagementDsc.Common module to match what TimeZone requires. It was not exported in ComputerManagementDsc.ResourceHelper and not used.
DFSDsc
4.1.0.0
Added Hub and Spoke replication group example – fixes Issue 62.
Allow null values in resource group members or folders – fixes Issue 27.
Added a CODE_OF_CONDUCT.md with the same content as in the README.md – fixes Issue 67.
NetworkingDsc
(previously xNetworking)
6.0.0.0
New Example 2-ConfigureSuffixSearchList.ps1 for multiple SuffixSearchList entries for resource DnsClientGlobalSetting.
BREAKING CHANGE:
Renamed xNetworking to NetworkingDsc – fixes Issue 119.
Changed all MSFT_xResourceName to MSFT_ResourceName.
Updated DSCResources, Examples, Modules and Tests with new naming.
Updated Year to 2018 in License and Manifest.
Updated README.md from xNetworking to NetworkingDsc.
MSFT_IPAddress:
Updated to allow setting multiple IP Addresses when one is already set – Fixes Issue 323
Corrected CHANGELOG.MD to report that issue with InterfaceAlias matching on Adapter description rather than Adapter Name was released in 5.7.0.0 rather than 5.6.0.0 – See Issue 315.
MSFT_WaitForNetworkTeam:
Added a new resource to set the wait for a network team to become “Up”.
MSFT_NetworkTeam:
Improved detection of environmemt for running network team integration tests.
MSFT_NetworkTeamInterface:
Improved detection of environmemt for running network team integration tests.
Added a CODE_OF_CONDUCT.md with the same content as in the README.md – fixes Issue 337.
SecurityPolicyDsc
2.3.0.0
Updated documentation.
Add example of applying Kerberos policies
Added hyper links to readme
Refactored the SID translation process to not throw a terminating error when called from Test-TargetResource
Updated verbose message during the SID transliation process to identiy the policy where an orphaned SID exists
SharePointDsc
2.3.0.0
Changes to SharePointDsc
Added a Branches section to the README.md with Codecov and build badges for both master and dev branch.
All Resources
Added information about the Resource Type in each ReadMe.md files.
SPFarm
Fixed issue where the resource throws an exception if the farm already exists and the server has been joined using the FQDN (issue 795)
SPTimerJobState
Fixed issue where the Set method for timerjobs deployed to multiple web applications failed.
SPTrustedIdentityTokenIssuerProviderRealms
Added the resource.
SPUserProfileServiceApp
Now supported specifying the host Managed path, and properly sets the host.
Changed error for running with Farm Account into being a warning
SPUserProfileSyncConnection
Added support for filtering disabled users
Fixed issue where UseSSL was set to true resulted in an error
Fixed issue where the connection was recreated when the name contained a dot (SP2016)
SqlServerDsc
11.3.0.0
Changes to SqlServerDsc
Moved decoration for integration test to resolve a breaking change in DscResource.Tests.
Activated the GitHub App Stale on the GitHub repository.
Added a CODE_OF_CONDUCT.md with the same content as in the README.md issue 939.
Activated the GitHub App Stale on the GitHub repository.
The resources are now in alphabetical order in the README.md (issue 194).
Adding a Branches section to the README.md with Codecov badges for both master and dev branch (issue 192).
xADGroup no longer resets GroupScope and Category to default values (issue 183).
The helper function script file MSFT_xADCommon.ps1 was renamed to MSFT_xADCommon.psm1 to be a module script file instead. This makes it possible to report code coverage for the helper functions (issue 201).
xBitlocker
1.2.0.0
Converted appveyor.yml to install Pester from PSGallery instead of from Chocolatey.
Added Codecov support.
Updated appveyor.yml to use the one in template.
Added folders for future unit and integration tests.
Added Visual Studio Code formatting settings.
Added .gitignore file.
Added markdown lint rules.
Fixed encoding on README.md.
Added PowerShellVersion="4.0", and updated copyright information, in the module manifest.
Fixed issue which caused Test to incorrectly succeed on fully decrypted volumes when correct Key Protectors were present (issue 13)
Fixed issue which caused xBLAutoBitlocker to incorrectly detect Fixed vs Removable volumes. (issue 11)
Fixed issue which made xBLAutoBitlocker unable to encrypt volumes with drive letters assigned. (issue 10)
Fixed an issue in CheckForPreReqs function where on Server Core the installation of the non existing Windows Feature “RSAT-Feature-Tools-BitLocker-RemoteAdminTool” was erroneously checked. (issue 8)
xDatabase
1.8.0.0
Added support for SQL Server 2017
xDBPackage now uses the shared function to identify the paths for the different SQL server versions
xDhcpServer
1.7.0.0
Changes to xDhcpServer
Updated year in LICENSE file.
Updated year in module manifest.
Added Codecov and status badges to README.md.
Update appveyor.yml to use the default template.
Added xDhcpServerOptionDefinition
xDismFeature
1.3.0.0
Added unit test
Fixed issue that Test-TargetResource always fails on non-English OS 11
xDnsServer
1.11.0.0
Changes to xDnsServer
Updated appveyor.yml to use the default template and add CodeCov support (issue 73).
Adding a Branches section to the README.md with Codecov badges for both master and dev branch (issue 73).
Updated description of resource module in README.md.
Fix Test-xDscSchema failing to call Remove-WmiObject on PowerShell Core. The cmdlet Remove-WmiObject was removed from the code, instead the temporary CIM class is now removed by using mofcomp.exe and the preprocessor command pragma deleteclass (issue 67).
xExchange
1.21.0.0
Added CHANGELOG.md file
Added .markdownlint.json file
Updated README.md and CHANGELOG.md files to respect MD009, MD0013 and MD032 rules
Added .MetaTestOptIn.json file
Updated appveyor.yml file
Added .codecov.yml file
Renamed Test folder to Tests
Updated README.md: Add codecov badges
Fixed PSSA required rules in:
xExchClientAccessServer.psm1
xExchInstall.psm1
xExchMaintenanceMode.psm1
TransportMaintenance.psm1
xExchTransportService.psm1
Fixed Validate Example files in:
ConfigureAutoMountPoints-FromCalculator.ps1
ConfigureAutoMountPoints-Manual.ps1
ConfigureDatabases-FromCalculator.ps1
InternetFacingSite.ps1
RegionalNamespaces.ps1
SingleNamespace.ps1
ConfigureVirtualDirectories.ps1
CreateAndConfigureDAG.ps1
EndToEndExample 1 to 10 files
JetstressAutomation
MaintenanceMode
PostInstallationConfiguration.ps1
InstallExchange.ps1
QuickStartTemplate.ps1
WaitForADPrep.ps1
Remove default value for Switch Parameter in TransportMaintenance.psm1 for functions:
Clear-DiscardEvent
LogIfRemain
Wait-EmptyEntriesCompletion
Update-EntriesTracker
Remove-CompletedEntriesFromHashtable
Fixed PSSA custom rules in:
xExchActiveSyncVirtualDirectory.psm1
xExchAntiMalwareScanning.psm1
xExchAutodiscoverVirtualDirectory.psm1
xExchAutoMountPoint.psm1
xExchClientAccessServer.psm1
xExchDatabaseAvailabilityGroup.psm1
xExchDatabaseAvailabilityGroupMember.psm1
xExchDatabaseAvailabilityGroupNetwork.psm1
xExchEcpVirtualDirectory.psm1
xExchEventLogLevel.psm1
xExchExchangeCertificate.psm1
xExchExchangeServer.psm1
xExchImapSettings.psm1
xExchInstall.psm1
xExchJetstress.psm1
xExchJetstressCleanup.psm1
xExchMailboxDatabase.psm1
xExchMailboxDatabaseCopy.psm1
xExchMailboxServer.psm1
xExchMailboxTransportService.psm1
xExchMaintenanceMode.psm1
xExchMapiVirtualDirectory.psm1
xExchOabVirtualDirectory.psm1
xExchOutlookAnywhere.psm1
xExchOwaVirtualDirectory.psm1
xExchPopSettings.psm1
xExchPowerShellVirtualDirectory.psm1
xExchReceiveConnector.psm1
xExchUMCallRouterSettings.psm1
xExchUMService.psm1
xExchWaitForADPrep.psm1
xExchWaitForDAG.psm1
xExchWaitForMailboxDatabase.psm1
xExchWebServicesVirtualDirectory.psm1
Updated xExchange.psd1
Added issue template file (ISSUE_TEMPLATE.md) for “New Issue” and pull request template file (PULL_REQUEST_TEMPLATE.md) for “New Pull Request”.
Fix issue Diagnostics.CodeAnalysis.SuppressMessageAttribute best practices
Renamed xExchangeCommon.psm1 to xExchangeHelper.psm1
Renamed the folder MISC (that contains the helper) to Modules
Added xExchangeHelper.psm1 in xExchange.psd1 (section NestedModules)
Removed all lines with Import-Module xExchangeCommon.psm1
Updated .MetaTestOptIn.json file with Custom Script Analyzer Rules
Added Integration, TestHelpers and Unit folder
Moved Data folder in Tests
Moved Integration tests to Integration folder
Moved Unit test to Unit folder
Renamed xEchange.Tests.Common.psm1 to xExchangeTestHelper.psm1
Renamed xEchangeCommon.Unit.Tests.ps1 to xExchangeCommon.Tests.ps1
Renamed function PrepTestDAG to Initialize-TestForDAG
Moved function Initialize-TestForDAG to xExchangeTestHelper.psm1
Fix error-level PS Script Analyzer rules for TransportMaintenance.psm1
xHyper-V
3.12.0.0
Changes to xHyper-V
Removed alignPropertyValuePairs from the Visual Studio Code default style formatting settings (issue 110).
BREAKING CHANGE: Renamed the “Scope” Parameter to “ExecutionPolicyScope” since errors are thrown when the MOF file is parsed because “Scope” is a reserved keyword in the DMTF Specification. (issue 14). Michael Fyffe (@TraGicCode)
Adding a Branches section to the README.md with Codecov badges for both master and dev branch (issue 416).
Changes to xWindowsProcess
Integration tests for this resource should no longer fail randomly. A timing issue made the tests fail in certain scenarios (issue 420).
Changes to xDSCWebService
Added the option to use a certificate based on it”s subject and template name instead of it”s thumbprint. Resolves issue 205.
xDSCWebService: Fixed an issue where Test-WebConfigModulesSetting would return $true when web.config contains a module and the desired state was for it to be absent. Resolves issue 418.
Updated the main DSCPullServerSetup readme to read easier, then updates the PowerShell comment based help for each function to follow normal help standards. James Pogran (@jpogran)
Updated xIISLogging to include ability to manage custom logging fields (issue 267). @ldillonel
BREAKING CHANGE: Updated xIisFeatureDelegation to be able to manage any configuration section. Reggie Gibson (@regedit32)
xWinEventLog
1.2.0.0
Converted appveyor.yml to install Pester from PSGallery instead of from Chocolatey.
Fix PSSA errors.
How to Find Released DSC Resource Modules
To see a list of all released DSC Resource Kit modules, go to the PowerShell Gallery and display all modules tagged as DSCResourceKit. You can also enter a module’s name in the search box in the upper right corner of the PowerShell Gallery to find a specific module.
Of course, you can also always use PowerShellGet (available starting in WMF 5.0) to find modules with DSC Resources:
# To list all modules that tagged as DSCResourceKitFind-Module-TagDSCResourceKit# To list all DSC resources from all sources Find-DscResource
Please note only those modules released by the PowerShell Team are currently considered part of the ‘DSC Resource Kit’ regardless of the presence of the ‘DSC Resource Kit’ tag in the PowerShell Gallery.
How to Install DSC Resource Modules From the PowerShell Gallery
We recommend that you use PowerShellGet to install DSC resource modules:
Install-Module-Name<module name >
For example:
Install-Module-Name xWebAdministration
To update all previously installed modules at once, open an elevated PowerShell prompt and use this command:
Update-Module
After installing modules, you can discover all DSC resources available to your local system with this command:
Get-DscResource
How to Find DSC Resource Modules on GitHub
All resource modules in the DSC Resource Kit are available open-source on GitHub.
You can see the most recent state of a resource module by visiting its GitHub page at:
https://github.com/PowerShell/< module name >
For example, for the xCertificate module, go to:
https://github.com/PowerShell/xCertificate.
You are more than welcome to contribute to the development of the DSC Resource Kit! There are several different ways you can help. You can create new DSC resources or modules, add test automation, improve documentation, fix existing issues, or open new ones.
See our contributing guide for more info on how to become a DSC Resource Kit contributor.
Your help in developing the DSC Resource Kit is invaluable to us!
Questions, comments?
If you’re looking into using PowerShell DSC, have questions or issues with a current resource, or would like a new resource, let us know in the comments below, on Twitter (@PowerShell_Team), or by creating an issue on GitHub.
0 comments