Get-PSSession
Obtém as sessões do PowerShell em computadores locais e remotos.
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>]
VMNameInstanceId
Get-PSSession
-InstanceId <Guid[]>
-VMName <String[]>
[-ConfigurationName <String>]
[-State <SessionFilterState>]
[<CommonParameters>]
ContainerId
Get-PSSession
-ContainerId <String[]>
[-ConfigurationName <String>]
[-Name <String[]>]
[-State <SessionFilterState>]
[<CommonParameters>]
ContainerIdInstanceId
Get-PSSession
-InstanceId <Guid[]>
-ContainerId <String[]>
[-ConfigurationName <String>]
[-State <SessionFilterState>]
[<CommonParameters>]
VMId
Get-PSSession
-VMId <Guid[]>
[-ConfigurationName <String>]
[-Name <String[]>]
[-State <SessionFilterState>]
[<CommonParameters>]
VMIdInstanceId
Get-PSSession
-InstanceId <Guid[]>
-VMId <Guid[]>
[-ConfigurationName <String>]
[-State <SessionFilterState>]
[<CommonParameters>]
VMName
Get-PSSession
-VMName <String[]>
[-ConfigurationName <String>]
[-Name <String[]>]
[-State <SessionFilterState>]
[<CommonParameters>]
InstanceId
Get-PSSession
[-InstanceId <Guid[]>]
[<CommonParameters>]
Id
Get-PSSession
[-Id] <Int32[]>
[<CommonParameters>]
Description
O Get-PSSession cmdlet obtém as sessões do PowerShell gerenciadas pelo usuário (PSSessions) em computadores locais e remotos.
A partir do Windows PowerShell 3.0, as sessões são armazenadas nos computadores no final remoto de cada conexão. Você pode usar os parâmetros ComputerName ou Get-PSSession para obter as sessões que se conectam ao computador local ou computadores remotos, mesmo que não tenham sido criadas na sessão atual.
Sem parâmetros, Get-PSSession obtém todas as sessões que foram criadas na sessão atual.
Use os parâmetros de filtragem, incluindo Name, ID,InstanceID,State, ApplicationName e ConfigurationName para selecionar entre as sessões retornadas Get-PSSession .
Use os parâmetros restantes para configurar a conexão temporária na qual o Get-PSSession comando é executado quando você usa os parâmetros ComputerName ou ConnectionUri .
Observação
No Windows PowerShell 2.0, sem parâmetros, Get-PSSession obtém todas as sessões que foram criadas na sessão atual. O parâmetro ComputerName obtém sessões que foram criadas na sessão atual e se conectam ao computador especificado.
Para obter mais informações sobre sessões do PowerShell, consulte about_PSSessions.
Exemplos
Exemplo 1: Obter sessões criadas na sessão atual
Get-PSSession
Esse comando obtém todas as PSSessions que foram criadas na sessão atual. Ele não obtém PSSessions que foram criados em outras sessões ou em outros computadores, mesmo que se conectem a este computador.
Exemplo 2: Obter sessões conectadas ao computador local
Get-PSSession -ComputerName "localhost"
Esse comando obtém o PSSessions que estão conectados ao computador local. Para indicar o computador local, digite o nome do computador, localhost ou um ponto (.)
O comando retorna todas as sessões no computador local, mesmo que tenham sido criadas em sessões diferentes ou em computadores diferentes.
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
Esse comando obtém o PSSessions que estão conectados ao computador Server02.
O comando retorna todas as sessões no Server02, mesmo que tenham sido criadas em sessões diferentes ou em computadores diferentes.
A saída mostra que duas das sessões têm um Disconnected estado e uma Busy disponibilidade.
Eles foram criados em sessões diferentes e estão em uso no momento. A ScheduledJobs sessão, que é Opened e Available, foi criada na sessão atual.
Exemplo 4: salvar resultados deste comando
New-PSSession -ComputerName Server01, Server02, Server03
$s1, $s2, $s3 = Get-PSSession
Este exemplo mostra como salvar os resultados de um Get-PSSession comando em várias variáveis.
O primeiro comando usa o New-PSSession cmdlet para criar PSSessions em três computadores remotos.
O segundo comando usa um Get-PSSession cmdlet para obter as três PSSessions. Em seguida, salva cada uma das PSSessions em uma variável separada.
Quando o PowerShell atribui uma matriz de objetos a uma matriz de variáveis, ele atribui o primeiro objeto à primeira variável, ao 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 do que objetos, as variáveis extras não serão usadas.
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
Este exemplo mostra como obter uma de PSSession
O primeiro comando obtém todas as PSSessions que foram criadas na sessão atual. Ele envia o PSSessions para o Format-Table cmdlet, que exibe as propriedades ComputerName e InstanceID de cada PSSession.
O segundo comando usa o Get-PSSession cmdlet para obter uma PSSession específica e salvá-lo na $s variável. O comando usa o parâmetro
O terceiro comando usa o cmdlet Remove-PSSession para excluir a PSSession na $s variável.
Exemplo 6: Obter uma sessão que tenha um nome específico
Os comandos neste exemplo encontram uma sessão que tem um formato de nome específico e usa uma configuração de sessão específica e, em seguida, conecta-se à sessão. Você pode usar um comando como este para encontrar uma sessão na qual um colega iniciou uma tarefa e se conectar para concluir a tarefa.
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
O primeiro comando obtém sessões nos computadores remotos Server02 e Server12 que têm nomes que começam com BackupJob e usam a configuração de ITTasks sessão. O comando usa o parâmetro Name para especificar o padrão de nome e o parâmetro ConfigurationName para especificar a configuração da sessão. O valor do parâmetro SessionOption é uma tabela de hash que define o valor do OperationTimeout como 240000 milissegundos (4 minutos). Essa configuração dá ao comando mais tempo para ser concluído. Os parâmetros ConfigurationName e SessionOption são usados para configurar as sessões temporárias nas quais o Get-PSSession cmdlet é executado em cada computador. A saída mostra que o comando retorna a BackupJob04 sessão. A sessão está desconectada e a Disponibilidade é None, o que indica que ela não está em uso.
O segundo comando usa o Get-PSSession cmdlet para acessar a BackupJob04 sessão e o Connect-PSSession cmdlet para se conectar à sessão. O comando salva a sessão na variável $s.
O terceiro comando obtém a sessão na $s variável. A saída mostra que o Connect-PSSession comando foi bem-sucedido. A sessão está no estado Aberto e está disponível para uso.
Exemplo 7: Obter uma sessão usando sua ID
Get-PSSession -Id 2
Esse comando obtém a PSSession com ID 2. Como o valor da propriedade
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 Get-PSSession comando com o parâmetro ConnectionUri .
Esse parâmetro foi introduzido no Windows PowerShell 3.0.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ConnectionUriInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUri
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-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: 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.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | All sessions |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-Authentication
Especifica o mecanismo usado para autenticar credenciais para a sessão na qual o Get-PSSession comando é executado.
Esse parâmetro configura a conexão temporária criada para executar um Get-PSSession comando com o parâmetro ComputerName ou ConnectionUri .
Os valores aceitáveis para este parâmetro são:
DefaultBasicCredSSPDigestKerberosNegotiate-
NegotiateWithImplicitCredential.
O valor padrão é Default.
Para obter mais informações sobre os valores desse parâmetro, consulte a Enumeração de Mecanismos de Autenticação .
Cuidado
A autenticação CredSSP (o Provedor de Suporte à Segurança de Credencial), na qual as credenciais do usuário são passadas para autenticação em um computador remoto, é 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
| Tipo: | AuthenticationMechanism |
| Valor padrão: | Default |
| Valores aceitos: | Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUriInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUri
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-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 Get-PSSession comando é executado. Insira a impressão digital do certificado.
Esse parâmetro configura a conexão temporária criada para executar um Get-PSSession comando 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 na unidade de Cert: do PowerShell.
Esse parâmetro foi introduzido no Windows PowerShell 3.0.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUriInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUri
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-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 Get-PSSession comando.
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, localhostou 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
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | Cn |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-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: 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 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
| Tipo: | String |
| Valor padrão: | All sessions |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ConnectionUriInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ConnectionUri
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ContainerId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ContainerIdInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
VMId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
VMIdInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
VMName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
VMNameInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-ConnectionUri
Especifica um URI que define o ponto de extremidade de conexão para a sessão temporária na qual o Get-PSSession comando é executado. O URI deve ser totalmente qualificado.
Esse parâmetro configura a conexão temporária criada para executar um Get-PSSession comando com o parâmetro ConnectionUri .
O formato dessa cadeia de caracteres é:
<Transport>://<ComputerName>:<Port\>/<ApplicationName>
O valor padrão será "http://localhost:5985/WSMAN".
Se você não especificar um 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
| Tipo: | Uri[] |
| Valor padrão: | Http://localhost:5985/WSMAN |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | URI, CU |
Conjuntos de parâmetros
ConnectionUriInstanceId
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ConnectionUri
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-ContainerId
Especifica uma matriz de IDs de contêineres. Esse cmdlet inicia uma sessão interativa com cada um dos contêineres especificados. Use o comando docker ps para obter uma lista de IDs de contêiner. Para obter mais informações, consulte a ajuda para o comando docker ps.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ContainerId
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ContainerIdInstanceId
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-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 executar um Get-PSSession comando. O padrão é o usuário atual.
Digite um nome de usuário, como User01 ou Domain01\User01, ou insira um objeto PSCredential gerado pelo cmdlet Get-Credential. Se você digitar um nome de usuário, será solicitado que você insira a senha.
As credenciais são armazenadas em um objeto PSCredential e a senha é armazenada como um SecureString.
Observação
Para obter mais informações sobre a proteção de dados do SecureString, consulte Quão seguro é o SecureString?.
Esse parâmetro configura para a conexão temporária criada para executar um Get-PSSession comando com o parâmetro ComputerName ou ConnectionUri .
Esse parâmetro foi introduzido no Windows PowerShell 3.0.
Propriedades do parâmetro
| Tipo: | PSCredential |
| Valor padrão: | Current user |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUriInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUri
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-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
Propriedades do parâmetro
| Tipo: | Int32[] |
| Valor padrão: | All sessions |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Id
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-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
A ID da instância de uma sessão é armazenada na propriedade InstanceID da sessão.
Propriedades do parâmetro
| Tipo: | Guid[] |
| Valor padrão: | All sessions |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUriInstanceId
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ContainerIdInstanceId
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
VMIdInstanceId
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
VMNameInstanceId
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
InstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-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
| Tipo: | String[] |
| Valor padrão: | All sessions |
| Dá suporte a curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
Name
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ConnectionUri
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
ContainerId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
VMId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
VMName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-Port
Especifica a porta de rede especificada que é usada para a conexão temporária na qual o Get-PSSession comando é 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 Get-PSSession comando 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
| Tipo: | Int32 |
| Valor padrão: | 5985, 5986 |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-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
| Tipo: | PSSessionOption |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUriInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUri
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-State
Especifica um estado de sessão. Esse cmdlet obtém apenas sessões no estado especificado. Os valores aceitáveis para este parâmetro são: All, , Opened, Disconnected, e ClosedBroken. O valor padrão é All.
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 mesmo Disconnected 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
| Tipo: | SessionFilterState |
| Valor padrão: | All |
| Valores aceitos: | All, Opened, Disconnected, Closed, Broken |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUriInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUri
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ContainerId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ContainerIdInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
VMId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
VMIdInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
VMName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
VMNameInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ThrottleLimit
Especifica o número máximo de conexões simultâneas que podem ser estabelecidas para executar o Get-PSSession comando. 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
| Tipo: | Int32 |
| Valor padrão: | 32 |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUriInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ConnectionUri
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-UseSSL
Indica que esse cmdlet usa o protocolo SSL (Secure Sockets Layer) para estabelecer a conexão na qual o Get-PSSession comando é 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 Get-PSSession comando com o parâmetro ComputerName .
Esse parâmetro foi introduzido no Windows PowerShell 3.0.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
ComputerInstanceId
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
ComputerName
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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
Propriedades do parâmetro
| Tipo: | Guid[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | VMGuid |
Conjuntos de parâmetros
VMId
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
VMIdInstanceId
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | 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 cmdlet Get-VM.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
VMName
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
VMNameInstanceId
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
None
Não é possível redirecionar a entrada para este cmdlet.
Saídas
PSSession
Observações
- Esse cmdlet obtém objetos PSSession de sessões gerenciadas pelo usuário, como aqueles que são criados usando os cmdlets e
New-PSSessionoEnter-PSSession.Invoke-CommandEle não obtém a sessão gerenciada pelo sistema que é criada quando você inicia o PowerShell. - A partir do Windows PowerShell 3.0, objetos de de PSSession são armazenados no computador que está no lado do servidor ou recebendo o fim de uma conexão. Para obter as sessões armazenadas no computador local ou em um computador remoto, o PowerShell estabelece uma sessão temporária para o computador especificado e executa comandos de consulta na sessão.
- Para obter sessões que se conectam a um computador remoto, use os parâmetros ComputerName ou ConnectionUri para especificar o computador remoto. Para filtrar as sessões obtidas
Get-PSSession, use os parâmetros Name, ID,InstanceID e State . Use os parâmetros restantes para configurar a sessão temporária queGet-PSSessionusa. - Quando você usa os parâmetros ComputerName ou ConnectionUri ,
Get-PSSessionobtém apenas sessões de computadores que executam o Windows PowerShell 3.0 e versões posteriores do PowerShell. - 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 de PSSession de disponibilidadeesteja desconectado de todas as sessões. Ela pode ser conectada a uma sessão diferente. Para determinar se você pode se conectar ou se reconectar à PSSession da sessão atual, use a propriedade .
Um valor de de disponibilidade
Para obter mais informações sobre os valores da propriedade State de sessões, consulte de Enumeração RunspaceState.
Para obter mais informações sobre os valores da propriedade Availability de sessões, consulte RunspaceAvailability Enumeration.