master:

dev:

PSDscResources

PSDscResources is the new home of the in-box resources from PSDesiredStateConfiguration.

These resources are a combination of those in the in-box PSDesiredStateConfiguration module as well as community contributions from our experimental xPSDesiredStateConfiguration module on GitHub. These resources have also recently been updated to meet the DSC Resource Kit High Quality Resource Module (HQRM) guidelines.

In-box resources not currently included in this module should not be affected and can still load from the in-box PSDesiredStateConfiguration module.

Because PSDscResources overwrites in-box resources, it is only available for WMF 5.1. Many of the resource updates provided here are also included in the xPSDesiredStateConfiguration module which is still compatible with WMF 4 and WMF 5 (though this module is not supported and may be removed in the future).

To update your in-box resources to the newest versions provided by PSDscResources, first install PSDscResources from the PowerShell Gallery:

Install-Module PSDscResources

Then, simply add this line to your DSC configuration:

Import-DscResource -ModuleName PSDscResources

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Contributing

This module does not accept breaking changes.

Please check out the common DSC Resources contributing guidelines.

Resources

• Archive: Provides a mechanism to expand an archive (.zip) file to a specific path or remove an expanded archive (.zip) file from a specific path on a target node.
• Environment: Provides a mechanism to configure and manage environment variables for a machine or process.
• Group: Provides a mechanism to manage local groups on a target node.
• GroupSet: Provides a mechanism to configure and manage multiple Group resources with common settings but different names.
• MsiPackage: Provides a mechanism to install and uninstall MSI packages.
• Registry: Provides a mechanism to manage registry keys and values on a target node.
• Script: Provides a mechanism to run PowerShell script blocks on a target node.
• Service: Provides a mechanism to configure and manage Windows services on a target node.
• ServiceSet: Provides a mechanism to configure and manage multiple Service resources with common settings but different names.
• User: Provides a mechanism to manage local users on a target node.
• WindowsFeature: Provides a mechanism to install or uninstall Windows roles or features on a target node.
• WindowsFeatureSet: Provides a mechanism to configure and manage multiple WindowsFeature resources on a target node.
• WindowsOptionalFeature: Provides a mechanism to enable or disable optional features on a target node.
• WindowsOptionalFeatureSet: Provides a mechanism to configure and manage multiple WindowsOptionalFeature resources on a target node.
• WindowsPackageCab: Provides a mechanism to install or uninstall a package from a Windows cabinet (cab) file on a target node.
• WindowsProcess: Provides a mechanism to start and stop a Windows process.
• ProcessSet: Provides a mechanism to configure and manage multiple WindowsProcess resources on a target node.

Resources that Work on Nano Server

• Group
• Script
• Service
• User
• WindowsOptionalFeature
• WindowsOptionalFeatureSet
• WindowsPackageCab

Archive

Provides a mechanism to expand an archive (.zip) file to a specific path or remove an expanded archive (.zip) file from a specific path on a target node.

Requirements

• The System.IO.Compression type assembly must be available on the machine.
• The System.IO.Compression.FileSystem type assembly must be available on the machine.

Parameters

• [String] Path (Key): The path to the archive file that should be expanded to or removed from the specified destination.
• [String] Destination (Key): The path where the specified archive file should be expanded to or removed from.
• [String] Ensure (Write): Specifies whether or not the expanded content of the archive file at the specified path should exist at the specified destination. To update the specified destination to have the expanded content of the archive file at the specified path, specify this property as Present. To remove the expanded content of the archive file at the specified path from the specified destination, specify this property as Absent. The default value is Present. { Present | Absent }.
• [Boolean] Validate (Write): Specifies whether or not to validate that a file at the destination with the same name as a file in the archive actually matches that corresponding file in the archive by the specified checksum method. If the file does not match and Ensure is specified as Present and Force is not specified, the resource will throw an error that the file at the desintation cannot be overwritten. If the file does not match and Ensure is specified as Present and Force is specified, the file at the desintation will be overwritten. If the file does not match and Ensure is specified as Absent, the file at the desintation will not be removed. The default value is false.
• [String] Checksum (Write): The Checksum method to use to validate whether or not a file at the destination with the same name as a file in the archive actually matches that corresponding file in the archive. An invalid argument exception will be thrown if Checksum is specified while Validate is specified as false. ModifiedDate will check that the LastWriteTime property of the file at the destination matches the LastWriteTime property of the file in the archive. CreatedDate will check that the CreationTime property of the file at the destination matches the CreationTime property of the file in the archive. SHA-1, SHA-256, and SHA-512 will check that the hash of the file at the destination by the specified SHA method matches the hash of the file in the archive by the specified SHA method. The default value is ModifiedDate. { ModifiedDate | CreatedDate | SHA-1 | SHA-256 | SHA-512 }
• [System.Management.Automation.PSCredential] Credential (Write): The credential of a user account with permissions to access the specified archive path and destination if needed.
• [Boolean] Force (Write): Specifies whether or not any existing files or directories at the destination with the same name as a file or directory in the archive should be overwritten to match the file or directory in the archive. When this property is false, an error will be thrown if an item at the destination needs to be overwritten. The default value is false.

