xPSDesiredStateConfiguration

master: dev :

The xPSDesiredStateConfiguration module is a more recent, experimental version of the PSDesiredStateConfiguration module that ships in Windows as part of PowerShell 4.0.

The high quality, supported version of this module is available as PSDscResources.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Contributing

If you would like to contribute to this module, please review the common DSC Resources contributing guidelines.

Resources

• xArchive 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.
• xDscWebService configures an OData endpoint for DSC service to make a node a DSC pull server.
• xEnvironment provides a mechanism to configure and manage environment variables for a machine or process.
• xFileUpload is a composite resource which ensures that local files exist on an SMB share.
• xGroup provides a mechanism to manage local groups on a target node.
• xGroupSet provides a mechanism to configure and manage multiple xGroup resources with common settings but different names.
• xMsiPackage provides a mechanism to install and uninstall .msi packages.
• xPackage manages the installation of .msi and .exe packages.
• xRegistry provides a mechanism to manage registry keys and values on a target node.
• xRemoteFile ensures the presence of remote files on a local machine.
• xScript provides a mechanism to run PowerShell script blocks on a target node.
• xService provides a mechanism to configure and manage Windows services.
• xServiceSet provides a mechanism to configure and manage multiple xService resources with common settings but different names.
• xUser provides a mechanism to manage local users on the target node.
• xWindowsFeature provides a mechanism to install or uninstall Windows roles or features on a target node.
• xWindowsFeatureSet provides a mechanism to configure and manage multiple xWindowsFeature resources on a target node.
• xWindowsOptionalFeature provides a mechanism to enable or disable optional features on a target node.
• xWindowsOptionalFeatureSet provides a mechanism to configure and manage multiple xWindowsOptionalFeature resources on a target node.
• xWindowsPackageCab provides a mechanism to install or uninstall a package from a Windows cabinet (cab) file on a target node.
• xWindowsProcess provides a mechanism to start and stop a Windows process.
• xProcessSet allows starting and stopping of a group of windows processes with no arguments.

Resources that work on Nano Server:

• xGroup
• xService
• xScript
• xUser
• xWindowsOptionalFeature
• xWindowsOptionalFeatureSet
• xWindowsPackageCab

xArchive

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 Checksum method is ModifiedDate. 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

xDscWebService

• EndpointName: The desired web service name.
• CertificateThumbPrint: Certificate thumbprint for creating an HTTPS endpoint. Use "AllowUnencryptedTraffic" for setting up a non SSL based endpoint.
• Port: Port for web service.
• PhysicalPath: Folder location where the content of the web service resides.
• Ensure: Ensures that the web service is Present or Absent
• State: State of the web service: { Started | Stopped }
• ModulePath: Folder location where DSC resources are stored.
• ConfigurationPath: Folder location where DSC configurations are stored.
• RegistrationKeyPath: Folder location where DSC pull server registration key file is stored.
• AcceptSelfSignedCertificates: Whether self signed certificate can be used to setup pull server.
• UseSecurityBestPractices: Whether to use best practice security settings for the node where pull server resides on. Caution: Setting this property to $true will reset registry values under "HKLM:\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL". This environment change enforces the use of stronger encryption cypher and may affect legacy applications. More information can be found at https://support.microsoft.com/en-us/kb/245030 and https://technet.microsoft.com/en-us/library/dn786418(v=ws.11).aspx.
• DisableSecurityBestPractices: The items that are excepted from following best practice security settings.

xGroup

Provides a mechanism to manage local groups on the 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

• Remove members from a group
• Set the members of a group

xGroupSet

Provides a mechanism to configure and manage multiple xGroup 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

xWindowsProcess

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 process. 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

xProcessSet

Provides a mechanism to configure and manage multiple xWindowsProcess 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

xService

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

Requirements

None

Parameters

• [String] Name (Key): Indicates the service name. 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.
• [String] Ensure (Write): Indicates whether the service is present or absent. { Present | Absent }.
• [String] Path (Write): The path to the service executable file. Required when creating a service. The user account specified by BuiltInAccount or Credential must have access to this path in order to start the service.
• [String] DisplayName (Write): The display name of the service.
• [String] Description (Write): The description of the service.
• [String[]] Dependencies (Write): The names of the dependencies of the service.
• [String] BuiltInAccount (Write): The built-in account the service 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 path defined by Path in order to start the service. { LocalService | LocalSystem | NetworkService }.
• [PSCredential] Credential (Write): The credential of the user account the service 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 path defined by Path in order to start the service.
• [Boolean] DesktopInteract (Write): Indicates whether or not the service should be able to communicate with a window on the desktop. Must be false for services not running as LocalSystem. The default value is False.
• [String] StartupType (Write): The startup type of the service. { Automatic | Disabled | Manual }. If StartupType is "Disabled" and Service is not installed the resource will complete as being DSC compliant.
• [String] State (Write): The state of the service. { Running | Stopped | Ignore }.
• [Uint32] StartupTimeout (Write): The time to wait for the service to start in milliseconds. Defaults to 30000 (30 seconds).
• [Uint32] TerminateTimeout (Write): The time to wait for the service to stop in milliseconds. Defaults to 30000 (30 seconds).

