Get-PSSession

Sintaxe

Name (Default)

Get-PSSession
    [-Name <String[]>]
    [<CommonParameters>]

ComputerName

Get-PSSession
    [-ComputerName] <String[]>
    [-ApplicationName <String>]
    [-ConfigurationName <String>]
    [-Name <String[]>]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-CertificateThumbprint <String>]
    [-Port <Int32>]
    [-UseSSL]
    [-ThrottleLimit <Int32>]
    [-State <SessionFilterState>]
    [-SessionOption <PSSessionOption>]
    [<CommonParameters>]

ComputerInstanceId

Get-PSSession
    [-ComputerName] <String[]>
    -InstanceId <Guid[]>
    [-ApplicationName <String>]
    [-ConfigurationName <String>]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-CertificateThumbprint <String>]
    [-Port <Int32>]
    [-UseSSL]
    [-ThrottleLimit <Int32>]
    [-State <SessionFilterState>]
    [-SessionOption <PSSessionOption>]
    [<CommonParameters>]

ConnectionUri

Get-PSSession
    [-ConnectionUri] <Uri[]>
    [-ConfigurationName <String>]
    [-AllowRedirection]
    [-Name <String[]>]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-CertificateThumbprint <String>]
    [-ThrottleLimit <Int32>]
    [-State <SessionFilterState>]
    [-SessionOption <PSSessionOption>]
    [<CommonParameters>]

ConnectionUriInstanceId

Get-PSSession
    [-ConnectionUri] <Uri[]>
    -InstanceId <Guid[]>
    [-ConfigurationName <String>]
    [-AllowRedirection]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-CertificateThumbprint <String>]
    [-ThrottleLimit <Int32>]
    [-State <SessionFilterState>]
    [-SessionOption <PSSessionOption>]
    [<CommonParameters>]

InstanceId

Get-PSSession
    [-InstanceId <Guid[]>]
    [<CommonParameters>]

Id

Get-PSSession
    [-Id] <Int32[]>
    [<CommonParameters>]

Description

Exemplos

Exemplo 1: Obter sessões criadas na sessão atual

Get-PSSession

Exemplo 2: Obter sessões conectadas ao computador local

Get-PSSession -ComputerName "localhost"

Exemplo 3: Obter sessões conectadas a um computador

Get-PSSession -ComputerName "Server02"

 Id Name            ComputerName    State         ConfigurationName     Availability
 -- ----            ------------    -----         -----------------     ------------
  2 Session3        Server02       Disconnected  ITTasks                       Busy
  1 ScheduledJobs   Server02       Opened        Microsoft.PowerShell     Available
  3 Test            Server02       Disconnected  Microsoft.PowerShell          Busy

Exemplo 4: salvar resultados deste comando

New-PSSession -ComputerName Server01, Server02, Server03
$s1, $s2, $s3 = Get-PSSession

Exemplo 5: excluir uma sessão usando uma ID de instância

Get-PSSession | Format-Table -Property ComputerName, InstanceID
$s = Get-PSSession -InstanceID a786be29-a6bb-40da-80fb-782c67f7db0f
Remove-PSSession -Session $s

Exemplo 6: Obter uma sessão que tenha um nome específico

Get-PSSession -ComputerName Server02, Server12 -Name BackupJob* -ConfigurationName ITTasks -SessionOption @{OperationTimeout=240000}

 Id Name            ComputerName    State         ConfigurationName     Availability
 -- ----            ------------    -----         -----------------     ------------
  3 BackupJob04     Server02        Disconnected        ITTasks                  None

$s = Get-PSSession -ComputerName Server02 -Name BackupJob04 -ConfigurationName ITTasks | Connect-PSSession
$s

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 5 BackupJob04     Server02        Opened        ITTasks                  Available

Exemplo 7: Obter uma sessão usando sua ID

Get-PSSession -Id 2

Parâmetros

-AllowRedirection

Indica que esse cmdlet permite o redirecionamento dessa conexão para um URI (Uniform Resource Identifier) alternativo. Por padrão, o PowerShell não redireciona conexões.

Esse parâmetro configura a conexão temporária criada para executar um comando Get-PSSession com o parâmetro ConnectionUri.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-ApplicationName

Especifica o nome de um aplicativo. Esse cmdlet se conecta apenas às sessões que usam o aplicativo especificado.

Insira o segmento de nome do aplicativo do URI de conexão. Por exemplo, no seguinte URI de conexão, o nome do aplicativo é WSMan: https://localhost:5985/WSMAN. O nome do aplicativo de uma sessão é armazenado na propriedade Runspace.ConnectionInfo.AppName da sessão.

O valor desse parâmetro é usado para selecionar e filtrar sessões. Ele não altera o aplicativo que a sessão usa.

Propriedades do parâmetro

Conjuntos de parâmetros

-Authentication

Especifica o mecanismo usado para autenticar credenciais para a sessão na qual o comando Get-PSSession é executado.

