COMMAND EVERYTHING.
Modifies configuration options for an existing session collection.
Microsoft RemoteDesktop reference: Modifies configuration options for an existing session 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-RDSessionCollectionConfiguration. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Windows / RemoteDesktop · Windows Server 2025 documentation; feature/module prerequisites apply
-ActiveSessionLimitMin- Specifies the maximum time, in minutes, an active session runs. After this period, the RD Session Host server ends the session.
-AuthenticateUsingNLA- Indicates whether to use Network Level Authentication (NLA). If this value is $True, Remote Desktop uses NLA to authenticate a user before the user sees a logon screen.
-AutomaticReconnectionEnabled- Indicates whether the Remote Desktop client attempts to reconnect after a connection interruption.
-BrokenConnectionAction- Specifies an action for an RD Session Host server to take after a connection interruption. The acceptable values for this parameter are: - None - Disconnect - LogOff
-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 enum to specify multiple client device types.
-ClientPrinterAsDefault- Indicates whether to use the client printer or server printer as the default printer. If this value is $True, use the client printer as default. If this value is $False, use the server as default.
-ClientPrinterRedirected- Indicates whether to use client printer redirection, which routes print jobs from the Remote Desktop session to a printer attached to the client computer.
-CollectionDescription- Specifies a description of the session collection.
-CollectionName (required)- Specifies the name of a session 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 Windows Server 2012 RemoteApp programs and remote desktops published in this collection.
-DisableUserProfileDisk (required)- Indicates that Remote Desktop does not use a user profile to configure the session collection.
-DisconnectedSessionLimitMin- Specifies a length of time, in minutes. After client disconnection from a session for this period, the RD Session Host ends the session.
-DiskPath (required)- Specifies a path for the user profile disk.
-EnableUserProfileDisk (required)- Indicates that Remote Desktop uses a user profile disk to configure the session collection. A user profile disk stores user profile information as a separate virtual hard disk in order to persist user profile settings across a pool of virtual desktops.
-EncryptionLevel- Specifies the level of data encryption used for a Remote Desktop session. The acceptable values for this parameter are: - 0 - Low. - 1 - ClientCompatible. - 2 - High. - 3 - FipsCompliant. The default value is ClientCompatible.
-ExcludeFilePath- Specifies an array of file paths to exclude from a user profile disk. By default, Remote Desktop creates standard file and folder paths, such as Documents and Music. Use this parameter to prevent creation of specified file paths. This parameter overrides any identical values specified in the IncludeFilePath or IncludeFolderPath parameters.
-ExcludeFolderPath- Specifies an array of folder paths to exclude from a user profile disk. By default, Remote Desktop creates standard file and folder paths, such as Documents and Music. Use this parameter to prevent creation of specified folder paths. This parameter overrides any identical values specified in the IncludeFilePath or IncludeFolderPath parameters.
-IdleSessionLimitMin- Specifies the length of time, in minutes, to wait before an RD Session Host logs off or disconnects an idle session. The BrokenConnectionAction parameter determines whether to log off or disconnect.
-IncludeFilePath- Specifies an array of file paths to include in a user profile disk.
-IncludeFolderPath- Specifies an array of folder paths to include in a user profile disk.
-LoadBalancing- Specifies an array of objects that defines load balancing guidelines for the remote session collection. Each object specifies the collection name, RD Session Host server name, relative weight to use for that server, and a maximum number of sessions to allow.
-MaxRedirectedMonitors- Specifies the maximum number of client monitors that an RD Session Host server can redirect to a remote session. The highest value for this parameter is 16.
-MaxUserProfileDiskSizeGB (required)- Specifies the maximum size, in gigabytes, for a user profile disk.
-RDEasyPrintDriverEnabled- Specifies whether to enable the Remote Desktop Easy Print driver.
-SecurityLayer- Specifies which security protocol to use. The acceptable values for this parameter are: - 0 - RDP. - 1 - Negotiate. - 2 - SSL. The default value is Negotiate.
-TemporaryFoldersDeletedOnExit- Specifies whether to delete temporary folders from the RD Session Host server for a disconnected session.
-TemporaryFoldersPerSession- Specifies whether to use a single folder for temporary files. If this value is $True, a single folder contains temporary files. If this value is $False, individual users have separate folders to store temporary files.
-UserGroup- Specifies an array of domain groups and users authorized to connect to the RD Session Host servers in a session collection.
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.
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.