Read-Only Properties from Get-TargetResource

None

Examples

• Expand an archive without file validation
• Expand an archive under a credential without file validation
• Expand an archive with default file validation and file overwrite allowed
• Expand an archive with SHA-256 file validation and file overwrite allowed
• Remove an archive without file validation
• Remove an archive with SHA-256 file validation

Environment

Provides a mechanism to configure and manage environment variables for a machine or process.

Requirements

None

Parameters

• [String] Name (Key): The name of the environment variable to create, modify, or remove.
• [String] Value (Write): The desired value for the environment variable. The default value is an empty string which either indicates that the variable should be removed entirely or that the value does not matter when testing its existence.
• [String] Ensure (Write): Specifies if the environment varaible should exist. { Present | Absent }.
• [Boolean] Path (Write): Indicates whether or not the environment variable is a path variable. If the variable being configured is a path variable, the value provided will be appended to or removed from the existing value, otherwise the existing value will be replaced by the new value. The default value is False.
• [String[]] Target (Write): Indicates the target where the environment variable should be set. { Process | Machine | Process, Machine }.

Read-Only Properties from Get-TargetResource

None

Examples

• Create a non-path environment variable
• Create or update a path environment variable
• Remove an environment variable

Group

Provides a mechanism to manage local groups on a target node. This resource works on Nano Server.

Requirements

None

Parameters

• [String] GroupName (Key): The name of the group to create, modify, or remove.
• [String] Ensure (Write): Indicates if the group should exist or not. To add a group or modify an existing group, set this property to Present. To remove a group, set this property to Absent. The default value is Present. { Present | Absent }.
• [String] Description (Write): The description the group should have.
• [String[]] Members (Write): The members the group should have. This property will replace all the current group members with the specified members. Members should be specified as strings in the format of their domain qualified name (domain\username), their UPN (username@domainname), their distinguished name (CN=username,DC=...), or their username (for local machine accounts). Using either the MembersToExclude or MembersToInclude properties in the same configuration as this property will generate an error.
• [String[]] MembersToInclude (Write): The members the group should include. This property will only add members to a group. Members should be specified as strings in the format of their domain qualified name (domain\username), their UPN (username@domainname), their distinguished name (CN=username,DC=...), or their username (for local machine accounts). Using the Members property in the same configuration as this property will generate an error.
• [String[]] MembersToExclude (Write): The members the group should exclude. This property will only remove members from a group. Members should be specified as strings in the format of their domain qualified name (domain\username), their UPN (username@domainname), their distinguished name (CN=username,DC=...), or their username (for local machine accounts). Using the Members property in the same configuration as this property will generate an error.
• [System.Management.Automation.PSCredential] Credential (Write): A credential to resolve non-local group members.

Read-Only Properties from Get-TargetResource

None

Examples

• Set members of a group
• Remove members of a group

GroupSet

Provides a mechanism to configure and manage multiple Group resources with common settings but different names

Requirements

None

Parameters

• [String] GroupName (Key): The names of the groups to create, modify, or remove.

The following parameters will be the same for each group in the set:

