Set-RdsHostPool

模块:: Microsoft.RDInfra.RDPowershell

设置主机池的属性。

语法

Set-RdsHostPool
   [-TenantName] <String>
   [-Name] <String>
   [-FriendlyName <String>]
   [-Description <String>]
   [-MaxSessionLimit <Int32>]
   [-ValidationEnv <bool>]
   [-AssignmentType {Automatic | Direct}]
   [<CommonParameters>]

Set-RdsHostPool
   [-TenantName] <String>
   [-Name] <String>
   [-BreadthFirstLoadBalancer]
   [-MaxSessionLimit <Int32>]
   [-ValidationEnv <bool>]
   [-AssignmentType {Automatic | Direct}]
   [<CommonParameters>]

Set-RdsHostPool
   [-TenantName] <String>
   [-Name] <String>
   [-DepthFirstLoadBalancer]
   -MaxSessionLimit <Int32>
   [-ValidationEnv <bool>]
    [-AssignmentType {Automatic | Direct}]
   [<CommonParameters>]

Set-RdsHostPool
   [-TenantName] <String>
   [-Name] <String>
   [-CustomRdpProperty <String>]
   [-ValidationEnv <bool>]
   [-AssignmentType {Automatic | Direct}]
   [<CommonParameters>]

Set-RdsHostPool
   [-TenantName] <String>
   [-Name] <String>
   [-ValidationEnv <bool>]
   [-Ring <int>]
   [-AssignmentType {Automatic | Direct}]
   [<CommonParameters>]

说明

Set-RdsHostPool cmdlet 设置指定主机池的属性。此 cmdlet 存在三个参数集。 First 用于禁用用户配置文件磁盘。第二个用于启用用户配置文件磁盘。第三个选项用于设置主机池的所有其他属性。

示例

示例 1：将主机池设置为使用深度优先负载均衡

PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoHostPool" -DepthFirstLoadBalancer -MaxSessionLimit 10

TenantName            : contoso
TenantGroupName       : Default Tenant Group
HostPoolName          : contosoHostPool
FriendlyName          :
Description           :
Persistent            : False
CustomRdpProperty     :
MaxSessionLimit       : 10
LoadBalancerType      : DepthFirst
ValidationEnv         : False
Ring                  : 
AssignmentType        :

此命令将主机池设置为使用深度优先负载均衡，以便所有传入用户都将被定向到特定会话主机，直到达到 MaxSessionLimit（在此示例中指定为 10）。在设置深度优先负载均衡时，需要 MaxSessionLimit 参数，因为在第一个会话主机上达到此会话限制之前，连接不会分发到后续会话主机。

示例 2：将主机池设置为使用广度优先负载均衡

PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoHostPool" -BreadthFirstLoadBalancer

TenantName            : contoso
TenantGroupName       : Default Tenant Group
HostPoolName          : contosoHostPool
FriendlyName          :
Description           :
Persistent            : False
CustomRdpProperty     :
MaxSessionLimit       : 10
LoadBalancerType      : BreadthFirst
ValidationEnv         : False
Ring                  : 
AssignmentType        :

此命令将主机池设置为使用广度优先负载均衡，以便传入用户将在主机池中的会话主机之间均匀定向。 MaxSessionLimit 参数是可选的，因为广度优先模式下的负载均衡比深度优先模式下的负载均衡限制更少。

示例 3：将主机池设置为验证环境

PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoHostPool" -ValidationEnv $true

TenantName            : contoso
TenantGroupName       : Default Tenant Group
HostPoolName          : contosoHostPool
FriendlyName          :
Description           :
Persistent            : False
CustomRdpProperty     : use multimon:i:0;
MaxSessionLimit       : 10
LoadBalancerType      : BreadthFirst
ValidationEnv         : True
Ring                  : 
AssignmentType        :

此命令将主机池设置为验证主机池。验证主机池将以更快的节奏接收服务更新，从而允许您在将任何服务更改广泛部署到生产环境中之前对其进行测试。

示例 4：将主机池设置为使用直接分配

PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Direct

TenantName            : contoso
TenantGroupName       : Default Tenant Group
HostPoolName          : contosoPersonalDesktops
FriendlyName          :
Description           :
Persistent            : True
CustomRdpProperty     : 
MaxSessionLimit       : 999999
LoadBalancerType      : Persistent
ValidationEnv         : False
Ring                  : 
AssignmentType        : Direct

