Enter-PSSession

Permite o redirecionamento da conexão para um URI (Uniform Resource Identifier) alternativo. Por padrão, o redirecionamento não é permitido.

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 $PSSessionOption preferência. O valor padrão é 5.

Especifica o segmento de nome de aplicativo do URI de conexão. Use esse parâmetro para especificar o nome do aplicativo quando você não estiver usando o parâmetro ConnectionURI no comando.

O valor padrão é o valor da variável de $PSSessionApplicationName preferência no computador local. Se essa variável de preferência não estiver definida, o valor padrão será WSMAN. Esse valor é adequado para a maioria dos usos. Para obter mais informações, consulte about_Preference_Variables.

O serviço WinRM usa o nome do aplicativo para selecionar um ouvinte para atender à solicitação de conexão. O valor desse parâmetro deve corresponder ao valor da propriedade URLPrefix de um ouvinte no computador remoto.

Especifica o mecanismo usado para autenticar as credenciais do usuário. Os valores aceitáveis para esse parâmetro são:

• Padrão
• Basic
• Credssp
• Digest
• Kerberos
• Negociar
• NegotiateWithImplicitCredential

O valor padrão é Default.

A autenticação CredSSP está disponível apenas no Windows Vista, Windows Server 2008 e versões posteriores do sistema operacional Windows.

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

Especifica o certificado de chave pública digital (X509) de uma conta de usuário com permissão para executar essa ação. Insira a impressão digital do certificado.

Certificados digitais são empregados na autenticação de clientes baseada em certificados. Eles podem ser mapeados apenas para contas de usuário locais; eles não funcionam com contas de domínio.

Para obter um certificado, use o Get-Item comando ou Get-ChildItem na unidade Certificado do PowerShell:.

Especifica um nome de computador. Esse cmdlet inicia uma sessão interativa com o computador remoto especificado. Digite apenas um nome de computador. O padrão é o computador local.

Digite o nome NetBIOS, o endereço IP ou o nome de domínio totalmente qualificado do computador. Você também pode canalizar um nome de computador para Enter-PSSession.

Para usar um endereço IP no valor do parâmetro ComputerName , o comando deve incluir o parâmetro Credential . Além disso, o computador deve ser configurado para o transporte HTTPS ou o endereço IP do computador remoto deve ser incluído na lista WinRM TrustedHosts no computador local. Para obter instruções sobre como adicionar um nome de computador à lista TrustedHosts, consulte "Como adicionar um computador à lista de hosts confiáveis" em about_Remote_Troubleshooting.

Especifica a configuração de sessão usada para a sessão interativa.

Insira um nome de configuração ou o URI do 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á anexado: http://schemas.microsoft.com/powershell.

Quando usado com SSH, isso especifica o subsistema a ser usado no destino, conforme definido em sshd_config. O valor padrão para SSH é o powershell subsistema.

A configuração da sessão para uma sessão está localizada no computador remoto. Se a configuração de sessão especificada não existir no computador remoto, o comando falhará.

O valor padrão é o valor da variável de $PSSessionConfigurationName preferência no computador local. Se essa variável de preferência não estiver definida, o padrão será Microsoft.PowerShell. Para obter mais informações, consulte about_Preference_Variables.

Especifica a quantidade de tempo em milissegundos permitida para que a conexão SSH inicial seja concluída. Se a conexão não for concluída dentro do tempo especificado, um erro será retornado.

Esse parâmetro foi introduzido no PowerShell 7.2

Especifica um URI que define o ponto de extremidade de conexão para a sessão. O URI deve ser totalmente qualificado. O formato dessa 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 ConnectionURI, poderá usar os parâmetros UseSSL, ComputerName, Port e ApplicationName para especificar os valores de ConnectionURI .

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 usando 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 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.

Especifica a ID de um contêiner.

Especifica uma conta de usuário que tem permissão para executar esta ação. 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 Get-Credential cmdlet. 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.