• [String] Ensure (Write): Indicates if the groups should exist or not. To add groups or modify existing groups, set this property to Present. To remove groups, set this property to Absent. { Present | Absent }.
• [String[]] MembersToInclude (Write): The members the groups should include. This property will only add members to groups. Members should be specified as strings in the format of their domain qualified name (domain\username), their UPN (username@domainname), their distinguished name (CN=username,DC=...), or their username (for local machine accounts).
• [String[]] MembersToExclude (Write): The members the groups should exclude. This property will only remove members groups. Members should be specified as strings in the format of their domain qualified name (domain\username), their UPN (username@domainname), their distinguished name (CN=username,DC=...), or their username (for local machine accounts).
• [System.Management.Automation.PSCredential] Credential (Write): A credential to resolve non-local group members.

Read-Only Properties from Get-TargetResource

None

Examples

• Add members to multiple groups

MsiPackage

Provides a mechanism to install and uninstall MSI packages.

Requirements

None

Parameters

• [String] ProductId (Key): The identifying number used to find the package, usually a GUID.
• [String] Path (Required): The path to the MSI file that should be installed or uninstalled.
• [String] Ensure (Write): Specifies whether or not the MSI file should be installed or not. To install the MSI file, specify this property as Present. To uninstall the .msi file, specify this property as Absent. The default value is Present. { Present | Absent }.
• [String] Arguments (Write): The arguments to be passed to the MSI package during installation or uninstallation if needed.
• [System.Management.Automation.PSCredential] Credential (Write): The credential of a user account to be used to mount a UNC path if needed.
• [String] LogPath (Write): The path to the log file to log the output from the MSI execution.
• [String] FileHash (Write): The expected hash value of the MSI file at the given path.
• [String] HashAlgorithm (Write): The algorithm used to generate the given hash value.
• [String] SignerSubject (Write): The subject that should match the signer certificate of the digital signature of the MSI file.
• [String] SignerThumbprint (Write): The certificate thumbprint that should match the signer certificate of the digital signature of the MSI file.
• [String] ServerCertificateValidationCallback (Write): PowerShell code that should be used to validate SSL certificates for paths using HTTPS.
• [System.Management.Automation.PSCredential] RunAsCredential (Write): The credential of a user account under which to run the installation or uninstallation of the MSI package.

Read-Only Properties from Get-TargetResource

• [String] Name (Read): The display name of the MSI package.
• [String] InstallSource (Read): The path to the MSI package.
• [String] InstalledOn (Read): The date that the MSI package was installed on or serviced on, whichever is later.
• [UInt32] Size (Read): The size of the MSI package in MB.
• [String] Version (Read): The version number of the MSI package.
• [String] PackageDescription (Read): The description of the MSI package.
• [String] Publisher (Read): The publisher of the MSI package.

Examples

• Install the MSI file with the given ID at the given Path
• Uninstall the MSI file with the given ID at the given Path
• Install the MSI file with the given ID at the given HTTP URL
• Uninstall the MSI file with the given ID at the given HTTPS URL

Registry

Provides a mechanism to manage registry keys and values on a target node.

Requirements

None

Parameters

• [String] Key (Key): The path of the registry key to add, modify, or remove. This path must include the registry hive/drive (e.g. HKEY_LOCAL_MACHINE, HKLM:).
• [String] ValueName (Key): The name of the registry value. To add or remove a registry key, specify this property as an empty string without specifying ValueType or ValueData. To modify or remove the default value of a registry key, specify this property as an empty string while also specifying ValueType or ValueData.
• [String] Ensure (Write): Specifies whether or not the registry key or value should exist. To add or modify a registry key or value, set this property to Present. To remove a registry key or value, set this property to Absent. { Present | Absent }.
• [String] ValueData (Write): The data the specified registry key value should have as a string or an array of strings (MultiString only).
• [String] ValueType (Write): The type the specified registry key value should have. { String | Binary | DWord | QWord | MultiString | ExpandString }
• [Boolean] Hex (Write): Specifies whether or not the specified DWord or QWord registry key data is provided in a hexadecimal format. Not valid for types other than DWord and QWord. The default value is $false.
• [Boolean] Force (Write): Specifies whether or not to overwrite the specified registry key value if it already has a value or whether or not to delete a registry key that has subkeys. The default value is $false.

Read-Only Properties from Get-TargetResource

None

Examples

• Add a registry key
• Add or modify a registry key value
• Remove a registry key value
• Remove a registry key

Script

Provides a mechanism to run PowerShell script blocks on a target node. This resource works on Nano Server.

