xPSDesiredStateConfiguration

8.6.0.0

The xPSDesiredStateConfiguration module is a part of the Windows PowerShell Desired State Configuration (DSC) Resource Kit, which is a collection of DSC Resources produced by the PowerShell Team. This module contains the xDscWebService, xWindowsProcess, xService, xPackage, xArchive, xRemoteFile, xPSEndpoint and xWindowsOptionalFeature resources. Please see the Details
The xPSDesiredStateConfiguration module is a part of the Windows PowerShell Desired State Configuration (DSC) Resource Kit, which is a collection of DSC Resources produced by the PowerShell Team. This module contains the xDscWebService, xWindowsProcess, xService, xPackage, xArchive, xRemoteFile, xPSEndpoint and xWindowsOptionalFeature resources. Please see the Details section for more information on the functionalities provided by these resources.

All of the resources in the DSC Resource Kit are provided AS IS, and are not supported through any Microsoft standard support program or service. The "x" in xPSDesiredStateConfiguration stands for experimental, which means that these resources will be fix forward and monitored by the module owner(s).

Minimum PowerShell version

4.0

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name xPSDesiredStateConfiguration

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deloy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Author(s)

Microsoft Corporation

Copyright

(c) Microsoft Corporation. All rights reserved.

Owners

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

Functions

Publish-DSCModuleAndMof Publish-ModulesAndChecksum Publish-MofsInSource Publish-ModuleToPullServer Publish-MOFToPullServer

DSCResources

xArchive xDSCWebService xEnvironment xFileUpload xGroup xGroupSet xMsiPackage xPackage xProcessSet xPSEndpoint xRegistry xRemoteFile xScript xService xServiceSet xUser xWindowsFeature xWindowsFeatureSet xWindowsOptionalFeature xWindowsOptionalFeatureSet xWindowsPackageCab xWindowsProcess

Dependencies

This module has no dependencies.

Release Notes

- Fixes style inconsistencies in PublishModulesAndMofsToPullServer.psm1.
 [issue 530](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/530)
- Suppresses forced Verbose output in MSFT_xArchive.EndToEnd.Tests.ps1,
 MSFT_xDSCWebService.Integration.tests.ps1,
 MSFT_xPackageResource.Integration.Tests.ps1, MSFT_xRemoteFile.Tests.ps1,
 MSFT_xUserResource.Integration.Tests.ps1,
 MSFT_xWindowsProcess.Integration.Tests.ps1, and
 xFileUpload.Integration.Tests.ps1.
 [issue 514](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/514)
- Fixes issue in xGroupResource Integration tests where the tests would fail
 if the System.DirectoryServices.AccountManagement namespace was not loaded.
- Tests\Integration\MSFT_xDSCWebService.Integration.tests.ps1:
 - Fixes issue where tests fail if a self signed certificate for DSC does not
   already exist.
   [issue 581](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/581)
- Fixes all instances of the following PSScriptAnalyzer issues:
 - PSUseOutputTypeCorrectly
 - PSAvoidUsingConvertToSecureStringWithPlainText
 - PSPossibleIncorrectComparisonWithNull
 - PSAvoidDefaultValueForMandatoryParameter
 - PSAvoidUsingInvokeExpression
 - PSUseDeclaredVarsMoreThanAssignments
 - PSAvoidGlobalVars
- xPackage and xMsiPackage
 - Add an ability to ignore a pending reboot if requested by package installation.
- xRemoteFile
 - Updated MatchSource description in README.md.
   [issue 409](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/409)
 - Improved layout of MOF file to move description left.
 - Added function help for all functions.
 - Moved `New-InvalidDataException` to CommonResourceHelper.psm1.
   [issue 544](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/544)
- Added full stops to the end of all functions help in CommonResourceHelper.psm1.
- Added unit tests for `New-InvalidArgumentException`,
 `New-InvalidDataException` and `New-InvalidOperationException`
 CommonResourceHelper.psm1 functions.
