Remove-RdsSessionHost

Remove um host de sessão de um pool de hosts.

Sintaxe

Default (Predefinição)

Remove-RdsSessionHost
    [-TenantName] <String>
    [-HostPoolName] <String>
    [-Name] <String>
    [-Force]
    [<CommonParameters>]

Description

O cmdlet Remove-RdsSessionHost remove um host de sessão registrado do pool de hosts. Para registrar novamente o host de sessão em um pool de hosts, você deve reinstalar o agente com informações de registro válidas para esse pool de hosts.

Este comando falhará se o host da sessão tiver sessões de usuário ativas. Para concluir a remoção do host de sessão, você deve primeiro fazer logoff de todos os usuários do host de sessão usando o cmdlet Invoke-RdsUserSessionLogoff ou executar novamente o cmdlet Remove-RdsSessionHost com o parâmetro Force.

Ao executar esse comando para remover um host de sessão de um pool de hosts persistente, a atribuição de usuário também é removida. Essa é a única maneira de reatribuir um usuário a um novo host de sessão em um pool de hosts persistente.

Exemplos

Exemplo 1: Remover um host de sessão que não tenha sessões ativas

PS C:\> Remove-RdsSessionhost -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sh1.contoso.com"

Este comando remove um host de sessão de um pool de hosts. Ao executar o cmdlet Remove-RdsSessionHost sem a opção Force, ele só terá êxito se não houver sessões ativas no host de sessão especificado. Para forçar os usuários a fazer logoff do host da sessão, você pode executar o cmdlet Invoke-RdsUserSessionLogoff.

Exemplo 2: Remover um host de sessão usando o interruptor de força

PS C:\> Remove-RdsSessionhost -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sh1.contoso.com" -Force

Este comando remove um host de sessão de um pool de hosts. Ao executar o cmdlet Remove-RdsSessionHost com a opção Force, o host da sessão será imediatamente removido do banco de dados, juntamente com as informações da sessão do usuário. Isso não faz logoff automático dos usuários e pode resultar em um usuário perder seu estado de sessão se ele for acidentalmente desconectado de sua sessão antes de executar um logoff.

Parâmetros

-Force

Força a remoção do host de sessão, mesmo se houver objetos de sessão de usuário contidos com o host de sessão.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-HostPoolName

Nome do HostPool.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:1
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Name

Nome do SessionHost.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Nome do Host da Sessão

Conjuntos de parâmetros

(All)
Position:2
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-TenantName

Nome do locatário.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

System.String

Saídas

System.Object