Read-Only Properties from Get-TargetResource

None

Examples

• Create a service
• Delete a service

xServiceSet

Provides a mechanism to configure and manage multiple xService 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

xRemoteFile

• DestinationPath: Path where the remote file should be downloaded. Required.
• Uri: URI of the file which should be downloaded. It must be a HTTP, HTTPS or FILE resource. Required.
• UserAgent: User agent for the web request. Optional.
• Headers: Headers of the web request. Optional.
• Credential: Specifies credential of a user which has permissions to send the request. Optional.
• MatchSource: Determines whether the remote file should be re-downloaded if file in the DestinationPath was modified locally. Optional.
• TimeoutSec: Specifies how long the request can be pending before it times out. Optional.
• Proxy: Uses a proxy server for the request, rather than connecting directly to the Internet resource. Should be the URI of a network proxy server (e.g 'http://10.20.30.1'). Optional.
• ProxyCredential: Specifies a user account that has permission to use the proxy server that is specified by the Proxy parameter. Optional.
• Ensure: Says whether DestinationPath exists on the machine. It's a read only property.

xPackage

• Ensure: Ensures that the package is Present or Absent.
• Name: The name of the package.
• Path: The source path of the package.
• ProductId: The product ID of the package (usually a GUID).
• Arguments: Command line arguments passed on the installation command line.
  • When installing MSI packages, the /quiet and /norestart arguments are automatically applied.
• Credential: PSCredential needed to access Path.
• ReturnCode: An array of return codes that are returned after a successful installation.
• LogPath: The destination path of the log.
• FileHash: The hash that should match the hash of the package file.
• HashAlgorithm: The algorithm to use to get the hash of the package file.
  • Supported values: SHA1, SHA256, SHA384, SHA512, MD5, RIPEMD160
• SignerSubject: The certificate subject that should match that of the package file's signing certificate.
• SignerThumbprint: The certificate thumbprint that should match that of the package file's signing certificate.
• ServerCertificateValidationCallback: A callback function to validate the server certificate.
• RunAsCredential: Credential used to install the package on the local system.

Read-Only Properties from Get-TargetResource

• PackageDescription: A text description of the package being installed.
• Publisher: Publisher's name.
• InstalledOn: Date of installation.
• Size: Size of the installation.
• Version: Version of the package.
• Installed: Is the package installed?

xMsiPackage

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

xFileUpload

• DestinationPath: Path where the local file should be uploaded.
• SourcePath: Path to the local file which should be uploaded.
• Credential: PSCredential for the user with access to DestinationPath.
• CertificateThumbprint: Thumbprint of the certificate which should be used for encryption/decryption.

xEnvironment

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

xScript

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 xScript

xRegistry

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

xUser

Provides a mechanism to manage local users on a target node.

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 enabled. Set this property to $true to ensure that this account is disabled, and set it to $false to ensure that it is enabled.
  • Suported values: $true, $false
  • Default value: $false
• [String] Ensure (Write): Ensures that the feature is present or absent.
  • Supported values: Present, Absent
  • Default Value: Present
• [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.
  • Suported values: $true, $false
  • Default value: $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 the password.
  • Suported values: $true, $false
  • Default value: $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, and set it to $false if the password will expire.
  • Suported values: $true, $false
  • Default value: $false

Examples

• Create a new User

xWindowsFeature

Provides a mechanism to install or uninstall Windows roles or features 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): 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): Set this property to $true to ensure the state of all required subfeatures with the state of the feature you specify with the Name property. 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

xWindowsFeatureSet

Provides a mechanism to configure and manage multiple xWindowsFeature 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

xWindowsOptionalFeature

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

xWindowsOptionalFeatureSet

Provides a mechanism to configure and manage multiple xWindowsOptionalFeature 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

xWindowsPackageCab

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

Functions

Publish-ModuleToPullServer

Publishes a 'ModuleInfo' object(s) to the pullserver module repository or user provided path. It accepts its input from a pipeline so it can be used in conjunction with Get-Module as Get-Module | Publish-Module

Publish-MOFToPullServer

