Remove-PSSession

Referência

Módulo:: Microsoft.PowerShell.Core

Fecha uma ou mais sessões do PowerShell (PSSessionsions).

Syntax

Remove-PSSession
      [-Id] <Int32[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      [-Session] <PSSession[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      -ContainerId <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      -VMId <Guid[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      -VMName <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      -InstanceId <Guid[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      -Name <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      [-ComputerName] <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O Remove-PSSession cmdlet fecha as sessões do PowerShell (PSSessions) na sessão atual. Ele interrompe todos os comandos que estão em execução no PSSessionsions, encerra o PSSession e libera os recursos que o PSSession estava usando. Se o PSSession estiver conectado a um computador remoto, esse cmdlet também fechará a conexão entre os computadores locais e remotos.

Para remover uma PSSession, insira o Nome, Nome do Computador, ID ou InstanceID da sessão.

Se você salvou a PSSession em uma variável, o objeto de sessão permanecerá na variável, mas o estado da PSSession será Fechado.

Exemplos

Exemplo 1: remover sessões por ID

Remove-PSSession -Id 1, 2

Esse comando remove as PSSessionsions que têm IDs 1 e 2.

Exemplo 2: remover todas as sessões na sessão atual

Get-PSSession | Remove-PSSession
Remove-PSSession -Session (Get-PSSession)
$s = Get-PSSession
Remove-PSSession -Session $s

Esses comandos removem todas as PSSessions na sessão atual. Embora o formato dos três comandos pareçam diferentes, eles têm o mesmo efeito.

Exemplo 3: Fechar sessões por nome

$r = Get-PSSession -ComputerName Serv*
$r | Remove-PSSession

Esses comandos fecham as PSSessionsions conectadas a computadores que têm nomes que começam com Serv.

Exemplo 4: Fechar sessões conectadas a uma porta

Get-PSSession | where {$_.port -eq 90} | Remove-PSSession

Esse comando fecha as PSSessions que estão conectadas à porta 90. Você pode usar esse formato de comando para identificar PSSessions por propriedades diferentes de ComputerName, Name, InstanceID e ID.

Exemplo 5: Fechar uma sessão por ID da instância

Get-PSSession | Format-Table ComputerName, InstanceID  -AutoSize

ComputerName InstanceId
------------ ----------------
Server01     875d231b-2788-4f36-9f67-2e50d63bb82a
localhost    c065ffa0-02c4-406e-84a3-dacb0d677868
Server02     4699cdbc-61d5-4e0d-b916-84f82ebede1f
Server03     4e5a3245-4c63-43e4-88d0-a7798bfc2414
TX-TEST-01   fc4e9dfa-f246-452d-9fa3-1adbdd64ae85

Remove-PSSession -InstanceID fc4e9dfa-f246-452d-9fa3-1adbdd64ae85

Esses comandos mostram como fechar uma PSSession com base em sua ID de instância ou RemoteRunspaceID.

O primeiro comando usa o Get-PSSession cmdlet para obter as PSSessions na sessão atual. Ele usa um operador de pipeline (|) para enviar as PSSessions para o Format-Table cmdlet, que formata suas propriedades ComputerName e InstanceID em uma tabela. O parâmetro AutoSize compacta as colunas para exibição.

Na exibição resultante, você pode identificar a PSSession a ser fechada e copiar e colar a InstanceID desse PSSession no segundo comando.

O segundo comando usa o Remove-PSSession cmdlet para remover a PSSession com a ID da instância especificada.

Exemplo 6: criar uma função que exclua todas as sessões na sessão atual

Function EndPSS { Get-PSSession | Remove-PSSession }

Essa função fecha cada PSSession na sessão atual. Depois de adicionar essa função ao seu perfil do PowerShell, para excluir todas as sessões, digite EndPSS.

Parâmetros

-ComputerName

Especifica uma matriz de nomes de computadores. Esse cmdlet fecha as PSSessionsions que estão conectadas aos computadores especificados. Caracteres curinga são permitidos.

Digite o nome NetBIOS, um endereço IP ou um nome de domínio totalmente qualificado de um ou mais computadores remotos. Para especificar o computador local, digite o nome localhostdo computador ou um ponto (.).

Type:	String[]
Aliases:	Cn
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContainerId

Especifica uma matriz de IDs de contêineres. Esse cmdlet remove as sessões para cada um dos contêineres especificados. Use o docker ps comando para obter uma lista de IDs de contêiner. Para obter mais informações, consulte a ajuda para o comando docker ps .

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Id

Especifica uma matriz de IDs de sessões. Esse cmdlet fecha as PSSessions com as IDs especificadas. Digite uma ou mais IDs, separadas por vírgulas ou use o operador de intervalo (..) para especificar um intervalo de IDs.

Uma ID é um inteiro que identifica exclusivamente a PSSession na sessão atual. É mais fácil lembrar e digitar do que o InstanceId, mas é exclusivo apenas na sessão atual. Para localizar a ID de uma PSSession, execute o Get-PSSession cmdlet sem parâmetros.

Type:	Int32[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InstanceId

Especifica uma matriz de IDs de instância. Esse cmdlet fecha as PSSessionsions que têm as IDs de instância especificadas.

A ID da instância é um GUID que identifica exclusivamente uma PSSession na sessão atual. A ID da instância é exclusiva, mesmo quando você tem várias sessões em execução em um único computador.

A ID da instância é armazenada na propriedade InstanceID do objeto que representa uma PSSession. Para localizar o InstanceID das PSSessions na sessão atual, digite Get-PSSession | Format-Table Name, ComputerName, InstanceId.

Type:	Guid[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Especifica uma matriz de nomes amigáveis de sessões. Esse cmdlet fecha as PSSessionsions que têm os nomes amigáveis especificados. Caracteres curinga são permitidos.

Como o nome amigável de uma PSSession pode não ser exclusivo, quando você usa o parâmetro Name , considere também usar o parâmetro WhatIf ou Confirm no Remove-PSSession comando.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

-Session

Especifica os objetos de sessão das PSSessions para fechar. Insira uma variável que contém as PSSessions ou um comando que cria ou obtém as PSSessionsions, como um New-PSSession ou Get-PSSession comando. Você também pode canalizar um ou mais objetos de sessão para Remove-PSSession.

Type:	PSSession[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VMId

Especifica uma matriz de ID de máquinas virtuais. Esse cmdlet inicia uma sessão interativa com cada uma das máquinas virtuais especificadas. Para ver as máquinas virtuais que estão disponíveis para você, use o seguinte comando:

Get-VM | Select-Object -Property Name, ID

Type:	Guid[]
Aliases:	VMGuid
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-VMName

Especifica uma matriz de nomes de máquinas virtuais. Esse cmdlet inicia uma sessão interativa com cada uma das máquinas virtuais especificadas. Para ver as máquinas virtuais que estão disponíveis para você, use o Get-VM cmdlet.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

PSSession

Você pode canalizar um objeto de sessão para este cmdlet.

Saídas

None

Este cmdlet não retorna nenhum objeto.

Observações

O parâmetro de ID é obrigatório. Para excluir todas as PSSessions na sessão atual, digite Get-PSSession | Remove-PSSession.
Uma PSSession usa uma conexão persistente com um computador remoto. Crie uma PSSession para executar uma série de comandos que compartilham dados. Para obter mais informações, digite Get-Help about_PSSessions.
PSSessionsions são específicos para a sessão atual. Quando você encerra uma sessão, as PSSessions que você criou nessa sessão são fechadas à força.