- Changes to `MSFT_xDSCWebService`
 - Fixed
   [issue 528](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/528)
   : Unable to disable selfsigned certificates using AcceptSelfSignedCertificates=$false
 - Fixed
   [issue 460](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/460)
   : Redeploy DSC Pull Server fails with error
- Opt-in to the following Meta tests:
 - Common Tests - Custom Script Analyzer Rules
 - Common Tests - Flagged Script Analyzer Rules
 - Common Tests - New Error-Level Script Analyzer Rules
 - Common Tests - Relative Path Length
 - Common Tests - Required Script Analyzer Rules
 - Common Tests - Validate Markdown Links
- Add .markdownlint.json file using settings from
 [here](https://raw.githubusercontent.com/PowerShell/SqlServerDsc/dev/.markdownlint.json)
 as a starting point.
- Changes to `Tests\Unit\MSFT_xMsiPackage.Tests.ps1`
 - Fixes issue where tests fail if executed from a drive other than C:.
   [issue 573](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/573)
- Changes to
 `Tests\Integration\xWindowsOptionalFeatureSet.Integration.Tests.ps1`
 - Fixes issue where tests fail if a Windows Optional Feature that is expected
   to be disabled has a feature state of "DisabledWithPayloadRemoved".
   [issue 586](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/586)
- Changes to
 `Tests\Unit\MSFT_xPackageResource.Tests.ps1`
 - Fixes issue where tests fail if run from a folder that contains spaces.
   [issue 580](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/580)
- Changes to test helper Enter-DscResourceTestEnvironment so that it only
 updates DSCResource.Tests when it is longer than 60 minutes since
 it was last pulled. This is to improve performance of test execution
 and reduce the likelihood of connectivity issues caused by inability to
 pull DSCResource.Tests.
 [issue 505](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/505)
- Updated `CommonTestHelper.psm1` to resolve style guideline violations.
- Adds helper functions for use when creating test administrator user accounts,
 and updates the following tests to use credentials created with these
 functions:
 - MSFT_xScriptResource.Integration.Tests.ps1
 - MSFT_xServiceResource.Integration.Tests.ps1
 - MSFT_xWindowsProcess.Integration.Tests.ps1
 - xServiceSet.Integration.Tests.ps1
- Fixes the following issues:
 - [issue 582](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/582)
 - [issue 583](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/583)
 - [issue 584](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/584)
 - [issue 585](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/585)

Version History

Version Downloads Last updated
8.6.0.0 (current version) 61,513 4/3/2019
8.5.0.0 28,682 2/21/2019
8.4.0.0 344,968 7/25/2018
8.3.0.0 2,835,250 6/13/2018
8.2.0.0 2,805,945 4/20/2018
8.1.0.0 93,088 3/22/2018
8.0.0.0 396,454 11/15/2017
7.0.0.0 77,527 8/23/2017
6.4.0.0 42,149 5/9/2017
6.3.0.0 4,477 5/1/2017
6.2.0.0 6,065 4/19/2017
6.1.0.0 22,984 3/8/2017
6.0.0.0 15,101 2/3/2017
5.2.0.0 5,704 1/26/2017
5.1.0.0 6,993 12/17/2016
5.0.0.0 19,569 11/2/2016
4.0.0.0 17,252 9/21/2016
3.13.0.0 8,644 8/10/2016
3.12.0.0 5,165 6/30/2016
3.11.0.0 261 6/29/2016
3.10.0.0 6,056 5/18/2016
3.9.0.0 5,259 3/31/2016
3.8.0.0 832 3/19/2016
3.7.0.0 15,993 2/3/2016
3.6.0.0 2,923 12/3/2015
3.5.0.0 3,191 9/11/2015
3.4.0.0 781 7/24/2015
3.3.0.0 365 6/9/2015
3.2.0.0 357 5/2/2015
3.1.3.4 94 4/23/2015
3.0.3.4 747 12/18/2014
3.0.3.3 45 12/1/2014
3.0.3.0 81 11/10/2014
3.0.2.0 191 8/22/2014
3.0.1.0 79 7/22/2014
3.0.0.0 725 6/6/2014
2.0.1 91 5/13/2014
2.0.0.0 114 4/8/2014
.