Requirements

None

Parameters

• [String] GetScript (Key): A string that can be used to create a PowerShell script block that retrieves the current state of the resource. This script block runs when the Get-DscConfiguration cmdlet is called. This script block should return a hash table containing one key named Result with a string value.
• [String] SetScript (Key): A string that can be used to create a PowerShell script block that sets the resource to the desired state. This script block runs conditionally when the Start-DscConfiguration cmdlet is called. The TestScript script block will run first. If the TestScript block returns False, this script block will run. If the TestScript block returns True, this script block will not run. This script block should not return.
• [String] TestScript (Key): A string that can be used to create a PowerShell script block that validates whether or not the resource is in the desired state. This script block runs when the Start-DscConfiguration cmdlet is called or when the Test-DscConfiguration cmdlet is called. This script block should return a boolean with True meaning that the resource is in the desired state and False meaning that the resource is not in the desired state.
• [PSCredential] Credential (Write): The credential of the user account to run the script under if needed.

Read-Only Properties from Get-TargetResource

• [String] Result (Read): The result from the GetScript script block.

Examples

• Create a file with content through Script

Service

Provides a mechanism to configure and manage Windows services on a target node. This resource works on Nano Server.

Requirements

None

Parameters

• [String] Name (Key): Indicates the service name. Note that sometimes this is different from the display name. You can get a list of the services and their current state with the Get-Service cmdlet.
• [String] Ensure (Write): Indicates whether the service is present or absent. Defaults to Present. { Present | Absent }.
• [String] Path (Write): The path to the service executable file.
• [String] StartupType (Write): Indicates the startup type for the service. { Automatic | Disabled | Manual }.
• [String] BuiltInAccount (Write): Indicates the sign-in account to use for the service. { LocalService | LocalSystem | NetworkService }.
• [PSCredential] Credential (Write): The credential to run the service under.
• [Boolean] DesktopInteract (Write): Indicates whether the service can create or communicate with a window on the desktop. Must be false for services not running as LocalSystem. Defaults to False.
• [String] State (Write): Indicates the state you want to ensure for the service. Defaults to Running. { Running | Stopped | Ignore }.
• [String] DisplayName (Write): The display name of the service.
• [String] Description (Write): The description of the service.
• [String[]] Dependencies (Write): An array of strings indicating the names of the dependencies of the service.
• [Uint32] StartupTimeout (Write): The time to wait for the service to start in milliseconds. Defaults to 30000.
• [Uint32] TerminateTimeout (Write): The time to wait for the service to stop in milliseconds. Defaults to 30000.

Read-Only Properties from Get-TargetResource

None

Examples

• Create a service
• Delete a service
• Update a service with StartupType set to 'Ignore'

ServiceSet

Provides a mechanism to configure and manage multiple Service resources with common settings but different names. This resource can only modify or delete existing services. It cannot create services.

Requirements

None

Parameters

• [String[]] Name (Key): The names of the services to modify or delete. This may be different from the service's display name. To retrieve a list of all services with their names and current states, use the Get-Service cmdlet.

The following parameters will be the same for each service in the set:

• [String] Ensure (Write): Indicates whether the services are present or absent. { Present | Absent }.
• [String] BuiltInAccount (Write): The built-in account the services should start under. Cannot be specified at the same time as Credential. The user account specified by this property must have access to the service executable paths in order to start the services. { LocalService | LocalSystem | NetworkService }.
• [PSCredential] Credential (Write): The credential of the user account the services should start under. Cannot be specified at the same time as BuiltInAccount. The user specified by this credential will automatically be granted the Log on as a Service right. The user account specified by this property must have access to the service executable paths in order to start the services.
• [String] StartupType (Write): The startup type of the services. { Automatic | Disabled | Manual }.
• [String] State (Write): The state the services. { Running | Stopped | Ignore }.

Read-Only Properties from Get-TargetResource

None

Examples

• Ensure that multiple services are running
• Set multiple services to run under the built-in account LocalService

User

Provides a mechanism to manage local users on a target node. This resource works on Nano Server.

Requirements

None

Parameters