Esse parâmetro configura a conexão temporária criada para executar um comando Get-PSSession com o parâmetro ComputerName ou ConnectionUri.

Os valores aceitáveis para este parâmetro são:

• Padrão
• Básico
• Credssp
• Resumo
• Kerberos
• Negociar
• NegotiateWithImplicitCredential.

O valor padrão é Default.

Para obter mais informações sobre os valores desse parâmetro, consulte de Enumeração AuthenticationMechanism na biblioteca MSDN.

CUIDADO: a autenticação credSSP (Provedor de Suporte à Segurança de Credencial), na qual as credenciais do usuário são passadas para um computador remoto a ser autenticado, foi projetada para comandos que exigem autenticação em mais de um recurso, como acessar um compartilhamento de rede remoto. Esse mecanismo aumenta o risco de segurança da operação remota. Se o computador remoto estiver comprometido, as credenciais passadas para ele poderão ser usadas para controlar a sessão de rede.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-CertificateThumbprint

Especifica o certificado de chave pública digital (X509) de uma conta de usuário que tem permissão para criar a sessão na qual o comando Get-PSSession é executado. Insira a impressão digital do certificado.

Esse parâmetro configura a conexão temporária criada para executar um comando Get-PSSession com o parâmetro ComputerName ou ConnectionUri.

Os certificados são usados na autenticação baseada em certificado do cliente. Eles podem ser mapeados apenas para contas de usuário local; eles não funcionam com contas de domínio.

Para obter uma impressão digital do certificado, use um comando Get-Item ou Get-ChildItem no Cert do PowerShell: unidade.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-ComputerName

Especifica uma matriz de nomes de computadores. Obtém as sessões que se conectam aos computadores especificados. Caracteres curinga não são permitidos. Não há nenhum valor padrão.

A partir do Windows PowerShell 3.0, objetos de de PSSession são armazenados nos computadores no final remoto de cada conexão. Para obter as sessões nos computadores especificados, o PowerShell cria uma conexão temporária para cada computador e executa um comando Get-PSSession.

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 (.).

Observação: esse parâmetro obtém sessões somente de computadores que executam o Windows PowerShell 3.0 ou versões posteriores do PowerShell. As versões anteriores não armazenam sessões.

Propriedades do parâmetro

Conjuntos de parâmetros

-ConfigurationName

Especifica o nome de uma configuração. Esse cmdlet só chega às sessões que usam a configuração de sessão especificada.

Insira um nome de configuração ou o URI de recurso totalmente qualificado para uma configuração de sessão. Se você especificar apenas o nome da configuração, o seguinte URI de esquema será acrescentado: https://schemas.microsoft.com/powershell. O nome de configuração de uma sessão é armazenado na propriedade ConfigurationName da sessão.

O valor desse parâmetro é usado para selecionar e filtrar sessões. Ele não altera a configuração de sessão usada pela sessão.

Para obter mais informações sobre configurações de sessão, consulte about_Session_Configurations.

Propriedades do parâmetro

Conjuntos de parâmetros

-ConnectionUri

Especifica um URI que define o ponto de extremidade de conexão para a sessão temporária na qual o comando Get-PSSession é executado. O URI deve ser totalmente qualificado.

Esse parâmetro configura a conexão temporária criada para executar um comando Get-PSSession com o parâmetro ConnectionUri.

O formato dessa cadeia de caracteres é:

< >de Transporte :///<>ComputerName:<de Porta>/<> ApplicationName

O valor padrão é: https://localhost:5985/WSMAN.

Se você não especificar um ConnectionUri, poderá usar os parâmetrosUseSSL, ComputerName, Porte ApplicationName para especificar os valores de connectionURI . Os valores válidos para o segmento transporte do URI são HTTP e HTTPS. Se você especificar um URI de conexão com um segmento de Transporte, mas não especificar uma porta, a sessão será criada com portas padrões: 80 para HTTP e 443 para HTTPS. Para usar as portas padrão para comunicação remota do PowerShell, especifique a porta 5985 para HTTP ou 5986 para HTTPS.

Se o computador de destino redirecionar a conexão para um URI diferente, o PowerShell impedirá o redirecionamento, a menos que você use o parâmetro AllowRedirection no comando.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Esse parâmetro obtém sessões somente de computadores que executam o Windows PowerShell 3.0 ou versões posteriores do Windows PowerShell. As versões anteriores não armazenam sessões.

Propriedades do parâmetro

Conjuntos de parâmetros

-Credential

Especifica uma credencial de usuário. Esse cmdlet executa o comando com as permissões do usuário especificado. Especifique uma conta de usuário que tenha permissão para se conectar ao computador remoto e execute um comando Get-PSSession. O padrão é o usuário atual. Digite um nome de usuário, como , ou , ou insira um objeto PSCredential , como um retornado pelo cmdlet Get-Credential. Quando você digita um nome de usuário, esse cmdlet solicita uma senha.

Esse parâmetro configura para a conexão temporária criada para executar um comando Get-PSSession com o parâmetro ComputerName ou ConnectionUri.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-Id