Publishes a 'FileInfo' object(s) to the pullserver configuration repository. It accepts FileInfo input from a pipeline so it can be used in conjunction with Get-ChildItem .*.mof | Publish-MOFToPullServer

Versions

Unreleased

• xService
  • Fixed an issue where services that are not installed but StartupType is "Disabled" in resource will error for not being installed. Change will now return as being in compliance.

6.4.0.0

• xGroup:
  • Added updates from PSDscResources:
    • Added support for domain based group members on Nano server

6.3.0.0

• xDSCWebService
  • Fixed an issue where all 64bit IIS application pools stop working after installing DSC Pull Server, because IISSelfSignedCertModule(32bit) module was registered without bitness32 precondition.

6.2.0.0

• xMsiPackage:
  • Created high quality MSI package manager resource
• xArchive:
  • Fixed a minor bug in the unit tests where sometimes the incorrect DateTime format was used.
• xWindowsFeatureSet:
  • Had the wrong parameter name in one test case.

6.1.0.0

• Moved DSC pull server setup tests to DSCPullServerSetup folder for new common tests
• xArchive:
  • Updated the resource to be a high quality resource
  • Transferred the existing "unit" tests to integration tests
  • Added unit and end-to-end tests
  • Updated documentation and examples
• xUser
  • Fixed error handling in xUser
• xRegistry
  • Fixed bug where an error was thrown when running Get-DscConfiguration if the registry key already existed
• Updated Test-IsNanoServer cmdlet to properly test for a Nano server rather than the core version of PowerShell

6.0.0.0

• xEnvironment
  • Updated resource to follow HQRM guidelines.
  • Added examples.
  • Added unit and end-to-end tests.
  • Significantly cleaned the resource.
  • Minor Breaking Change where the resource will now throw an error if no value is provided, Ensure is set to present, and the variable does not exist, whereas before it would create an empty registry key on the machine in this case (if this is the desired outcome then use the Registry resource).
  • Added a new Write property 'Target', which specifies whether the user wants to set the machine variable, the process variable, or both (previously it was setting both in most cases).
• xGroup:
  • 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.

5.2.0.0

• xWindowsProcess
  • Minor updates to integration tests because one of the tests was flaky.
• xRegistry:
  • Added support for forward slashes in registry key names. This resolves issue #285.

5.1.0.0

• xWindowsFeature:
  • Added Catch to ignore RuntimeException when importing ServerManager module. This resolves issue #69.
  • Updated unit tests.
• xPackage:
  • No longer checks for package installation when a reboot is required. This resolves issue #52.
  • Ensures a space is added to MSI installation arguments. This resolves issue #195.
  • Adds RunAsCredential parameter to permit installing packages with specific user account. This resolves issue #221.
  • Fixes null verbose log output error. This resolves issue #224.