• [String] UserName (Key): Indicates the account name for which you want to ensure a specific state.
• [String] Description (Write): Indicates the description you want to use for the user account.
• [Boolean] Disabled (Write): Indicates if the account is disabled. Set this property to true to ensure that this account is disabled, and set it to false to ensure that it is enabled. The default value is false.
• [String] Ensure (Write): Ensures that the feature is present or absent { Present | Absent }.
• [String] FullName (Write): Represents a string with the full name you want to use for the user account.
• [PSCredential] Password (Write): Indicates the password you want to use for this account.
• [Boolean] PasswordChangeNotAllowed (Write): Indicates if the user can change the password. Set this property to true to ensure that the user cannot change the password, and set it to false to allow the user to change the password. The default value is false.
• [Boolean] PasswordChangeRequired (Write): Indicates if the user must change the password at the next sign in. Set this property to true if the user must change their password. The default value is true.
• [Boolean] PasswordNeverExpires (Write): Indicates if the password will expire. To ensure that the password for this account will never expire, set this property to true. The default value is false.

Read-Only Properties from Get-TargetResource

None

Examples

• Create a new User

WindowsFeature

Provides a mechanism to install or uninstall Windows roles or features on a target node. This resource is not supported on Nano Server.

Requirements

• Target machine must be running Windows Server 2008 or later.
• Target machine must have access to the DISM PowerShell module.
• Target machine must have access to the ServerManager module (provided by default on Windows Server).

Parameters

• [String] Name (Key): Indicates the name of the role or feature that you want to ensure is added or removed. This is the same as the Name property from the Get-WindowsFeature cmdlet, and not the display name of the role or feature.
• [PSCredential] Credential (Write): Indicates the credential to use to add or remove the role or feature if needed.
• [String] Ensure (Write): Specifies whether the feature should be installed (Present) or uninstalled (Absent) { Present | Absent }.
• [Boolean] IncludeAllSubFeature (Write): Specifies whether or not all subfeatures should be installed with the specified role or feature. The default value is false.
• [String] LogPath (Write): Indicates the path to a log file to log the operation.

Read-Only Properties from Get-TargetResource

• [String] DisplayName (Read): The display name of the retrieved role or feature.

Examples

• Install or uninstall a Windows feature

WindowsFeatureSet

Provides a mechanism to configure and manage multiple WindowsFeature resources on a target node.

Requirements

• Target machine must be running Windows Server 2008 or later.
• Target machine must have access to the DISM PowerShell module.
• Target machine must have access to the ServerManager module.

Parameters

• [String] Name (Key): The names of the roles or features to install or uninstall. This may be different from the display name of the feature/role. To retrieve the names of features/roles on a machine use the Get-WindowsFeature cmdlet.
• [String] Ensure (Write): Specifies whether the feature should be installed or uninstalled. To install features, set this property to Present. To uninstall features, set this property to Absent. { Present | Absent }.
• [Boolean] IncludeAllSubFeature (Write): Specifies whether or not all subfeatures should be installed or uninstalled alongside the specified roles or features. If this property is true and Ensure is set to Present, all subfeatures will be installed. If this property is false and Ensure is set to Present, subfeatures will not be installed or uninstalled. If Ensure is set to Absent, all subfeatures will be uninstalled.
• [PSCredential] Credential (Write): The credential of the user account under which to install or uninstall the roles or features.
• [String] LogPath (Write): The custom file path to which to log this operation. If not passed in, the default log path will be used (%windir%\logs\ServerManager.log).

Read-Only Properties from Get-TargetResource

• [String] DisplayName (Read): The display names of the retrieved roles or features.

Examples

• Install multiple Windows features
• Uninstall multiple Windows features

WindowsOptionalFeature

Provides a mechanism to enable or disable optional features on a target node. This resource works on Nano Server.

Requirements

• Target machine must be running a Windows client operating system, Windows Server 2012 or later, or Nano Server.
• Target machine must have access to the DISM PowerShell module

Parameters

