Remove-RdsSessionHost
从主机池中删除会话主机。
语法
Remove-RdsSessionHost
[-TenantName] <String>
[-HostPoolName] <String>
[-Name] <String>
[-Force]
[<CommonParameters>]
说明
Remove-RdsSessionHost cmdlet 从主机池中删除已注册的会话主机。 若要将会话主机重新注册到主机池,必须使用该主机池的有效注册信息重新安装代理。
如果会话主机具有活动的用户会话,此命令将失败。 若要完成删除会话主机,必须先使用 Invoke-RdsUserSessionLogoff cmdlet 从会话主机注销所有用户,或者使用 Force 参数重新运行 Remove-RdsSessionHost cmdlet。
运行此命令从永久性主机池中删除会话主机时,用户分配也会被删除。 这是将用户重新分配到持久主机池中的新会话主机的唯一方法。
示例
示例 1:删除没有活动会话的会话主机
PS C:\> Remove-RdsSessionhost -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sh1.contoso.com"
此命令从主机池中删除会话主机。 通过在不使用 Force 开关的情况下运行 Remove-RdsSessionHost cmdlet,仅当指定的会话主机上没有活动会话时,它才会成功。 若要强制用户注销会话主机,可以运行 Invoke-RdsUserSessionLogoff cmdlet。
示例 2:使用强制开关删除会话主机
PS C:\> Remove-RdsSessionhost -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sh1.contoso.com" -Force
此命令从主机池中删除会话主机。 通过使用 Force 开关运行 Remove-RdsSessionHost cmdlet,会话主机将立即从数据库中删除,以及用户会话信息。 这不会自动注销用户,如果用户在执行注销前意外断开了会话,则可能导致其会话状态丢失。
参数
-Force
强制删除会话主机,即使会话主机包含用户会话对象也是如此。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HostPoolName
HostPool 名称。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
SessionHost 名称。
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
输出
System.Object