Indica que esse cmdlet adiciona um token de segurança interativo às sessões de loopback. O token interativo permite executar comandos na sessão de loopback que obtêm dados de outros computadores. Por exemplo, você pode executar um comando na sessão que copia arquivos XML de um computador remoto no computador local.

Uma sessão de loopback é uma PSSession que se origina e termina no mesmo computador. Para criar uma sessão de loopback, omita o parâmetro ComputerName ou defina seu valor como . (ponto), localhost ou o nome do computador local.

Por padrão, as sessões de loopback são criadas usando um token de rede, que pode não fornecer permissão suficiente para autenticação em computadores remotos.

O parâmetro EnableNetworkAccess é efetivo somente em sessões de loopback. Se você usar EnableNetworkAccess ao criar uma sessão em um computador remoto, o comando será bem-sucedido, mas o parâmetro será ignorado.

Você também pode permitir o acesso remoto em uma sessão de loopback usando o valor CredSSP do parâmetro Authentication, que delega as credenciais da sessão a outros computadores.

Este parâmetro foi introduzido no Windows PowerShell 3.0.

Especifica um nome de computador para uma conexão baseada em Secure Shell (SSH). Isso é semelhante ao parâmetro ComputerName , exceto que a conexão com o computador remoto é feita usando SSH em vez de Windows WinRM. Esse parâmetro oferece suporte à especificação do nome de usuário e/ou porta como parte do valor do parâmetro de nome do host usando o formulário user@hostname:port. O nome de usuário e/ou a porta especificada como parte do nome do host tem precedência sobre os -UserName parâmetros and -Port , se especificados. Isso permite passar vários nomes de computador para este parâmetro, onde alguns têm nomes de usuário e/ou portas específicas, enquanto outros usam o nome de usuário e/ou porta dos -UserName parâmetros and -Port .

Esse parâmetro foi introduzido no PowerShell 6.0.

Especifica a ID de uma sessão existente. Enter-PSSession usa a sessão especificada para a sessão interativa.

Para localizar a ID de uma sessão, use o Get-PSSession cmdlet.

Especifica a ID de instância de uma sessão existente. Enter-PSSession usa a sessão especificada para a sessão interativa.

A ID de instância é um GUID. Para localizar a ID da instância de uma sessão, use o Get-PSSession cmdlet. Você também pode usar os parâmetros Session, Name ou ID para especificar uma sessão existente. Ou você pode usar o parâmetro ComputerName para iniciar uma sessão temporária.

Especifica um caminho de arquivo de chave usado pelo Secure Shell (SSH) para autenticar um usuário em um computador remoto.

O SSH permite que a autenticação do usuário seja realizada por meio de chaves privadas/públicas como uma alternativa à autenticação básica de senha. Se o computador remoto estiver configurado para autenticação de chave, esse parâmetro poderá ser usado para fornecer a chave que identifica o usuário.

Esse parâmetro foi introduzido no PowerShell 6.0.

Especifica o nome amigável de uma sessão existente. Enter-PSSession usa a sessão especificada para a sessão interativa.

Se o nome que você especificou corresponder a mais de uma sessão, o comando falha. Você também pode usar os parâmetros Session, InstanceID ou ID para especificar uma sessão existente. Ou você pode usar o parâmetro ComputerName para iniciar uma sessão temporária.

Para estabelecer um nome amigável para uma sessão, use o parâmetro Name do New-PSSession cmdlet.

Especifica uma tabela de hash de opções de SSH usadas ao se conectar a uma sessão remota baseada em SSH. As opções possíveis são quaisquer valores suportados pela versão baseada em Unix do comando ssh .

Quaisquer valores explicitamente passados por parâmetros têm precedência sobre os valores passados na tabela de hash Opções . Por exemplo, o uso do parâmetro Port substitui qualquer Port par chave-valor passado na tabela de hash Options .

Especifica a porta de rede no computador remoto usada para esse comando.

