xPSDesiredStateConfiguration

8.4.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) 2014 Microsoft Corporation. All rights reserved.

Owners

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

Functions

Publish-DSCModuleAndMof 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

* Changes to xPSDesiredStateConfiguration
 * Opt-in for the common tests validate module files and script files.
 * All files change to encoding UTF-8 (without byte order mark).
 * Opt-in for the common test for example validation.
 * Added Visual Studio Code workspace settings that helps with formatting
   against the style guideline.
 * Update all examples for them to be able pass the common test validation.
* xEnvironment path documentation update demonstrating usage with multiple values  ([issue 415](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/415). [Alex Kokkinos (@alexkokkinos)](https://github.com/alexkokkinos)
* Changes to xWindowsProcess
 * Increased the wait time in the integration tests since the tests
   still failed randomly ([issue 420](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/420)).
* Renamed and updated examples to be able to publish them to PowerShell Gallery.
 * Sample\_xScript.ps1 to xScript\_WatchFileContentConfig.ps1
 * Sample\_xService\_UpdateStartupTypeIgnoreState.ps1 to xService\_UpdateStartupTypeIgnoreStateConfig.ps1
 * Sample\_xWindowsProcess\_Start.ps1 to xWindowsProcess\_StartProcessConfig.ps1
 * Sample\_xWindowsProcess\_StartUnderUser.ps1 to xWindowsProcess\_StartProcessUnderUserConfig.ps1
 * Sample\_xWindowsProcess\_Stop.ps1 to xWindowsProcess\_StopProcessConfig.ps1
 * Sample\_xWindowsProcess\_StopUnderUser.ps1 to xWindowsProcess\_StopProcessUnderUserConfig.ps1
 * Sample\_xUser\_CreateUser.ps1.ps1 to xUser\_CreateUserConfig.ps1
 * Sample\_xUser\_Generic.ps1.ps1 to xUser\_CreateUserDetailedConfig.ps1
 * Sample\_xWindowsFeature.ps1 to xWindowsFeature\_AddFeatureConfig.ps1
 * Sample\_xWindowsFeatureSet\_Install.ps1 to xWindowsFeatureSet\_AddFeaturesConfig.ps1
 * Sample\_xWindowsFeatureSet\_Uninstall.ps1 to xWindowsFeatureSet\_RemoveFeaturesConfig.ps1
 * Sample\_xRegistryResource\_AddKey.ps1 to xRegistryResource\_AddKeyConfig.ps1
 * Sample\_xRegistryResource\_RemoveKey.ps1 to xRegistryResource\_RemoveKeyConfig.ps1
 * Sample\_xRegistryResource\_AddOrModifyValue.ps1 to xRegistryResource\_AddOrModifyValueConfig.ps1
 * Sample\_xRegistryResource\_RemoveValue.ps1 to xRegistryResource\_RemoveValueConfig.ps1
 * Sample\_xService\_CreateService.ps1 to xService\_CreateServiceConfig.ps1
 * Sample\_xService\_DeleteService.ps1 to xService\_RemoveServiceConfig.ps1
 * Sample\_xServiceSet\_StartServices.ps1 to xServiceSet\_StartServicesConfig.ps1
 * Sample\_xServiceSet\_BuiltInAccount to xServiceSet\_EnsureBuiltInAccountConfig.ps1
 * Sample\_xWindowsPackageCab to xWindowsPackageCab\_InstallPackageConfig
 * Sample\_xWindowsOptionalFeature.ps1 to xWindowsOptionalFeature\_EnableConfig.ps1
 * Sample\_xWindowsOptionalFeatureSet\_Enable.ps1 to xWindowsOptionalFeatureSet\_EnableConfig.ps1
 * Sample\_xWindowsOptionalFeatureSet\_Disable.ps1 to xWindowsOptionalFeatureSet\_DisableConfig.ps1
 * Sample\_xRemoteFileUsingProxy.ps1 to xRemoteFile\_DownloadFileUsingProxyConfig.ps1
 * Sample\_xRemoteFile.ps1 to xRemoteFile\_DownloadFileConfig.ps1
 * Sample\_xProcessSet\_Start.ps1 to xProcessSet\_StartProcessConfig.ps1
 * Sample\_xProcessSet\_Stop.ps1 to xProcessSet\_StopProcessConfig.ps1
 * Sample\_xMsiPackage\_UninstallPackageFromHttps.ps1 to xMsiPackage\_UninstallPackageFromHttpsConfig.ps1
 * Sample\_xMsiPackage\_UninstallPackageFromFile.ps1 to xMsiPackage\_UninstallPackageFromFileConfig.ps1
 * Sample\_xMsiPackage\_InstallPackageFromFile to xMsiPackage\_InstallPackageConfig.ps1
 * Sample\_xGroup\_SetMembers.ps1 to xGroup\_SetMembersConfig.ps1
 * Sample\_xGroup\_RemoveMembers.ps1 to xGroup\_RemoveMembersConfig.ps1
 * Sample\_xGroupSet\_AddMembers.ps1 to xGroupSet\_AddMembersConfig.ps1
 * Sample\_xFileUpload.ps1 to xFileUpload\_UploadToSMBShareConfig.ps1
 * Sample\_xEnvironment\_CreateMultiplePathVariables.ps1 to xEnvironment\_AddMultiplePathsConfig.ps1
 * Sample\_xEnvironment\_RemovePathVariables.ps1 to xEnvironment\_RemoveMultiplePathsConfig.ps1
 * Sample\_xEnvironment\_CreateNonPathVariable.ps1 to xEnvironment\_CreateNonPathVariableConfig.ps1
 * Sample\_xEnvironment\_Remove.ps1 to xEnvironment\_RemoveVariableConfig.ps1
 * Sample\_xArchive\_ExpandArchiveChecksumAndForce.ps1 to xArchive\_ExpandArchiveChecksumAndForceConfig.ps1
 * Sample\_xArchive\_ExpandArchiveDefaultValidationAndForce.ps1 to xArchive\_ExpandArchiveDefaultValidationAndForceConfig.ps1
 * Sample\_xArchive\_ExpandArchiveNoValidation.ps1 to xArchive\_ExpandArchiveNoValidationConfig.ps1
 * Sample\_xArchive\_ExpandArchiveNoValidationCredential.ps1 to xArchive\_ExpandArchiveNoValidationCredentialConfig.ps1
 * Sample\_xArchive\_RemoveArchiveChecksum.ps1 to xArchive\_RemoveArchiveChecksumConfig.ps1
 * Sample\_xArchive\_RemoveArchiveNoValidation.ps1 to xArchive\_RemoveArchiveNoValidationConfig.ps1
 * Sample\_InstallExeCreds\_xPackage.ps1 to xPackage\_InstallExeUsingCredentialsConfig.ps1
 * Sample\_InstallExeCredsRegistry\_xPackage.ps1 to xPackage\_InstallExeUsingCredentialsAndRegistryConfig.ps1
 * Sample\_InstallMSI\_xPackage.ps1 to xPackage\_InstallMsiConfig.ps1
 * Sample\_InstallMSIProductId\_xPackage.ps1 to xPackage\_InstallMsiUsingProductIdConfig.ps1
* New examples
 * xUser\_RemoveUserConfig.ps1
 * xWindowsFeature\_AddFeatureUsingCredentialConfig.ps1
 * xWindowsFeature\_AddFeatureWithLogPathConfig.ps1
 * xWindowsFeature\_RemoveFeatureConfig.ps1
 * xService\_ChangeServiceStateConfig.ps1
 * xWindowsOptionalFeature\_DisableConfig.ps1
 * xPSEndpoint\_NewConfig.ps1
 * xPSEndpoint\_NewWithDefaultsConfig.ps1
 * xPSEndpoint\_RemoveConfig.ps1
 * xPSEndpoint\_NewCustomConfig.ps1
* Removed examples
 * Sample\_xPSSessionConfiguration.ps1 - This file was split up in several examples,
   those starting with "xPSEndpoint*".
 * Sample\_xMsiPackage\_InstallPackageFromHttp - This was added to the example
   xMsiPackage\_InstallPackageConfig.ps1 so the example sows either URI scheme.
 * Sample\_xEnvironment\_CreatePathVariable.ps1 - Same as the new example
   xEnvironment\_AddMultiplePaths.ps1

Version History

Version Downloads Last updated
8.4.0.0 (current version) 289,454 7/25/2018
8.3.0.0 2,828,768 6/13/2018
8.2.0.0 2,805,538 4/20/2018
8.1.0.0 92,723 3/22/2018
8.0.0.0 394,784 11/15/2017
7.0.0.0 77,475 8/23/2017
6.4.0.0 39,601 5/9/2017
6.3.0.0 4,476 5/1/2017
6.2.0.0 6,064 4/19/2017
6.1.0.0 22,843 3/8/2017
6.0.0.0 13,286 2/3/2017
5.2.0.0 5,703 1/26/2017
5.1.0.0 6,925 12/17/2016
5.0.0.0 17,324 11/2/2016
4.0.0.0 15,948 9/21/2016
3.13.0.0 8,559 8/10/2016
3.12.0.0 5,143 6/30/2016
3.11.0.0 259 6/29/2016
3.10.0.0 5,873 5/18/2016
3.9.0.0 5,193 3/31/2016
3.8.0.0 831 3/19/2016
3.7.0.0 15,945 2/3/2016
3.6.0.0 2,677 12/3/2015
3.5.0.0 3,158 9/11/2015
3.4.0.0 779 7/24/2015
3.3.0.0 364 6/9/2015
3.2.0.0 356 5/2/2015
3.1.3.4 93 4/23/2015
3.0.3.4 740 12/18/2014
3.0.3.3 44 12/1/2014
3.0.3.0 80 11/10/2014
3.0.2.0 190 8/22/2014
3.0.1.0 78 7/22/2014
3.0.0.0 723 6/6/2014
2.0.1 90 5/13/2014
2.0.0.0 113 4/8/2014