• [String] Name (Key): The name of the Windows optional feature to enable or disable.
• [String] Ensure (Write): Specifies whether the feature should be enabled or disabled. To enable the feature, set this property to Present. To disable the feature, set the property to Absent. The default value is Present. { Present | Absent }.
• [Boolean] RemoveFilesOnDisable (Write): Specifies that all files associated with the feature should be removed if the feature is being disabled.
• [Boolean] NoWindowsUpdateCheck (Write): Specifies whether or not DISM contacts Windows Update (WU) when searching for the source files to enable the feature. If $true, DISM will not contact WU.
• [String] LogPath (Write): The path to the log file to log this operation. There is no default value, but if not set, the log will appear at %WINDIR%\Logs\Dism\dism.log.
• [String] LogLevel (Write): The maximum output level to show in the log. ErrorsOnly will log only errors. ErrorsAndWarning will log only errors and warnings. ErrorsAndWarningAndInformation will log errors, warnings, and debug information). The default value is "ErrorsAndWarningAndInformation". { ErrorsOnly | ErrorsAndWarning | ErrorsAndWarningAndInformation }.

Read-Only Properties from Get-TargetResource

• [String[]] CustomProperties (Read): The custom properties retrieved from the Windows optional feature as an array of strings.
• [String] Description (Read): The description retrieved from the Windows optional feature.
• [String] DisplayName (Read): The display name retrieved from the Windows optional feature.

Examples

• Enable the specified Windows optional feature and output logs to the specified path

WindowsOptionalFeatureSet

Provides a mechanism to configure and manage multiple WindowsOptionalFeature resources on a target node. This resource works on Nano Server.

Requirements

• Target machine must be running a Windows client operating system, Windows Server 2012 or later, or Nano Server.
• Target machine must have access to the DISM PowerShell module.

Parameters

• [String[]] Name (Key): The names of the Windows optional features to enable or disable.

The following parameters will be the same for each Windows optional feature in the set:

• [String] Ensure (Write): Specifies whether the Windows optional features should be enabled or disabled. To enable the features, set this property to Present. To disable the features, set this property to Absent. { Present | Absent }.
• [Boolean] RemoveFilesOnDisable (Write): Specifies whether or not to remove the files associated with the Windows optional features when they are disabled.
• [Boolean] NoWindowsUpdateCheck (Write): Specifies whether or not DISM should contact Windows Update (WU) when searching for the source files to restore Windows optional features on an online image.
• [String] LogPath (Write): The file path to which to log the operation.
• [String] LogLevel (Write): The level of detail to include in the log. { ErrorsOnly | ErrorsAndWarning | ErrorsAndWarningAndInformation }.

Read-Only Properties from Get-TargetResource

None

Examples

• Enable multiple features
• Disable multiple features

WindowsPackageCab

Provides a mechanism to install or uninstall a package from a Windows cabinet (cab) file on a target node. This resource works on Nano Server.

Requirements

• Target machine must have access to the DISM PowerShell module

Parameters

• [String] Name (Key): The name of the package to install or uninstall.
• [String] Ensure (Required): Specifies whether the package should be installed or uninstalled. To install the package, set this property to Present. To uninstall the package, set the property to Absent. { Present | Absent }.
• [String] SourcePath (Required): The path to the cab file to install or uninstall the package from.
• [String] LogPath (Write): The path to a file to log the operation to. There is no default value, but if not set, the log will appear at %WINDIR%\Logs\Dism\dism.log.

Read-Only Properties from Get-TargetResource

None

Examples

• Install a cab file with the given name from the given path

WindowsProcess

Provides a mechanism to start and stop a Windows process.

Requirements

None

Parameters

• [String] Path (Key): The executable file of the process. This can be defined as either the full path to the file or as the name of the file if it is accessible through the environment path. Relative paths are not supported.
• [String] Arguments (Key): A single string containing all the arguments to pass to the process. Pass in an empty string if no arguments are needed.
• [PSCredential] Credential (Write): The credential of the user account to run the process under. If this user is from the local system, the StandardOutputPath, StandardInputPath, and WorkingDirectory parameters cannot be provided at the same time.
• [String] Ensure (Write): Specifies whether or not the process should be running. To start the process, specify this property as Present. To stop the process, specify this property as Absent. { Present | Absent }.
• [String] StandardOutputPath (Write): The file path to which to write the standard output from the process. Any existing file at this file path will be overwritten. This property cannot be specified at the same time as Credential when running the process as a local user.
• [String] StandardErrorPath (Write): The file path to which to write the standard error output from the process. Any existing file at this file path will be overwritten.
• [String] StandardInputPath (Write): The file path from which to receive standard input for the process. This property cannot be specified at the same time as Credential when running the process as a local user.
• [String] WorkingDirectory (Write): The file path to the working directory under which to run the file. This property cannot be specified at the same time as Credential when running the process as a local user.

