Disconnect-RDUser

Aplica-se a: Windows 10, Windows Server Technical Preview

Disconnect-RDUser

Disconnects a user from a session that runs on a remote server.

Sintaxe

Parameter Set: Default
Disconnect-RDUser [-HostServer] <String> [-UnifiedSessionID] <Int32> [-Force] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]

Descrição detalhada

The Disconnect-RDUser cmdlet disconnects a specified user from a session that runs on the remote server. All applications continue to run.

Use the Invoke-RDUserLogoff cmdlet to end a session and close running applications.

Use the Get-RDUserSessioncmdlet to retrieve the value for the user session ID. Because the user session ID is unique only within the context of a session host, a different session host server can share the same user session ID. The host server and session ID that you specify in this cmdlet uniquely identify a session within a deployment.

Parâmetros

-Force

Força a execução do comando sem solicitar a confirmação do usuário.

Aliases	none
Obrigatório?	false
Posição?	named
Valor padrão	none
Aceitar entrada de pipeline?	false
Aceitar caracteres curinga?	false

-HostServer<String>

Specifies the name of the server that hosts the session. For session collections the server name is the name of the Remote Desktop Session Host (RD Session Host) server. For virtual desktop collections the server name is the name of the Remote Desktop Virtualization Host (RD Virtualization Host) server.

Aliases	none
Obrigatório?	true
Posição?	1
Valor padrão	none
Aceitar entrada de pipeline?	True (ByPropertyName)
Aceitar caracteres curinga?	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
Obrigatório?	false
Posição?	named
Valor padrão	none
Aceitar entrada de pipeline?	false
Aceitar caracteres curinga?	false

-InformationVariable<System.String>

Specifies a variable in which to store an information event message.

Aliases	iv
Obrigatório?	false
Posição?	named
Valor padrão	none
Aceitar entrada de pipeline?	false
Aceitar caracteres curinga?	false

-UnifiedSessionID<Int32>

Provides the unique ID for the session. Use the Get-RDUserSession cmdlet to retrieve the user session ID.

Aliases	none
Obrigatório?	true
Posição?	2
Valor padrão	none
Aceitar entrada de pipeline?	True (ByPropertyName)
Aceitar caracteres curinga?	false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte  about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entradas

O tipo de entrada é o tipo dos objetos que você pode redirecionar para o cmdlet.

Saídas

O tipo de saída é o tipo de objeto que o cmdlet emite.

• System.Object

Exemplos

Example 1: Disconnect a User from a session on an RD Session Host Server

This command disconnects the user connected to session 2 on the host server sessionhost.contoso.com.

PS C:\> Disconnect-RDUser -HostServer sessionhost.contoso.com -UnifiedSessionID 2

Tópicos relacionados

Get-RDUserSession

Invoke-RDUserLogoff

Send-RDUserMessage