Edit

Share via

Set-RDVirtualDesktopCollectionConfiguration

Module:
RemoteDesktop Module

Changes configuration settings for a virtual desktop collection.

Syntax

General (Default) 

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

DisableUserProfileDisks 

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

EnableUserProfileDisks 

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

Description

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

Examples

Example 1: Change the save delay setting for a virtual desktop collection

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

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.

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

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

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.

Example 3: Change settings for a virtual desktop 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

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.

Parameters

-AutoAssignPersonalVirtualDesktopToUser

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

General
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:RDClientDeviceRedirectionOptions
Default value:None
Accepted values:None, AudioVideoPlayBack, AudioRecording, COMPort, PlugAndPlayDevice, SmartCard, Clipboard, LPTPort, Drive, TimeZone
Supports wildcards:False
DontShow:False

Parameter sets

General
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-CollectionDescription

Specifies a description for the collection.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

General
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-CollectionName

Specifies the name of a personal virtual desktop collection.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

General
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-DisableUserProfileDisks

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

DisableUserProfileDisks
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DiskPath

Specifies the path of the user profile disk.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnableUserProfileDisks
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnableUserProfileDisks
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnableUserProfileDisks
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnableUserProfileDisks
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

General
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnableUserProfileDisks
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnableUserProfileDisks
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-MaxUserProfileDiskSizeGB

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

EnableUserProfileDisks
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RedirectAllMonitors

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

General
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RedirectClientPrinter

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

General
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-SaveDelayMinutes

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

General
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-UserGroups

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

General
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

undefined