Read-Only Properties from Get-TargetResource

• [UInt64] PagedMemorySize (Read): The amount of paged memory, in bytes, allocated for the process.
• [UInt64] NonPagedMemorySize (Read): The amount of nonpaged memory, in bytes, allocated for the process.
• [UInt64] VirtualMemorySize (Read): The amount of virtual memory, in bytes, allocated for the process.
• [SInt32] HandleCount (Read): The number of handles opened by the process.
• [SInt32] ProcessId (Read): The unique identifier of the process.
• [SInt32] ProcessCount (Read): The number of instances of the given process that are currently running.

Examples

• Start a process
• Stop a process
• Start a process under a user
• Stop a process under a user

ProcessSet

Provides a mechanism to configure and manage multiple WindowsProcess resources on a target node.

Requirements

None

Parameters

• [String[]] Path (Key): The file paths to the executables of the processes to start or stop. Only the names of the files may be specified if they are all accessible through the environment path. Relative paths are not supported.

The following parameters will be the same for each process in the set:

• [PSCredential] Credential (Write): The credential of the user account to run the processes under. If this user is from the local system, the StandardOutputPath, StandardInputPath, and WorkingDirectory parameters cannot be provided at the same time.
• [String] Ensure (Write): Specifies whether or not the processes should be running. To start the processes, specify this property as Present. To stop the processes, specify this property as Absent. { Present | Absent }.
• [String] StandardOutputPath (Write): The file path to which to write the standard output from the processes. Any existing file at this file path will be overwritten. This property cannot be specified at the same time as Credential when running the processes as a local user.
• [String] StandardErrorPath (Write): The file path to which to write the standard error output from the processes. Any existing file at this file path will be overwritten.
• [String] StandardInputPath (Write): The file path from which to receive standard input for the processes. This property cannot be specified at the same time as Credential when running the processes as a local user.
• [String] WorkingDirectory (Write): The file path to the working directory under which to run the process. This property cannot be specified at the same time as Credential when running the processes as a local user.

Read-Only Properties from Get-TargetResource

• [UInt64] PagedMemorySize (Read): The amount of paged memory, in bytes, allocated for the processes.
• [UInt64] NonPagedMemorySize (Read): The amount of nonpaged memory, in bytes, allocated for the processes.
• [UInt64] VirtualMemorySize (Read): The amount of virtual memory, in bytes, allocated for the processes.
• [SInt32] HandleCount (Read): The number of handles opened by the processes.
• [SInt32] ProcessId (Read): The unique identifier of the processes.
• [SInt32] ProcessCount (Read): The number of instances of the given processes that are currently running.

Examples

• Start multiple processes
• Stop multiple processes

Versions

Unreleased

• User
  • Fixed Test-TargetResource throws System.InvalidOperationException when defined user lacks login permissions - Fixes Issue #116

2.10.0.0

