Partilhar via

Connect-PSSession

  • Referência
Módulo:
Microsoft.PowerShell.Core

Reconecta-se a sessões desconectadas.

Sintaxe

Connect-PSSession
       -Name <String[]>
       [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-PSSession
       [-Session] <PSSession[]>
       [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-PSSession
       -ComputerName <String[]>
       [-ApplicationName <String>]
       [-ConfigurationName <String>]
       -InstanceId <Guid[]>
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [-Port <Int32>]
       [-UseSSL]
       [-SessionOption <PSSessionOption>]
       [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-PSSession
       -ComputerName <String[]>
       [-ApplicationName <String>]
       [-ConfigurationName <String>]
       [-Name <String[]>]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [-Port <Int32>]
       [-UseSSL]
       [-SessionOption <PSSessionOption>]
       [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-PSSession
       [-ConfigurationName <String>]
       [-ConnectionUri] <Uri[]>
       [-AllowRedirection]
       -InstanceId <Guid[]>
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [-SessionOption <PSSessionOption>]
       [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-PSSession
       [-ConfigurationName <String>]
       [-ConnectionUri] <Uri[]>
       [-AllowRedirection]
       [-Name <String[]>]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [-SessionOption <PSSessionOption>]
       [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-PSSession
       -InstanceId <Guid[]>
       [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Connect-PSSession
       [-ThrottleLimit <Int32>]
       [-Id] <Int32[]>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

Este cmdlet só está disponível na plataforma Windows.

O Connect-PSSession cmdlet se reconecta às sessões do PowerShell gerenciadas pelo usuário (PSSessions) que foram desconectadas. Ele funciona em sessões que são desconectadas intencionalmente, como usando o Disconnect-PSSession cmdlet ou o parâmetro InDisconnectedSession do cmdlet, e aquelas que foram desconectadas involuntariamente, como por uma interrupção temporária da Invoke-Command rede.

Connect-PSSession pode se conectar a qualquer sessão desconectada que foi iniciada pelo mesmo usuário. Estes incluem aqueles que foram iniciados ou desconectados de outras sessões em outros computadores.

No entanto, Connect-PSSession não é possível conectar-se a sessões interrompidas ou fechadas, ou sessões interativas iniciadas usando o Enter-PSSession cmdlet. Além disso, você não pode conectar sessões a sessões iniciadas por outros usuários, a menos que você possa fornecer as credenciais do usuário que criou a sessão.

Para obter mais informações sobre o recurso Sessões desconectadas, consulte about_Remote_Disconnected_Sessions.

Este cmdlet foi introduzido no Windows PowerShell 3.0.

Exemplos

Exemplo 1: Reconectar-se a uma sessão

Connect-PSSession -ComputerName Server01 -Name ITTask

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 4 ITTask          Server01        Opened        ITTasks                  Available

Este comando se reconecta ITTask à sessão no computador Server01.

A saída mostra que o comando foi bem-sucedido. O Estado da sessão é Opened e a Disponibilidade é Available, o que indica que você pode executar comandos na sessão.

Exemplo 2: Efeito da desconexão e reconexão

Get-PSSession

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 Backups         Localhost       Opened        Microsoft.PowerShell     Available

Get-PSSession | Disconnect-PSSession

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 Backups         Localhost       Disconnected  Microsoft.PowerShell          None

Get-PSSession | Connect-PSSession

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 Backups         Localhost       Opened        Microsoft.PowerShell     Available

Este exemplo mostra o efeito de desconectar e, em seguida, reconectar-se a uma sessão.

O primeiro comando usa o Get-PSSession cmdlet. Sem o parâmetro ComputerName , o comando obtém apenas sessões que foram criadas na sessão atual.

A saída mostra que o comando obtém a Backups sessão no computador local. O Estado da sessão é Opened e a Disponibilidade é Available.

O segundo comando usa o Get-PSSession cmdlet para obter os objetos PSSession que foram criados na sessão atual e o Disconnect-PSSession cmdlet para desconectar as sessões. A saída mostra que a Backups sessão foi desconectada. O Estado da sessão é Disconnected e a Disponibilidade é None.

O terceiro comando usa o Get-PSSession cmdlet para obter os objetos PSSession que foram criados na sessão atual e o Connect-PSSession cmdlet para reconectar as sessões. A saída mostra que a Backups sessão foi reconectada. O Estado da sessão é Opened e a Disponibilidade é Available.

Se você usar o Connect-PSSession cmdlet em uma sessão que não esteja desconectada, o comando não afetará a sessão e não gerará erros.

Exemplo 3: Série de comandos em um cenário empresarial

Esta série de comandos mostra como o Connect-PSSession cmdlet pode ser usado em um cenário empresarial. Nesse caso, um administrador de sistema inicia um trabalho de longa execução em uma sessão em um computador remoto. Depois de iniciar o trabalho, o administrador se desconecta da sessão e vai para casa. Mais tarde naquela noite, o administrador faz logon em seu computador doméstico e verifica se o trabalho foi executado até que seja concluído.

O administrador começa criando uma sessão em um computador remoto e executando um script na sessão. O primeiro comando usa o New-PSSession cmdlet para criar a ITTask sessão no computador remoto Server01. O comando usa o parâmetro ConfigurationName para especificar a configuração da ITTasks sessão. O comando salva as sessões na $s variável.

O segundo cmdlet de comando Invoke-Command para iniciar um trabalho em segundo plano na sessão na $s variável. Ele usa o parâmetro FilePath para executar o script no trabalho em segundo plano.

O terceiro comando usa o Disconnect-PSSession cmdlet para se desconectar da sessão na $s variável. O comando usa o parâmetro OutputBufferingMode com um valor de Drop para evitar que o script seja bloqueado por ter que entregar a saída para a sessão. Ele usa o parâmetro IdleTimeoutSec para estender o tempo limite da sessão para 15 horas. Quando o comando é concluído, o administrador bloqueia o computador e vai para casa para a noite.

Mais tarde naquela noite, o administrador inicia seu computador doméstico, faz logon na rede corporativa e inicia o PowerShell. O quarto comando usa o Get-PSSession cmdlet para obter as sessões no computador Server01. O comando localiza a ITTask sessão. O quinto comando usa o Connect-PSSession cmdlet para se conectar à ITTask sessão. O comando salva a sessão na $s variável.

O sexto comando usa o Invoke-Command cmdlet para executar um Get-Job comando na sessão na $s variável. A saída mostra que o trabalho foi concluído com êxito. O sétimo comando usa o Invoke-Command cmdlet para executar um Receive-Job comando na sessão na $s variável na sessão. O comando salva os resultados na $BackupSpecs variável. O oitavo comando usa o Invoke-Command cmdlet para executar outro script na sessão. O comando usa o $BackupSpecs valor da variável na sessão como entrada para o script.

$s = New-PSSession -ComputerName Server01 -Name ITTask -ConfigurationName ITTasks
Invoke-Command -Session $s -ScriptBlock {Start-Job -FilePath \\Server30\Scripts\Backup-SQLDatabase.ps1}

Id     Name            State         HasMoreData     Location             Command
--     ----            -----         -----------     --------             -------
2      Job2            Running       True            Server01             \\Server30\Scripts\Backup...

Disconnect-PSSession -Session $s -OutputBufferingMode Drop -IdleTimeoutSec 60*60*15

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 ITTask          Server01        Disconnected  ITTasks               None

Get-PSSession -ComputerName Server01 -Name ITTask

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 ITTask          Server01        Disconnected  ITTasks               None

$s = Connect-PSSession -ComputerName Server01 -Name ITTask

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 ITTask          Server01        Opened        ITTasks               Available

Invoke-Command -Session $s -ScriptBlock {Get-Job}

Id     Name            State         HasMoreData     Location             Command
--     ----            -----         -----------     --------             -------
2      Job2            Completed     True            Server01             \\Server30\Scripts\Backup...

Invoke-Command -Session $s -ScriptBlock {$BackupSpecs = Receive-Job -JobName Job2}
Invoke-Command -Session $s -ScriptBlock {\\Server30\Scripts\New-SQLDatabase.ps1 -InitData $BackupSpecs.Initialization}
Disconnect-PSSession -Session $s -OutputBufferingMode Drop -IdleTimeoutSec 60*60*15

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 ITTask          Server01        Disconnected  ITTasks               None

O nono $s comando se desconecta da sessão na variável. O administrador fecha o PowerShell e fecha o computador. Ela pode se reconectar à sessão no dia seguinte e verificar o status do script em seu computador de trabalho.

Parâmetros

-AllowRedirection

Indica que esse cmdlet permite o redirecionamento dessa conexão para um URI alternativo.

Quando você usa o parâmetro ConnectionURI , o destino remoto pode retornar uma instrução para redirecionar para um URI diferente. Por padrão, o PowerShell não redireciona conexões, mas você pode usar esse parâmetro para permitir que ele redirecione a conexão.

Você também pode limitar o número de vezes que a conexão é redirecionada alterando o valor da opção de sessão MaximumConnectionRedirectionCount . Use o parâmetro MaximumRedirection do New-PSSessionOption cmdlet ou defina a propriedade MaximumConnectionRedirectionCount da variável de preferência $PSSessionOption . O valor predefinido é 5.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ApplicationName

Especifica o nome de um aplicativo. Esse cmdlet se conecta somente a 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: http://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.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Authentication

Especifica o mecanismo usado para autenticar as credenciais do usuário no comando para se reconectar à sessão desconectada. Os valores aceitáveis para este parâmetro são:

  • Default
  • Basic
  • Credssp
  • Digest
  • Kerberos
  • Negotiate
  • NegotiateWithImplicitCredential

O valor predefinido é Default.

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

Atenção

A autenticação CredSSP (Credential Security Support Provider), na qual as credenciais do usuário são passadas para um computador remoto para ser autenticado, foi projetada para comandos que exigem autenticação em mais de um recurso, como acessar um compartilhamento de rede remoto. Este mecanismo aumenta o risco de segurança da operação remota. Se o computador remoto estiver comprometido, as credenciais que são passadas para ele podem ser usadas para controlar a sessão de rede.

Tipo:AuthenticationMechanism
Valores aceites:Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-CertificateThumbprint

Especifica o certificado de chave pública digital (X509) de uma conta de usuário que tem permissão para se conectar à sessão desconectada. Insira a impressão digital do certificado.

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

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

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ComputerName

Especifica os computadores nos quais as sessões desconectadas são armazenadas. As sessões são armazenadas no computador que está no lado do servidor ou na extremidade recetora de uma conexão. A predefinição é o computador local.

Digite o nome NetBIOS, um endereço IP ou um nome de domínio totalmente qualificado de um computador. Caracteres curinga não são permitidos. Para especificar o computador local, digite o nome localhostdo computador ou um ponto (.)

Tipo:String[]
Aliases:Cn
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ConfigurationName

Conecta-se somente a 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 do esquema será precedido: http://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 da sessão que a sessão usa.

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

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ConnectionUri

Especifica os URIs dos pontos de extremidade de conexão para as sessões desconectadas.

O URI deve ser totalmente qualificado. O formato desta cadeia de caracteres é o seguinte:

<Transport>://<ComputerName>:<Port>/<ApplicationName>

O valor padrão é o seguinte:

http://localhost:5985/WSMAN

Se você não especificar um URI de conexão, poderá usar os parâmetros UseSSL e Port para especificar os valores de URI de conexão.

Os valores válidos para o segmento Transport 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ão: 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 HTTPS.

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

Tipo:Uri[]
Aliases:URI, CU
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Credential

Especifica uma conta de usuário que tem permissão para se conectar à sessão desconectada. A predefinição é o utilizador atual.

Digite um nome de usuário, como User01 ou Domain01\User01, ou insira um objeto PSCredential gerado pelo Get-Credential cmdlet. Se escrever um nome de utilizador, ser-lhe-á pedido que introduza a palavra-passe.

As credenciais são armazenadas em um objeto PSCredential e a senha é armazenada como um SecureString.

Nota

Para obter mais informações sobre a proteção de dados do SecureString , consulte Quão seguro é o SecureString?.

Tipo:PSCredential
Position:Named
Default value:Current user
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Id

Especifica as IDs das sessões desconectadas. O parâmetro Id funciona somente quando a sessão desconectada foi conectada anteriormente à sessão atual.

Este parâmetro é válido, mas não eficaz, quando a sessão é armazenada no computador local, mas não foi conectada à sessão atual.

Tipo:Int32[]
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-InstanceId

Especifica as IDs de instância das sessões desconectadas.

O ID da instância é um GUID que identifica exclusivamente uma PSSession em um computador local ou remoto.

O ID da instância é armazenado na propriedade InstanceID do PSSession.

Tipo:Guid[]
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Name

Especifica os nomes amigáveis das sessões desconectadas.

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Port

Especifica a porta de rede no computador remoto que é usada para se reconectar à sessão. 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 ouvir 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\>

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

Tipo:Int32
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Session

Especifica as sessões desconectadas. Insira uma variável que contenha os objetos PSSession ou um comando que crie ou obtenha os objetos PSSession , como um Get-PSSession comando.

Tipo:PSSession[]
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-SessionOption

Especifica opções avançadas para a sessão. Introduza um objeto SessionOption, como o que cria ao utilizar o cmdlet New-PSSessionOption ou uma tabela hash em que 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 $PSSessionOption preferência, se ela estiver definida. Caso contrário, os valores padrão são estabelecidos pelas opções definidas na configuração da sessão.

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

Para obter uma descrição das opções de sessão que inclui 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.

Tipo:PSSessionOption
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ThrottleLimit

Especifica o número máximo de conexões simultâneas que podem ser estabelecidas para executar esse comando. Se você omitir esse parâmetro ou inserir um valor de 0, o valor padrão, 32, será usado.

O limite de aceleração aplica-se apenas ao comando atual, não à sessão ou ao computador.

Tipo:Int32
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-UseSSL

Indica que esse cmdlet usa o protocolo SSL (Secure Sockets Layer) para se conectar à sessão desconectada. Por padrão, o SSL não é usado.

O WS-Management criptografa todo o conteúdo do PowerShell transmitido pela rede. O parâmetro UseSSL é uma proteção adicional que envia os dados através de uma conexão HTTPS em vez de uma conexão HTTP.

Se você usar esse parâmetro, mas o SSL não estiver disponível na porta usada para o comando, o comando falhará.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

PSSession

Você pode canalizar uma sessão (PSSession) para este cmdlet.

Saídas

PSSession

Esse cmdlet retorna um objeto que representa a sessão à qual ele se reconectou.

Notas

O PowerShell inclui os seguintes aliases para Connect-PSSession:

  • Windows:

    • cnsn

  • Este cmdlet só está disponível em plataformas Windows.

  • Connect-PSSession reconecta-se apenas a sessões que estão desconectadas, ou seja, sessões que têm um valor de Desconectado para a propriedade State . Somente as sessões conectadas ou terminadas em computadores que executam o Windows PowerShell 3.0 ou versões posteriores podem ser desconectadas e reconectadas.

  • Se você usar Connect-PSSession em uma sessão que não está desconectada, o comando não afeta a sessão e não gera erros.

  • Sessões de loopback desconectadas com tokens interativos, que são criadas usando o parâmetro EnableNetworkAccess , podem ser reconectadas somente do computador no qual a sessão foi criada. Essa restrição protege o computador contra acesso mal-intencionado.

  • O valor da propriedade State de uma PSSession é relativo à sessão atual. Portanto, um valor de Desconectado significa que o PSSession não está conectado à sessão atual. No entanto, isso não significa que o PSSession esteja desconectado de todas as sessões. Ele pode estar conectado a uma sessão diferente. Para determinar se você pode se conectar ou se reconectar à sessão, use a propriedade Availability .

    Um valor de Disponibilidade de Nenhum indica que você pode se conectar à sessão. Um valor de Ocupado indica que você não pode se conectar ao PSSession porque ele está conectado a outra sessão.

    Para obter mais informações sobre os valores da propriedade State das sessões, consulte Enumeração RunspaceState.

    Para obter mais informações sobre os valores da propriedade Availability das sessões, consulte Enumeração RunspaceAvailability.

  • Não é possível alterar o valor de tempo limite ocioso de uma PSSession quando você se conecta à PSSession. O parâmetro SessionOption de Connect-PSSession usa um objeto SessionOption que tem um valor IdleTimeout . No entanto, o valor IdleTimeout do objeto SessionOption e o valor IdleTimeout da $PSSessionOption variável são ignorados ao se conectar a uma PSSession.

    Você pode definir e alterar o tempo limite ocioso de uma PSSession ao criar a PSSession, usando os New-PSSession cmdlets or Invoke-Command e ao se desconectar da PSSession.

    A propriedade IdleTimeout de uma PSSession é crítica para sessões desconectadas, pois determina por quanto tempo uma sessão desconectada é mantida no computador remoto. As sessões desconectadas são consideradas ociosas a partir do momento em que são desconectadas, mesmo que os comandos estejam em execução na sessão desconectada.