• xDSCWebService
  • Fixed issue where resource would fail to read redirection.config file. This resolves issue [#191] (dsccommunity#191)
• xArchive
  • Fixed issue where resource would throw exception when file name contains brackets. This resolves issue #255.
• xScript
  • Cleaned resource for high quality requirements
  • Added unit tests
  • Added integration tests
  • Updated documentation and example
• ResourceSetHelper:
  • Updated common functions for all 'Set' resources.
  • Added unit tests
• xGroupSet:
  • Updated resource to use new ResouceSetHelper functions and added integration tests.
• xGroup:
  • Cleaned module imports, fixed PSSA issues, and set ErrorActionPreference to stop.
• xService:
  • Cleaned resource functions to enable StrictMode.
  • Fixed bug in which Set-TargetResource would create a service when Ensure set to Absent and Path specified.
  • Added unit tests.
  • Added integration tests for BuiltInAccount and Credential.
• xServiceSet:
  • Updated resource to use new ResouceSetHelper functions and added integration tests.
  • Updated documentation and example
• xWindowsProcess
  • Cleaned resource as per high quality guidelines.
  • Added unit tests.
  • Added integration tests.
  • Updated documentation.
  • Updated examples.
  • Fixed bug in Get-TargetResource.
  • Added a 'Count' value to the hashtable returned by Get-TargetResource so that the user can see how many instances of the process are running.
  • Fixed bug in finding the path to the executable.
  • Changed name to be xWindowsProcess everywhere.
• xWindowsOptionalFeatureSet
  • Updated resource to use new ResouceSetHelper functions and added integration tests.
  • Updated documentation and examples
• xWindowsFeatureSet
  • Updated resource to use new ResouceSetHelper functions and added integration tests.
  • Updated documentation and examples
• xProcessSet
  • Updated resource to use new ResouceSetHelper functions and added integration tests.
  • Updated documentation and examples
• xRegistry
  • Updated resource to be high-quality
  • Fixed bug in which the user could not set a Binary registry value to 0
  • Added unit and integration tests
  • Added examples and updated documentation

5.0.0.0

• xWindowsFeature:
  • Cleaned up resource (PSSA issues, formatting, etc.)
  • Added/Updated Tests and Examples
  • BREAKING CHANGE: Removed the unused Source parameter
  • Updated to a high quality resource
• xDSCWebService:
  • Add DatabasePath property to specify a custom database path and enable multiple pull server instances on one server.
  • Rename UseUpToDateSecuritySettings property to UseSecurityBestPractices.
  • Add DisableSecurityBestPractices property to specify items that are excepted from following best practice security settings.
• xGroup:
  • Fixed PSSA issues
  • Formatting updated as per style guidelines
  • Missing comment-based help added for Get-/Set-/Test-TargetResource
  • Typos fixed in Unit test script
  • Unit test 'Get-TargetResource/Should return hashtable with correct values when group has no members' updated to handle the expected empty Members array correctly
  • Added a lot of unit tests
  • Cleaned resource
• xUser:
  • Fixed PSSA/Style violations
  • Added/Updated Tests and Examples
• Added xWindowsPackageCab
• xService:
  • Fixed PSSA/Style violations
  • Updated Tests
  • Added 'Ignore' state

4.0.0.0

• 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.
• 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

3.13.0.0

• Converted appveyor.yml to install Pester from PSGallery instead of from Chocolatey.
• Updated appveyor.yml to use the default image.
• Merged xPackage with in-box Package resource and added tests.
• xPackage: Re-implemented parameters for installation check from registry key value.
• xGroup:
  • Fixed Verbose output in Get-MembersAsPrincipals function.
  • Fixed bug when credential parameter passed does not contain local or domain context.
  • Fixed logic bug in MembersToInclude and MembersToExclude.
  • Fixed bug when trying to include the built-in Administrator in Members.
  • Fixed bug where Test-TargetResource would check for members when none specified.
  • Fix bug in Test-TargetResourceOnFullSKU function when group being set to a single member.
  • Fix bug in Set-TargetResourceOnFullSKU function when group being set to a single member.
  • Fix bugs in Assert-GroupNameValid to throw correct exception.
• xService
  • Updated xService resource to allow empty string for Description parameter.
• Merged xProcess with in-box Process resource and added tests.
• Fixed PSSA issues in xPackageResource.

3.12.0.0

• Removed localization for now so that resources can run on non-English systems.

3.11.0.0

• xRemoteFile: Added parameters: - TimeoutSec - Proxy - ProxyCredential Added unit tests. Corrected Style Guidelines issues. Added Localization support. URI parameter supports File://. Get-TargetResource returns URI parameter. Fixed logging of error message reported when download fails. Added new example Sample_xRemoteFileUsingProxy.ps1.
• Examples: Fixed missing newline at end of PullServerSetupTests.ps1.
• xFileUpload: Added PSSA rule suppression attribute.
• xPackageResource: Removed hardcoded ComputerName 'localhost' parameter from Get-WMIObject to eliminate PSSA rule violation. The parameter is not required.
• Added .gitignore to prevent DSCResource.Tests from being commited to repo.
• Updated AppVeyor.yml to use WMF 5 build OS so that latest test methods work.
• Updated xWebService resource to not deploy Devices.mdb if esent provider is used
• Fixed $script:netsh parameter initialization in xWebService resource that was causing CIM exception when EnableFirewall flag was specified.
• xService:
  • Fixed a bug where, despite no state specified in the config, the resource test returns false if the service is not running
  • Fixed bug in which Automatice StartupType did not match the 'Auto' StartMode in Test-TargetResource.
• xPackage: Fixes bug where CreateCheckRegValue was not being removed when uninstalling packages
• Replaced New-NetFirewallRule cmdlets with netsh as this cmdlet is not available by default on some downlevel OS such as Windows 2012 R2 Core.
• Added the xEnvironment resource
• Added the xWindowsFeature resource
• Added the xScript resource
• Added the xUser resource
• Added the xGroupSet resource
• Added the xProcessSet resource
• Added the xServiceSet resource
• Added the xWindowsFeatureSet resource
• Added the xWindowsOptionalFeatureSet resource
• Merged the in-box Service resource with xService and added tests for xService
• Merged the in-box Archive resource with xArchive and added tests for xArchive
• Merged the in-box Group resource with xGroup and added tests for xGroup

3.10.0.0

• Publish-ModuleToPullServer
• Publish-MOFToPullServer

3.9.0.0

• Added more information how to use Publish-DSCModuleAndMof cmdlet and samples
• Removed compliance server samples

3.8.0.0

• Added Pester tests to validate pullserver deployement.
• Removed Compliance Server deployment from xWebservice resource. Fixed database provider selection issue depending on OS flavor
• Added Publish-DSCModuleAndMof cmdlet to package DSC modules and mof and publish them on DSC enterprise pull server
• xRemoteFile resource: Added size verification in cache

3.7.0.0

• xService:
  • Fixed a bug where 'Dependencies' property was not picked up and caused exception when set.
• xWindowsOptionalFeature:
  • Fixed bug where Test-TargetResource method always failed.
  • Added support for Windows Server 2012 (and later) SKUs.
• Added xRegistry resource

3.6.0.0

• Added CreateCheckRegValue parameter to xPackage resource
• Added MatchSource parameter to xRemoteFile resource

3.5.0.0

• MSFT_xPackageResource: Added ValidateSet to Get/Set/Test-TargetResource to match MSFT_xPackageResource.schema.mof
• Fixed bug causing xService to throw error when service already exists
• Added StartupTimeout to xService resource
• Removed UTF8 BOM
• Added code for pull server removal

3.4.0.0

• Added logging inner exception messages in xArchive and xPackage resources
• Fixed hash calculation in Get-CacheEntry
• Fixed issue with PSDSCComplianceServer returning HTTP Error 401.2

3.3.0.0

• Add support to xPackage resource for checking different registry hives
• Added support for new registration properties in xDscWebService resource

3.2.0.0

• xArchive:
  • Fix problems with file names containing square brackets.
• xDSCWebService:
  • Fix default culture issue.
• xPackage:
  • Security enhancements.

3.0.3.4

• Multiple issues addressed
  • Corrected output type for Set- and Test-TargetResource functions in xWebSite, xPackage, xArchive, xGroup, xProcess, xService
  • xRemoteFile modified to support creating a directory that does not exist when specified, ensuring idempotency. Also improved error messages.
  • xDSCWebService updated so that Get-TargetResource returns the OData Endpoint URL correctly.
  • In xWindowsOptionalFeature, fixed Test-TargetResource issue requiring Ensure = True.
    • Note: this change requires the previous Ensure values of Enable and Disable to change to Present and Absent

3.0.2.0

• Adding following resources:
  • xGroup

3.0.1.0

• Adding following resources:
  • xFileUpload

2.0.0.0

• Adding following resources:
  • xWindowsProcess
  • xService
  • xRemoteFile
  • xPackage

1.1.0.0

• Fix to remove and recreate the SSL bindings when performing a new HTTPS IIS Endpoint setup.
• Fix in the resource module to consume WebSite Name parameter correctly

1.0.0.0

• Initial release with the following resources:
  • DscWebService

Examples

Change the name and the workgroup name

This configuration will set a machine name and change its workgroup.

Switch from a workgroup to a domain

This configuration sets the machine name and joins a domain. Note: this requires a credential.

Change the name while staying on the domain

This example will change the machines name while remaining on the domain. Note: this requires a credential.

Change the name while staying on the workgroup

This example will change a machine's name while remaining on the workgroup.

Switch from a domain to a workgroup

This example switches the computer from a domain to a workgroup. Note: this requires a credential.

Download file from URI, specifying headers and user agent

This configuration will download a file from a specific URI to DestinationPath. The web request will contain specific headers and will be sent using a specified user agent.

Upload file to an SMB share

This configuration will upload a file from SourcePath to the remote DestinationPath. Username and password will be used to access the DestinationPath.

Sample1.ps1 installs a package that uses an .exe file

This configuration will install a .exe package, verifying the package using the package name.

Sample1.ps2 installs a package that uses an .exe file

This configuration will install a .exe package and verify the package using the product ID and package name.

Sample1.ps3 installs a package that uses an .msi file

This configuration will install a .msi package and verify the package using the product ID and package name and requires credentials to read the share and install the package.

Sample1.ps4 installs a package that uses an .exe file

This configuration will install a .exe package and verify the package using the product ID and package name and requires credentials to read the share and install the package. It also uses custom registry values to check for the package presence.

Validate pullserver deployement

If Sample_xDscWebService.ps1 is used to setup a DSC pull and reporting endpoint, the service endpoint can be validated by performing Invoke-WebRequest -URI http://localhost:8080/PSDSCPullServer.svc/$metadata in PowerShell or http://localhost:8080/PSDSCPullServer.svc/ when using InternetExplorer.

Pullserver Validation Pester Tests