此命令将主机池设置为使用直接分配来确定要分配用户的个人桌面会话主机。使用直接分配时，必须先将用户分配到会话主机，然后才能连接到主机池。

示例 5：将主机池设置为使用自动分配

PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Automatic

TenantName            : contoso
TenantGroupName       : Default Tenant Group
HostPoolName          : contosoPersonalDesktops
FriendlyName          :
Description           :
Persistent            : True
CustomRdpProperty     : 
MaxSessionLimit       : 999999
LoadBalancerType      : Persistent
ValidationEnv         : False
Ring                  : 
AssignmentType        : Automatic

此命令将主机池设置为使用自动分配来确定要分配用户的个人桌面会话主机。使用自动分配时，无需在连接到主机池之前将用户分配到会话主机。

示例 4：将主机池设置为使用直接分配

PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Direct

TenantName            : contoso
TenantGroupName       : Default Tenant Group
HostPoolName          : contosoPersonalDesktops
FriendlyName          :
Description           :
Persistent            : True
CustomRdpProperty     : 
MaxSessionLimit       : 999999
LoadBalancerType      : Persistent
ValidationEnv         : False
Ring                  : 
AssignmentType        : Direct

示例 5：将主机池设置为使用自动分配

PS C:\> Set-RdsHostPool -TenantName "contoso" -Name "contosoPersonalDesktops" -AssignmentType Automatic

TenantName            : contoso
TenantGroupName       : Default Tenant Group
HostPoolName          : contosoPersonalDesktops
FriendlyName          :
Description           :
Persistent            : True
CustomRdpProperty     : 
MaxSessionLimit       : 999999
LoadBalancerType      : Persistent
ValidationEnv         : False
Ring                  : 
AssignmentType        : Automatic

此命令将主机池设置为使用自动分配来确定要分配用户的个人桌面会话主机。使用自动分配时，无需在连接到主机池之前将用户分配到会话主机。

参数

-AssignmentType

个人桌面主机池的分配类型：

Automatic，这意味着用户将在首次连接到主机池时自动分配会话主机。
Direct，这意味着必须先将用户直接分配到池中的会话主机，然后才能进行连接。

类型:	PersonalDesktopAssignmentType
接受的值:	Automatic, Direct
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-BreadthFirstLoadBalancer

切换以启用主机池的广度优先负载均衡。 Breadth-first 表示新用户会话被定向到用户会话数最少的会话主机。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-CustomRdpProperty

指定要包含在此集合中发布的所有 RemoteApp 程序和远程桌面的 .rdp 文件中的远程桌面协议（RDP）设置。有关更多信息，请参阅支持的远程桌面 RDP 文件设置。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-DepthFirstLoadBalancer

切换以启用主机池的深度优先负载均衡。 Depth-first 表示新用户会话将定向到具有最高用户会话数但尚未达到其最大会话限制的会话主机。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-Description

主机池的描述。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-FriendlyName

要显示的主机池的友好名称。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-MaxSessionLimit

主机池中每个会话主机允许的最大会话数。当为负载均衡设置深度优先模式时，此值用于确定何时停止将用户负载均衡到一台主机，并开始将用户发送到下一台主机。

类型:	Int32
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Name

主机池的名称。

类型:	String
别名:	HostPoolName
Position:	1
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-TenantName

租户名称。

类型:	String
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-ValidationEnv

一个布尔值，指示是否应将主机池视为验证主机池。验证主机池以比非验证主机池更快的节奏接收服务更新，从而允许您在将服务更改广泛部署到生产环境之前对其进行测试。

类型:	String
Position:	Named
默认值:	False
必需:	False
接受管道输入:	True
接受通配符:	False

输入

System.String

输出

Microsoft.RDInfra.RDManagementData.RdMgmtHostPool

通过

Set-RdsHostPool

语法

说明

示例

示例 1：将主机池设置为使用深度优先负载均衡

示例 2：将主机池设置为使用广度优先负载均衡

示例 3：将主机池设置为验证环境

示例 4：将主机池设置为使用直接分配

示例 5：将主机池设置为使用自动分配

示例 4：将主机池设置为使用直接分配

示例 5：将主机池设置为使用自动分配

参数

-AssignmentType

-BreadthFirstLoadBalancer

-CustomRdpProperty

-DepthFirstLoadBalancer

-Description

-FriendlyName

-MaxSessionLimit

-Name

-TenantName

-ValidationEnv

输入

输出