This topic has not yet been rated - Rate this topic

Set-RDVirtualDesktopCollectionConfiguration

Updated: September 14, 2012

Applies To: Windows Server 2012

Set-RDVirtualDesktopCollectionConfiguration

Specifies configuration details for an existing virtual desktop collection.

Syntax

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

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

Parameter Set: DisableUserProfileDisks
Set-RDVirtualDesktopCollectionConfiguration -DisableUserProfileDisks [ <CommonParameters>]

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

Detailed Description

The Set-RDVirtualDesktopCollectionConfiguration cmdlet specifies configuraiton details for an existing virtual desktop collection.

Parameters

-AutoAssignPersonalVirtualDesktopToUser<Boolean>

Enables virtual desktops to be automatically associated with user accounts when creating a new personal virtual desktop collection.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ClientDeviceRedirectionOptions<RDClientDeviceRedirectionOptions>

Specifies client devices that may be redirected to the server in this collection. Valid values are None, AudioVideoPlayBack, AudioRecording, COMPort, PlugAndPlayDevice, SmartCard, Clipboard, LPTPort, Drive, TimeZone, and USBPort.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CollectionDescription<String>

Provides a meaningful description of the collection.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-CollectionName<String>

Specifies the name of the virtual desktop collection. This parameter is required.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ConnectionBroker<String>

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for this remote desktop deployment. If not supplied, defaults to the fully qualified domain name (FQDN) of the local host.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-CustomRdpProperty<String>

Specifies Remote Desktop Protocol (RDP) settings to include in the .rdp files for all RemoteApp programs and remote desktops published in this collection.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-DisableUserProfileDisks

Prevents the use of a user profile disk when configuring the collection. This parameter is required.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DiskPath<String>

Provides the path location for the user profile disk. This parameter is required.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-EnableUserProfileDisks

Enables the use of a user profile disk when configuring the collection. This parameter is required. A user profile disk stores user profile information in a separate virtual hard disk so that user profile settings are persistent across pooled virtual desktops.Enables the use of user profile disks

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ExcludeFilePath<String[]>

Specifies any file paths to be excluded when creating the user profile disk. By default the standard file and folder paths are created (for example, Documents, Music and so forth). Use this parameter with or without the ExcludeFolderPath parameter to prevent the specified file or folder paths from being created. This parameter overrides any identical values specified in the IncludeFilePath or IncludeFolderPath parameters.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ExcludeFolderPath<String[]>

Specifies any folder paths to be excluded when creating the user profile disk. By default the standard file and folder paths are created (for example, Documents, Music and so forth). Use this parameter with or without the ExcludeFilePath parameter to prevent the specified file or folder paths from being created. This parameter overrides any identical values specified in the IncludeFilePath or IncludeFolderPath parameters.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-GrantAdministrativePrivilege<Boolean>

Specifies whether to grant administrative privileges to the user account assigned to a given personal virtual desktop. (Applies only to personal virtual desktop collections.)

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IncludeFilePath<String[]>

Specifies file paths to include when creating the user profile disk. By default the standard file and folder paths are created (for example, Documents, Music and so forth). Use this parameter with or without the IncludeFolderPath parameter to create the specified file or folder paths on the user profile disk.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-IncludeFolderPath<String[]>

Specifies folder paths to include when creating the user profile disk. By default the standard file and folder paths are created (for example, Documents, Music and so forth). Use this parameter with or without the IncludeFilePath parameter to create the specified file or folder paths on the user profile disk.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-MaxUserProfileDiskSizeGB<Int32>

Specifies the maximum size (in gigabytes) for the user profile disk. This parameter is required.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RedirectAllMonitors<Boolean>

Specifies whether to redirect all client monitors to the remote session, or just a single monitor.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-RedirectClientPrinter<Boolean>

Specifies whether to redirect the client printers to the server printer.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-SaveDelayMinutes<Int32>

The delay before which a virtual desktop that is not in use should be saved.

Specifies the number of idle minutes after which to save the virtual desktop session.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-UserGroups<String[]>

Defines the list of domain groups and users that are authorized to connect to the collection.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Outputs

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

Null

None.

Examples

Example 1:

Description

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

Example 2:

Description

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

Example 3:

Description

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

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)