Set-RDVirtualDesktopCollectionConfiguration

Set-RDVirtualDesktopCollectionConfiguration

Changes configuration settings for a virtual desktop collection.

Syntax

Parameter Set: General
Set-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> [-AutoAssignPersonalVirtualDesktopToUser <Boolean> ] [-ClientDeviceRedirectionOptions <RDClientDeviceRedirectionOptions> ] [-CollectionDescription <String> ] [-ConnectionBroker <String> ] [-CustomRdpProperty <String> ] [-GrantAdministrativePrivilege <Boolean> ] [-RedirectAllMonitors <Boolean> ] [-RedirectClientPrinter <Boolean> ] [-SaveDelayMinutes <Int32> ] [-UserGroups <String[]> ] [ <CommonParameters>]

Parameter Set: DisableUserProfileDisks
Set-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> -DisableUserProfileDisks [-ConnectionBroker <String> ] [ <CommonParameters>]

Parameter Set: EnableUserProfileDisks
Set-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> -DiskPath <String> -EnableUserProfileDisks -MaxUserProfileDiskSizeGB <Int32> [-ConnectionBroker <String> ] [-ExcludeFilePath <String[]> ] [-ExcludeFolderPath <String[]> ] [-IncludeFilePath <String[]> ] [-IncludeFolderPath <String[]> ] [ <CommonParameters>]

Detailed Description

The Set-RDVirtualDesktopCollectionConfiguration cmdlet changes configuration settings for a virtual desktop collection.

Parameters

-AutoAssignPersonalVirtualDesktopToUser<Boolean>

Indicates that the server automatically associates virtual desktops with user accounts when you create a new personal virtual desktop collection.

-ClientDeviceRedirectionOptions<RDClientDeviceRedirectionOptions>

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.

-CollectionDescription<String>

Specifies a description for the collection.

-CollectionName<String>

Specifies the name of a personal virtual desktop collection.

-ConnectionBroker<String>

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<String>

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

Indicates that the server prevents you from using a user profile disk when you configure the collection.

-DiskPath<String>

Specifies the path of the user profile disk.

-EnableUserProfileDisks

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<String[]>

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<String[]>

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<Boolean>

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<String[]>

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<String[]>

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<Int32>

Specifies the maximum size, in gigabytes, for the user profile disk.

-RedirectAllMonitors<Boolean>

Indicates whether the server redirects all client monitors to the remote session. Specify $false to redirect a single monitor to the remote session.

-RedirectClientPrinter<Boolean>

Indicates whether the server redirects the client printers to the server printer.

-SaveDelayMinutes<Int32>

Specifies the delay, in minutes, before the server saves a virtual desktop that is not in use.

-UserGroups<String[]>

Specifies an array of user groups that are authorized to connect to the collection.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Null

  None.

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.

PS C:\> Set-RDVirtualDesktopCollectionConfiguration -ConnectionBroker "rdcb.contoso.com" -CollectionName "Virtual Desktop Pool" -SaveDelayMinutes 5

Example 2: Change the user profile disk settings for a virtual desktop collection

This command enables a user profile disk for the virtual desktop collection named "Virtual Desktop Pool". The command specifies the maximum size of 10 gigabytes for the user profile disk and specifies the path of the user profile disk.

PS C:\> Set-RDVirtualDesktopCollectionConfiguration -ConnectionBroker "rdcb.contoso.com" -CollectionName "Virtual Desktop Pool" -EnableUserProfileDisks -MaxUserProfileDiskSizeGB 10 -DiskPath "\\RDS-WKS-A27.contoso.com\uvhd"

Example 3: Change settings for a virtual desktop collection

This command changes configuration settings for the virtual desktop collection named "Virtual Desktop Pool". The command adds a description to the virtual desktop collection, specifies that the server redirects a single monitor to the remote session, and specifies that Remote Desktop Services redirect AudioVideoPlayBack and PlugAndPlayDevice client devices to the server in this collection.

PS C:\> Set-RDVirtualDesktopCollectionConfiguration -CollectionName "Virtual Desktop Pool" -CollectionDescription "Virtual Desktop Pool created using PowerShell" -RedirectAllMonitors $false -ConnectionBroker "rdcb.contoso.com" -ClientDeviceRedirectionOptions AudioVideoPlayBack,PlugAndPlayDevice

Related topics

Get-RDVirtualDesktopCollectionConfiguration

Get-RDVirtualDesktopCollection