Set-RDVirtualDesktopCollectionConfiguration
適用対象: Windows 10, Windows Server Technical Preview
Set-RDVirtualDesktopCollectionConfiguration
Changes configuration settings for a virtual desktop collection.
構文
Parameter Set: General
Set-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> [-AutoAssignPersonalVirtualDesktopToUser <Boolean> ] [-ClientDeviceRedirectionOptions <RDClientDeviceRedirectionOptions> {None | AudioVideoPlayBack | AudioRecording | COMPort | PlugAndPlayDevice | SmartCard | Clipboard | LPTPort | Drive | TimeZone} ] [-CollectionDescription <String> ] [-ConnectionBroker <String> ] [-CustomRdpProperty <String> ] [-GrantAdministrativePrivilege <Boolean> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [-RedirectAllMonitors <Boolean> ] [-RedirectClientPrinter <Boolean> ] [-SaveDelayMinutes <Int32> ] [-UserGroups <String[]> ] [ <CommonParameters>]
Parameter Set: DisableUserProfileDisks
Set-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> -DisableUserProfileDisks [-ConnectionBroker <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]
Parameter Set: EnableUserProfileDisks
Set-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> -DiskPath <String> -EnableUserProfileDisks -MaxUserProfileDiskSizeGB <Int32> [-ConnectionBroker <String> ] [-ExcludeFilePath <String[]> ] [-ExcludeFolderPath <String[]> ] [-IncludeFilePath <String[]> ] [-IncludeFolderPath <String[]> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]
詳細説明
The Set-RDVirtualDesktopCollectionConfiguration cmdlet changes configuration settings for a virtual desktop collection.
パラメーター
-AutoAssignPersonalVirtualDesktopToUser<Boolean>
Indicates that the server automatically associates virtual desktops with user accounts when you create a new personal virtual desktop collection.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-ClientDeviceRedirectionOptions<RDClientDeviceRedirectionOptions>
Specifies a type of client device to be redirected to an RD Session Host server in this session collection. このパラメーターに指定できる値は、次のとおりです。
-- 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.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-CollectionDescription<String>
Specifies a description for the collection.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-CollectionName<String>
Specifies the name of a personal virtual desktop collection.
Aliases |
none |
必須/オプション |
true |
位置 |
1 |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-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.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-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.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-DisableUserProfileDisks
Indicates that the server prevents you from using a user profile disk when you configure the collection.
Aliases |
none |
必須/オプション |
true |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-DiskPath<String>
Specifies the path of the user profile disk.
Aliases |
none |
必須/オプション |
true |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
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.
Aliases |
none |
必須/オプション |
true |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-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.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-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.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-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.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-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.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-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.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-InformationAction<System.Management.Automation.ActionPreference>
Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:
-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend
Aliases |
infa |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-InformationVariable<System.String>
Specifies a variable in which to store an information event message.
Aliases |
iv |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-MaxUserProfileDiskSizeGB<Int32>
Specifies the maximum size, in gigabytes, for the user profile disk.
Aliases |
none |
必須/オプション |
true |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-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.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-RedirectClientPrinter<Boolean>
Indicates whether the server redirects the client printers to the server printer.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-SaveDelayMinutes<Int32>
Specifies the delay, in minutes, before the server saves a virtual desktop that is not in use.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-UserGroups<String[]>
Specifies an array of user groups that are authorized to connect to the collection.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
<CommonParameters>
このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットが出力するオブジェクトの型です。
- Null
使用例
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