No PowerShell 6.0, esse parâmetro foi incluído no conjunto de parâmetros HostName, que dá suporte a conexões SSH (Secure Shell).

WinRM (conjunto de parâmetros ComputerName)

Para se conectar a um computador remoto, este deve estar escutando na porta usada pela conexão. 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 de WinRM no computador remoto para escutar na porta. Use os seguintes comandos para configurar o ouvinte:

1. winrm delete winrm/config/listener?Address=*+Transport=HTTP
2. winrm create winrm/config/listener?Address=*+Transport=HTTP @{Port="\<port-number\>"}

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

SSH (conjunto de parâmetros HostName)

Para se conectar a um computador remoto, o computador remoto deve ser configurado com o SSH (SSH) e deve estar escutando na porta que a conexão usa. A porta padrão para SSH é 22.

Indica que o PSSession é executado como administrador.

Especifica uma sessão do PowerShell (PSSession) a ser usada para a sessão interativa. Esse parâmetro usa um objeto de sessão. Você também pode usar os parâmetros Name, InstanceID ou ID para especificar um PSSession.

Insira uma variável que contenha um objeto de sessão ou um comando que crie ou obtenha um objeto de sessão, como um New-PSSession comando ou Get-PSSession . Você também pode canalizar um objeto de sessão para Enter-PSSession. Você pode enviar apenas um PSSession usando esse parâmetro. Se você inserir uma variável que contenha mais de um PSSession, o comando falhará.

Quando você usa Exit-PSSession a palavra-chave EXIT , a sessão interativa termina, mas o PSSession que você criou permanece aberto e disponível para uso.

Define opções avançadas para a sessão. Insira um objeto SessionOption , como um que você cria usando o New-PSSessionOption cmdlet, 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 $PSSessionOption preferência, 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 os valores padrão para sessões definidas na $PSSessionOption 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, incluindo os valores padrão, consulte New-PSSessionOption. Para obter informações sobre a $PSSessionOption variável de preferência, consulte about_Preference_Variables. Para saber mais sobre configurações de sessão, confira about_Session_Configurations.

Indica que a conexão remota é estabelecida usando Secure Shell (SSH).

Por padrão, o PowerShell usa o Windows WinRM para se conectar a um computador remoto. Essa opção força o PowerShell a usar o parâmetro HostName definido para estabelecer uma conexão remota baseada em SSH.

Esse parâmetro foi introduzido no PowerShell 6.0.

Especifica o subsistema SSH usado para o novo PSSession.

Isso especifica o subsistema a ser usado no destino, conforme definido em sshd_config. O subsistema inicia uma versão específica do PowerShell com parâmetros predefinidos. Se o subsistema especificado não existir no computador remoto, o comando falhará.

Se esse parâmetro não for usado, o padrão será o powershell subsistema.

Especifica o nome de usuário da conta usada para criar uma sessão no computador remoto. O método de autenticação do usuário depende de como o Secure Shell (SSH) está configurado no computador remoto.

Se o SSH estiver configurado para autenticação de senha básica, você será solicitado a fornecer a senha do usuário.

Se o SSH estiver configurado para autenticação de usuário baseada em chave, você não será solicitado a fornecer uma senha. Você deve fornecer um caminho para um arquivo de chave SSH. Se o arquivo de chave do usuário estiver localizado em um local conhecido SSH, o parâmetro KeyFilePath não será necessário. A autenticação do usuário ocorre automaticamente com base no nome do usuário. Consulte a documentação do SSH sobre autenticação de usuário baseada em chave para obter mais informações.

Se o parâmetro UserName não for especificado, o nome de usuário conectado atual será usado.

Esse parâmetro foi introduzido no PowerShell 6.0.

Indica que esse cmdlet usa o protocolo SSL (Secure Sockets Layer) para estabelecer uma conexão com o computador remoto. 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 por 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á.

Especifica a ID de uma máquina virtual.

Especifica o nome de uma máquina virtual.