• Fixed CompanyName typo - Fixes Issue #100
• Update LICENSE file to match the Microsoft Open Source Team standard - Fixes Issue #120.
• Update CommonResourceHelper unit tests to meet Pester 4.0.0 standards (issue #129).
• Update ResourceHelper unit tests to meet Pester 4.0.0 standards (issue #129).
• Ported fixes from xPSDesiredStateConfiguration:
  • xArchive
    • Fix end-to-end tests.
    • Update integration tests to meet Pester 4.0.0 standards.
    • Update end-to-end tests to meet Pester 4.0.0 standards.
    • Update unit and integration tests to meet Pester 4.0.0 standards.
    • Wrapped all path and identifier strings in verbose messages with quotes to make it easier to identify the limit of the string when debugging.
    • Refactored date/time checksum code to improve testability and ensure tests can run on machines with localized datetime formats that are not US.
    • Fix 'Get-ArchiveEntryLastWriteTime' to return [datetime].
    • Improved verbose logging to make debugging path issues easier.
• Added .gitattributes file to ensure CRLF settings are configured correctly for the repository.
• Updated '.vscode\settings.json' to refer to AnalyzerSettings.psd1 so that custom syntax problems are highlighted in Visual Studio Code.
• Fixed style guideline violations in CommonResourceHelper.psm1.
• Updated 'appveyor.yml' to meet more recent standards.
• Removed OS image version from 'appveyor.yml' to use default image (Issue #127).
• Removed code to install WMF5.1 from 'appveyor.yml' because it is already installed in AppVeyor images (Issue #128).
• Removed .vscode from .gitignore so that Visual Studio code environment settings can be committed.
• Environment
  • Update tests to meet Pester 4.0.0 standards (issue #129).
• Group
  • Update tests to meet Pester 4.0.0 standards (issue #129).
  • Fix unit tests to run on Nano Server.
  • Refactored unit tests to enclude Context fixtures and change functions to Describe fixtures.
• GroupSet
  • Update tests to meet Pester 4.0.0 standards (issue #129).

2.9.0.0

• Added Description and Parameter description for composite resources

2.8.0.0

• Archive
  • Added handling of directory archive entries that end with a foward slash
  • Removed formatting of LastWriteTime timestamp and updated comparison of timestamps to handle dates in different formats
• WindowsProcess
  • Fix unreliable tests
• Updated Test-IsNanoServer to return false if Get-ComputerInfo fails
• Registry
  • Fixed bug when using the full registry drive name (e.g. HKEY_LOCAL_MACHINE) and using a key name that includes a drive with forward slashes (e.g. C:/)

2.7.0.0

• MsiPackage
  • Parse installation date from registry using invariant culture.
  • Fix a bug in unit test failing, when regional setting differs from English-US.

2.6.0.0

• Archive
  • Fixed a minor bug in the unit tests where sometimes the incorrect DateTime format was used.
• Added MsiPackage

2.5.0.0

• Enable codecov.io code coverage reporting
• Group
  • Added support for domain based group members on Nano server.
• Added the Archive resource
• Update Test-IsNanoServer cmdlet to properly test for a Nano server rather than the core version of PowerShell
• Registry
  • Fixed bug where an error was thrown when running Get-DscConfiguration if the registry already existed

2.4.0.0

• Cleaned User
• Updated User to have non-dependent unit tests.
• Ported fixes from xPSDesiredStateConfiguration:
  • WindowsProcess: Minor updates to integration tests
  • Registry: Fixed support for forward slashes in registry key names
• Group:
  • Group members in the "NT Authority", "BuiltIn" and "NT Service" scopes should now be resolved without an error. If you were seeing the errors "Exception calling ".ctor" with "4" argument(s): "Server names cannot contain a space character."" or "Exception calling ".ctor" with "2" argument(s): "Server names cannot contain a space character."", this fix should resolve those errors. If you are still seeing one of the errors, there is probably another local scope we need to add. Please let us know.
  • The resource will no longer attempt to resolve group members if Members, MembersToInclude, and MembersToExclude are not specified.
• Added Environment

2.3.0.0

• Updated manifest to include both WindowsOptionalFeature and WindowsOptionalFeatureSet instead of just WindowsOptionalFeature twice

2.2.0.0

• WindowsFeature:
  • Added Catch to ignore RuntimeException when importing ServerManager module. This solves the issue described here.
  • Updated unit tests.
• Added WindowsProcess
• CommonTestHelper:
  • Added Get-AppVeyorAdministratorCredential.
  • Added Set-StrictMode -'Latest' and $errorActionPreference -'Stop'.
• Service:
  • Updated resource module, unit tests, integration tests, and examples to reflect the changes made in xPSDesiredStateConfiguration.
• Group:
  • Updated resource module, examples, and integration tests to reflect the changes made in xPSDesiredStateConfiguration.
• Added Script.
• Added GroupSet, ServiceSet, WindowsFeatureSet, WindowsOptionalFeatureSet, and ProcessSet.
• Added Set-StrictMode -'Latest' and $errorActionPreference -'Stop' to Group, Service, User, WindowsFeature, WindowsOptionalFeature, WindowsPackageCab.
• Fixed bug in WindowsFeature in which is was checking the 'Count' property of an object that was not always an array.
• Cleaned Group and Service resources and tests.
• Added Registry.

2.1.0.0

• Added WindowsFeature.

2.0.0.0

• Initial release of PSDscResources.