xPSDesiredStateConfiguration

4.0.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).
Show more

Minimum PowerShell version

4.0

There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

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

Install-Module -Name xPSDesiredStateConfiguration -RequiredVersion 4.0.0.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name xPSDesiredStateConfiguration -Version 4.0.0.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy 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

Owners

Copyright

(c) 2014 Microsoft Corporation. All rights reserved.

Package Details

Author(s)

  • Microsoft Corporation

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

Functions

Publish-DSCModuleAndMof Publish-ModuleToPullServer Publish-MOFToPullServer

DSCResources

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

Dependencies

This module has no dependencies.

Release Notes

* xDSCWebService:
   * Added setting of enhanced security
   * Cleaned up Examples
   * Cleaned up pull server verification test
* xProcess:
   * Fixed PSSA issues
   * Corrected most style guideline issues
* xPSSessionConfiguration:
   * Fixed PSSA and style issues
   * Renamed internal functions to follow verb-noun formats
   * Decorated all functions with comment-based help
* xRegistry:
   * Fixed PSSA and style issues
   * Renamed internal functions to follow verb-noun format
   * Decorated all functions with comment-based help
   * Merged with in-box Registry
   * Fixed registry key and value removal
   * Added unit tests
* xService:
   * Added descriptions to MOF file.
   * Added additional details to parameters in Readme.md in a format that can be generated from the MOF.
   * Added DesktopInteract parameter.
   * Added standard help headers to *-TargetResource functions.
   * Changed indent/format of all function help headers to be consistent.
   * Fixed line length violations.
   * Changed localization code so only a single copy of localization strings are required.
   * Removed localization strings from inside module file.
   * Updated unit tests to use standard test enviroment configuration and header.
   * Recreated unit tests to be non-destructive.
   * Created integration tests.
   * Allowed service to be restarted immediately rather than wait for next LCM run.
   * Changed helper function names to valid verb-noun format.
   * Removed New-TestService function from MSFT_xServiceResource.TestHelper.psm1 because it should not be used.
   * Fixed error calling Get-TargetResource when service does not exist.
   * Fixed bug with Get-TargetResource returning StartupType "Auto" instead of "Automatic".
   * Converted to HQRM standards.
   * Removed obfuscation of exception in Get-Win32ServiceObject function.
   * Fixed bug where service start mode would be set to auto when it already was set to auto.
   * Fixed error message content when start mode can not be changed.
   * Removed shouldprocess from functions as not required.
   * Optimized Test-TargetResource and Set-TargetResource by removing repeated calls to Get-Service and Get-CimInstance.
   * Added integration test for testing changes to additional service properties as well as changing service binary path.
   * Modified Set-TargetResource so that newly created service created with minimal properties and then all additional properties updated (simplification of code).
   * Added support for changing Service Description and DisplayName parameters.
   * Fixed bug when changing binary path of existing service.
* Removed test log output from repo.
* xDSCWebService:
   * Added setting of enhanced security
   * Cleaned up Examples
   * Cleaned up pull server verification test
* xWindowsOptionalFeature:
   * Cleaned up resource (PSSA issues, formatting, etc.)
   * Added example script
   * Added integration test
   * BREAKING CHANGE: Removed the unused Source parameter
   * Updated to a high quality resource
* Removed test log output from repo.
* Removed the prefix MSFT_ from all files and folders of the composite resources in this module
because they were unavailable to Get-DscResource and Import-DscResource.
   * xFileUpload
   * xGroupSet
   * xProcessSet
   * xServiceSet
   * xWindowsFeatureSet
   * xWindowsOptionalFeatureSet

FileList

Version History

Version Downloads Last updated
9.2.0-previe... 258 11/11/2023
9.2.0-previe... 3,522 9/26/2021
9.2.0-previe... 73 9/25/2021
9.2.0-previe... 335 5/23/2021
9.2.0-previe... 101 4/21/2021
9.2.0-previe... 76 4/17/2021
9.2.0-previe... 421 12/30/2020
9.2.0-previe... 100 12/17/2020
9.1.1-previe... 116 12/6/2020
9.1.1-previe... 114 9/21/2020
9.1.1-previe... 85 8/31/2020
9.1.0 6,811,225 2/19/2020
9.1.0-previe... 79 2/19/2020
9.1.0-previe... 110 1/24/2020
9.0.1-previe... 80 1/24/2020
9.0.1-previe... 78 1/17/2020
9.0.0 312,305 1/15/2020
9.0.0-previe... 80 1/14/2020
9.0.0-previe... 85 1/10/2020
9.0.0-previe... 95 1/7/2020
8.10.0.0 1,007,219 9/19/2019
8.9.0.0 121,124 8/8/2019
8.8.0.0 146,544 6/26/2019
8.7.0.0 89,421 5/15/2019
8.6.0.0 123,474 4/3/2019
8.5.0.0 41,410 2/21/2019
8.4.0.0 379,179 7/25/2018
8.3.0.0 2,840,442 6/13/2018
8.2.0.0 2,810,781 4/20/2018
8.1.0.0 93,749 3/22/2018
8.0.0.0 420,557 11/15/2017
7.0.0.0 77,787 8/23/2017
6.4.0.0 55,954 5/9/2017
6.3.0.0 4,572 5/1/2017
6.2.0.0 6,158 4/19/2017
6.1.0.0 23,234 3/8/2017
6.0.0.0 21,838 2/3/2017
5.2.0.0 5,807 1/26/2017
5.1.0.0 7,173 12/17/2016
5.0.0.0 23,625 11/2/2016
4.0.0.0 (current version) 21,938 9/21/2016
3.13.0.0 9,452 8/10/2016
3.12.0.0 5,386 6/30/2016
3.11.0.0 360 6/29/2016
3.10.0.0 7,088 5/18/2016
3.9.0.0 5,505 3/31/2016
3.8.0.0 927 3/19/2016
3.7.0.0 16,161 2/3/2016
3.6.0.0 3,437 12/3/2015
3.5.0.0 3,287 9/11/2015
3.4.0.0 873 7/24/2015
3.3.0.0 457 6/9/2015
3.2.0.0 450 5/2/2015
3.1.3.4 187 4/23/2015
3.0.3.4 948 12/18/2014
3.0.3.3 137 12/1/2014
3.0.3.0 177 11/10/2014
3.0.2.0 288 8/22/2014
3.0.1.0 172 7/22/2014
3.0.0.0 835 6/6/2014
2.0.1 196 5/13/2014
2.0.0.0 221 4/8/2014
Show less