Changes configuration settings for a virtual desktop collection.
PowerShell · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft RemoteDesktop reference: Changes configuration settings for a virtual desktop collection. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Set-RDVirtualDesktopCollectionConfiguration. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / RemoteDesktop · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-AutoAssignPersonalVirtualDesktopToUser
Indicates that the server automatically associates virtual desktops with user accounts when you create a new personal virtual desktop collection.
-ClientDeviceRedirectionOptions
Specifies a type of client device to be redirected to an RD Session Host server in this session collection. The acceptable values for this parameter are: - 0x0000. None. - 0x0001. AudioVideoPlayBack. - 0x0002. AudioRecording. - 0x0004. COMPort. - 0x0008. PlugAndPlayDevice. - 0x0010. SmartCard. - 0x0020. Clipboard. - 0x0040. LPTPort. - 0x0080. Drive. - 0x0100. TimeZone. You can use binary-or to combine two or more values of this enumeration to specify multiple client device types.
-CollectionDescription
Specifies a description for the collection.
-CollectionName (required)
Specifies the name of a personal virtual desktop collection.
-ConnectionBroker
Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a remote desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.
-CustomRdpProperty
Specifies Remote Desktop Protocol (RDP) settings to include in the .rdp files for all RemoteApp programs and remote desktops that you publish to this collection.
-DisableUserProfileDisks (required)
Indicates that the server prevents you from using a user profile disk when you configure the collection.
-DiskPath (required)
Specifies the path of the user profile disk.
-EnableUserProfileDisks (required)
Indicates that the server enables a user profile disk when you configure the collection. A user profile disk stores user profile information in a separate virtual hard disk and saves user profile settings across pooled virtual desktops.
-ExcludeFilePath
Specifies an array of file paths that the server excludes when it creates the user profile disk. By default, the server creates the standard file and folder paths, for example, Documents and Music. Use this parameter with or without the ExcludeFolderPath parameter to prevent the server from creating file or folder paths. This parameter overrides any identical values that you specify in the IncludeFilePath or IncludeFolderPath parameters.
-ExcludeFolderPath
Specifies an array of folder paths that the server excludes when it creates the user profile disk. By default, the server creates the standard file and folder paths, for example, Documents and Music. Use this parameter with or without the ExcludeFilePath parameter to prevent the server from creating file or folder paths. This parameter overrides any identical values that you specify in the IncludeFilePath or IncludeFolderPath parameters.
-GrantAdministrativePrivilege
Indicates whether the server grants administrative privileges to the user account that it assigns to a personal virtual desktop. This parameter applies only to personal virtual desktop collections.
-IncludeFilePath
Specifies an array of file paths that the server includes when it creates the user profile disk. By default, the server creates the standard file and folder paths, for example, Documents and Music. Use this parameter with or without the IncludeFolderPath parameter to create file or folder paths.
-IncludeFolderPath
Specifies an array of folder paths that the server excludes when it creates the user profile disk. By default, the server creates the standard file and folder paths, for example, Documents and Music. Use this parameter with or without the IncludeFilePath parameter to create file or folder paths.
-MaxUserProfileDiskSizeGB (required)
Specifies the maximum size, in gigabytes, for the user profile disk.
-RedirectAllMonitors
Indicates whether the server redirects all client monitors to the remote session. Specify $False to redirect a single monitor to the remote session.
-RedirectClientPrinter
Indicates whether the server redirects the client printers to the server printer.
-SaveDelayMinutes
Specifies the delay, in minutes, before the server saves a virtual desktop that is not in use.
-UserGroups
Specifies an array of user groups that are authorized to connect to the collection.
Prerequisites
Windows with the RemoteDesktop module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.
Examples
Example 1: Change the save delay setting for a virtual desktop collection
This command changes the save delay setting for the virtual desktop collection named Virtual Desktop Pool that is associated with the RD Connection Broker server named rdcb.contoso.com. The command specifies a delay of 5 minutes before the server saves a virtual desktop in the virtual desktop collection that is not in use. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.