Especifica uma matriz de IDs de sessão. Esse cmdlet obtém apenas as sessões 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. Não é possível usar o parâmetro de ID junto com o parâmetro ComputerName.

Uma ID é um inteiro que identifica exclusivamente as sessões gerenciadas pelo usuário na sessão atual. É mais fácil lembrar e digitar do que oInstanceId , mas ele é exclusivo apenas dentro da sessão atual. A ID de uma sessão é armazenada na propriedade ID da sessão.

Propriedades do parâmetro

Conjuntos de parâmetros

-InstanceId

Especifica uma matriz de IDs de instância de sessões. Esse cmdlet obtém apenas as sessões com as IDs de instância especificadas.

A ID da instância é um GUID que identifica exclusivamente uma sessão em um computador local ou remoto. O InstanceID é exclusivo, mesmo quando você tem várias sessões em execução no PowerShell.

A ID da instância de uma sessão é armazenada na propriedade InstanceID da sessão.

Propriedades do parâmetro

Conjuntos de parâmetros

-Name

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

O nome amigável de uma sessão é armazenado na propriedade Name da sessão.

Propriedades do parâmetro

Conjuntos de parâmetros

-Port

Especifica a porta de rede especificada que é usada para a conexão temporária na qual o comando Get-PSSession é executado. Para se conectar a um computador remoto, o computador remoto deve estar escutando na porta que a conexão usa. As portas padrão são 5985, que é a porta WinRM para HTTP e 5986, que é a porta WinRM para HTTPS.

Antes de usar uma porta alternativa, você deve configurar o ouvinte do WinRM no computador remoto para escutar nessa porta. Para configurar o ouvinte, digite os dois comandos a seguir no prompt do PowerShell:

Remove-Item -Path WSMan:\Localhost\listener\listener* -Recurse

New-Item -Path WSMan:\Localhost\listener -Transport http -Address * -Port \<port-number\>

Esse parâmetro configura para a conexão temporária criada para executar um comando Get-PSSession com o parâmetro ComputerName ou ConnectionUri.

Não use o parâmetro Port, a menos que seja necessário. A porta definida no comando se aplica a todos os computadores ou sessões nas quais o comando é executado. Uma configuração de porta alternativa pode impedir que o comando seja executado em todos os computadores.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-SessionOption

Especifica opções avançadas para a sessão. Insira um objeto SessionOption, como um que você cria usando o cmdlet New-PSSessionOption ou uma tabela de hash na qual as chaves são nomes de opção de sessão e os valores são valores de opção de sessão.

Os valores padrão para as opções são determinados pelo valor da variável de preferência $PSSessionOption, se ela estiver definida. Caso contrário, os valores padrão são estabelecidos por opções definidas na configuração da sessão.

Os valores de opção de sessão têm precedência sobre valores padrão para sessões definidas na variável de preferência $PSSessionOption e na configuração da sessão. No entanto, eles não têm precedência sobre valores máximos, cotas ou limites definidos na configuração da sessão.

Para obter uma descrição das opções de sessão, incluindo os valores padrão, consulte New-PSSessionOption. Para obter informações sobre a variável de preferência $PSSessionOption, consulte about_Preference_Variables. Para obter mais informações sobre configurações de sessão, consulte about_Session_Configurations.

Propriedades do parâmetro

Conjuntos de parâmetros

-State

Especifica um estado de sessão. Esse cmdlet obtém apenas sessões no estado especificado. Os valores aceitáveis para esse parâmetro são: Todos, Abertos, Desconectados, Fechados e Quebrados. O valor padrão é 80.

O valor do estado da sessão é relativo às sessões atuais. As sessões que não foram criadas nas sessões atuais e não estão conectadas à sessão atual têm um estado de Desconectado mesmo quando estão conectadas a uma sessão diferente.

O estado de uma sessão é armazenado na propriedade State da sessão.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-ThrottleLimit

Especifica o número máximo de conexões simultâneas que podem ser estabelecidas para executar o comando Get-PSSession. Se você omitir esse parâmetro ou inserir um valor de 0 (zero), o valor padrão, 32, será usado. O limite de limitação se aplica somente ao comando atual, não à sessão ou ao computador.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-UseSSL

Indica que esse cmdlet usa o protocolo SSL (Secure Sockets Layer) para estabelecer a conexão na qual o comando Get-PSSession é executado. Por padrão, o SSL não é usado. Se você usar esse parâmetro, mas o SSL não estiver disponível na porta usada para o comando, o comando falhará.

Esse parâmetro configura a conexão temporária criada para executar um comando Get-PSSession com o parâmetro ComputerName.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

CommonParameters

Entradas

None

Saídas

PSSession

Observações

Links Relacionados

• Connect-PSSession
• Disconnect-PSSession
• Receive-PSSession
• Enter-PSSession
• Exit-PSSession
• Invoke-Command
• New-PSSession
• Remove-PSSession
• sobre_PSSessions
• about_Remote