Set-RdsSessionHost
设置会话主机的状态。
语法
Set-RdsSessionHost
[-TenantName] <String>
[-HostPoolName] <String>
[-Name] <String>
[-AllowNewSession]
[-AssignedUser]
[<CommonParameters>]
说明
Set-RdsSessionHost cmdlet 设置指定会话主机的状态。 可以禁用或启用与会话主机的新连接。 在会话主机上更改此属性不会影响会话主机上的任何用户会话。
示例
示例 1:禁用与会话主机的新连接 (,将主机设置为排出模式)
PS C:\> Set-RdsSessionHost -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sh1.contoso.com" -AllowNewSession $false
SessionHostName : sh1.contoso.com
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
AllowNewSession : False
Sessions : 1
LastHeartBeat : 1/1/2018 12:00:00 PM
AgentVersion : 1.0.0.1
AssignedUser :
Status : Available
StatusTimestamp : 1/1/2018 12:00:00 PM
此命令禁止会话主机接收任何新连接,并将其删除为负载均衡的候选项。 服务器上的任何现有会话将一直保留到用户注销为止。 管理员可以使用 Invoke-RdsUserSessionLogoff cmdlet 强制注销。
示例 2:启用与会话主机的新连接 (,即从排出模式中删除主机)
PS C:\> Set-RdsSessionHost -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sh1.contoso.com" -AllowNewSession $true
SessionHostName : sh1.contoso.com
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
AllowNewSession : True
Sessions : 1
LastHeartBeat : 1/1/2018 12:00:00 PM
AgentVersion : 1.0.0.1
AssignedUser :
Status : Available
StatusTimestamp : 1/1/2018 12:00:00 PM
此命令使会话主机能够接收新连接,并且现在是负载均衡的候选项。
示例 3:将用户分配到个人桌面会话主机
PS C:\> Set-RdsSessionHost -TenantName "contoso" -HostPoolName "contosoPersonalDesktops" -Name "sh1.contoso.com" -AssignedUser user1@contoso.com
SessionHostName : sh1.contoso.com
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonalDesktops
AllowNewSession : True
Sessions : 1
LastHeartBeat : 1/1/2018 12:00:00 PM
AgentVersion : 1.0.0.1
AssignedUser : user1@contoso.com
Status : Available
StatusTimestamp : 1/1/2018 12:00:00 PM
此命令将个人桌面主机池中的会话主机分配给 user1@contoso.com。 连接到池时,此用户现在将连接到此会话主机。
参数
-AllowNewSession
具有两个潜在值的开关:
- True,指定代理可以为会话主机分配新的用户会话。
- False,指定不会为会话主机分配任何新用户会话, (又称排出模式) 。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AssignedUser
要分配给个人桌面会话主机的用户。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HostPoolName
主机池的名称。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
完全限定的域名 (会话主机的 FQDN) 。
Type: | String |
Aliases: | SessionHostName |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-TenantName
租户的名称。
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
输入
System.String
输出
Microsoft.RDInfra.RDManagementData.RdMgmtSessionHost