Get-PSSession
Obtém as sessões do Windows PowerShell (PSSessions) na sessão atual.
Sintaxe
Get-PSSession [[-ComputerName] <string[]>] [<CommonParameters>]
Get-PSSession [-Id] <Int32[]> [<CommonParameters>]
Get-PSSession [-InstanceId <Guid[]>] [<CommonParameters>]
Get-PSSession [-Name <string[]>] [<CommonParameters>]
Descrição
O cmdlet Get-PSSession obtém as sessões do Windows PowerShell (PSSessions) que foram criadas na sessão atual.
Sem parâmetros, Get-PSSession obtém todas as PSSessions criadas na sessão atual. Você pode usar os parâmetros de Get-PSSession para obter as sessões que estão conectadas a computadores específicos ou pode identificar sessões por seus nomes, IDs ou IDs de instância.
Para obter mais informações sobre sessões do Windows PowerShell, consulte about_PSSessions.
Parâmetros
-ComputerName <string[]>
Obtém apenas as PSSessions que estão conectadas aos computadores especificados. Os 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. Para especificar o computador local, digite o nome do computador, "localhost" ou um ponto (.).
Necessário? |
false |
Posição? |
1 |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByPropertyName) |
Aceitar caracteres curinga? |
true |
-Id <Int32[]>
Obtém somente 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 com exclusividade a PSSession na sessão atual. É mais fácil de lembrar e digitar do que o InstanceId, mas ela é exclusiva somente na sessão atual. Para localizar a ID de uma PSSession, use Get-PSSession sem parâmetros.
Necessário? |
true |
Posição? |
1 |
Valor padrão |
Todas as sessões no shell |
Aceitar entrada do pipeline? |
true (ByPropertyName) |
Aceitar caracteres curinga? |
false |
-InstanceId <Guid[]>
Obtém somente as PSSessions com as IDs de instância especificadas.
A ID de instância é um GUID que identifica exclusivamente uma PSSession em um computador local ou remoto. O InstanceID é exclusivo, mesmo quando você tem várias sessões em execução no Windows PowerShell.
O InstanceID é armazenado 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".
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByPropertyName) |
Aceitar caracteres curinga? |
true |
-Name <string[]>
Obtém somente as PSSessions com os nomes amigáveis especificados. Os caracteres curinga são permitidos.
Para localizar os nomes das PSSessions na sessão atual, digite "get-pssession" sem parâmetros.
Necessário? |
false |
Posição? |
named |
Valor padrão |
|
Aceitar entrada do pipeline? |
true (ByPropertyName) |
Aceitar caracteres curinga? |
true |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
Entradas |
Nenhum Você não pode canalizar a entrada para este cmdlet. |
Saídas |
System.Management.Automation.Runspaces.PSSession Get-PSSession retorna um objeto PSSession para cada PSSession que obtém. |
Observações
Get-PSSession obtém as PSSessions que foram criadas na sessão atual. Não obtém a sessão criada quando você abre o Windows PowerShell e não obtém PSSessions que foram criadas em outras sessões ou em outros computadores, mesmo que estejam conectadas ao computador local.
Exemplo 1
C:\PS>get-pssession
Descrição
-----------
Esse comando obtém todas as PSSessions que foram criadas na sessão atual.
Não obtém PSSessions que foram criadas em outras sessões ou em outros computadores, mesmo que estejam conectadas a esse computador.
Exemplo 2
C:\PS>$s = get-pssession -computername Server02
Descrição
-----------
Esse comando obtém as PSSessions que estão conectadas ao computador Server02 e as salva na variável $p.
Exemplo 3
C:\PS>new-pssession -computername Server01, Server02, Server03
C:\PS> $s1, $s2, $s3 = get-pssession
Descrição
-----------
Esse exemplo mostra como salvar os resultados de um comando Get-PSSession em várias variáveis.
O primeiro comando usa o cmdlet New-PSSession para criar PSSessions em três computadores remotos.
O segundo comando usa um cmdlet Get-PSSession para obter as três PSSessions. Ele salva cada PSSession em uma variável separada.
Quando o Windows PowerShell atribui uma matriz de objetos a uma matriz de variáveis, ele atribui o primeiro objeto à primeira variável, o segundo objeto à segunda variável, e assim por diante. Se houver mais objetos do que variáveis, ele atribuirá todos os objetos restantes à última variável na matriz. Se houver mais variáveis que objetos, as variáveis adicionais não serão usadas.
Exemplo 4
C:\PS>get-pssession | format-table -property computername, InstanceID
C:\PS> $s = get-pssession -InstanceID a786be29-a6bb-40da-80fb-782c67f7db0f
C:\PS> remove-pssession -session $s
Descrição
-----------
Esse exemplo mostra como obter uma PSSession usando sua ID de instância como excluir a PSSession.
O primeiro comando obtém todas as PSSessions no computador local. Ele envia as PSSessions para o cmdlet Format-Table, que exibe as propriedades ComputerName e a InstanceID de cada PSSession.
O segundo comando usa o cmdlet Get-PSSession para obter uma PSSession específica e para salvá-la na variável $s. O comando usa o parâmetro InstanceID para identificar a PSSession.
O terceiro comando usa o cmdlet Remove-PSSession para excluir a PSSession na variável $s.
Exemplo 5
C:\PS>get-pssession -computername Serv*
Descrição
-----------
Esse comando obtém todas as PSSessions conectadas a computadores com nomes de computador que começam com "Serv".
Exemplo 6
C:\PS>get-pssession -name Test*, Ux*
Descrição
-----------
Esse comando obtém PSSessions que têm nomes que começam com "Test" ou "Ux".
Exemplo 7
C:\PS>get-pssession 2
Descrição
-----------
Esse comando obtém a PSSession com ID 2.
Consulte também
Conceitos
about_PSSessions
about_Remote
New-PSSession
Remove-PSSession
Enter-PSSession
Exit-PSSession
Invoke-Command