New-PSSessionOption

Sintaxe

Default (Predefinição)

New-PSSessionOption
    [-MaximumRedirection <Int32>]
    [-NoCompression]
    [-NoMachineProfile]
    [-Culture <CultureInfo>]
    [-UICulture <CultureInfo>]
    [-MaximumReceivedDataSizePerCommand <Int32>]
    [-MaximumReceivedObjectSize <Int32>]
    [-OutputBufferingMode <OutputBufferingMode>]
    [-MaxConnectionRetryCount <Int32>]
    [-ApplicationArguments <PSPrimitiveDictionary>]
    [-OpenTimeout <Int32>]
    [-CancelTimeout <Int32>]
    [-IdleTimeout <Int32>]
    [-ProxyAccessType <ProxyAccessType>]
    [-ProxyAuthentication <AuthenticationMechanism>]
    [-ProxyCredential <PSCredential>]
    [-SkipCACheck]
    [-SkipCNCheck]
    [-SkipRevocationCheck]
    [-OperationTimeout <Int32>]
    [-NoEncryption]
    [-UseUTF16]
    [-IncludePortInSPN]
    [<CommonParameters>]

Description

Exemplos

Exemplo 1: Criar uma opção de sessão padrão

New-PSSessionOption

MaximumConnectionRedirectionCount : 5
NoCompression                     : False
NoMachineProfile                  : False
ProxyAccessType                   : IEConfig
ProxyAuthentication               : Negotiate
ProxyCredential                   :
SkipCACheck                       : False
SkipCNCheck                       : False
SkipRevocationCheck               : False
OperationTimeout                  : 00:03:00
NoEncryption                      : False
UseUTF16                          : False
Culture                           :
UICulture                         :
MaximumReceivedDataSizePerCommand :
MaximumReceivedObjectSize         :
ApplicationArguments              :
OpenTimeout                       : 00:03:00
CancelTimeout                     : 00:01:00
IdleTimeout                       : 00:04:00

Exemplo 2: Configurar uma sessão usando um objeto de opção de sessão

$pso = New-PSSessionOption -Culture "fr-fr" -MaximumReceivedObjectSize 10MB
New-PSSession -ComputerName Server01 -SessionOption $pso

Exemplo 3: Iniciar uma sessão interativa

Enter-PSSession -ComputerName Server01 -SessionOption (New-PSSessionOption -NoEncryption -NoCompression)

Exemplo 4: Modificar um objeto de opção de sessão

$a = New-PSSessionOption
$a.OpenTimeout

Days              : 0
Hours             : 0
Minutes           : 3
Seconds           : 0
Milliseconds      : 0
Ticks             : 1800000000
TotalDays         : 0.00208333333333333
TotalHours        : 0.05
TotalMinutes      : 3
TotalSeconds      : 180
TotalMilliseconds : 180000

$a.UICulture = (Get-UICulture)
$a.OpenTimeout = (New-Timespan -Minutes 4)
$a.MaximumConnectionRedirectionCount = 1
$a

MaximumConnectionRedirectionCount : 1
NoCompression                     : False
NoMachineProfile                  : False
ProxyAccessType                   : IEConfig
ProxyAuthentication               : Negotiate
ProxyCredential                   :
SkipCACheck                       : False
SkipCNCheck                       : False
SkipRevocationCheck               : False
OperationTimeout                  : 00:03:00
NoEncryption                      : False
UseUTF16                          : False
Culture                           :
UICulture                         : en-US
MaximumReceivedDataSizePerCommand :
MaximumReceivedObjectSize         :
ApplicationArguments              :
OpenTimeout                       : 00:04:00
CancelTimeout                     : 00:01:00
IdleTimeout                       : 00:04:00

Exemplo 5: Criar uma variável de preferência

$PSSessionOption = New-PSSessionOption -OpenTimeOut 120000

Exemplo 6: Cumprir os requisitos para uma configuração de sessão remota

$skipCN = New-PSSessionOption -SkipCNCheck
New-PSSession -ComputerName 171.09.21.207 -UseSSL -Credential Domain01\User01 -SessionOption $SkipCN

Exemplo 7: Disponibilizar argumentos para uma sessão remota

$team = @{Team="IT"; Use="Testing"}
$TeamOption = New-PSSessionOption -ApplicationArguments $team
$s = New-PSSession -ComputerName Server01 -SessionOption $TeamOption
Invoke-Command -Session $s {$PSSenderInfo.ApplicationArguments}

Name                 Value
----                 -----
Team                 IT
Use                  Testing
PSVersionTable       {CLRVersion, BuildVersion, PSVersion, WSManStackVersion...}

Invoke-Command -Session $s {
  if ($PSSenderInfo.ApplicationArguments.Use -ne "Testing") {
    .\logFiles.ps1
  }
  else {
    "Just testing."
  }
}

Just testing.

Parâmetros

-ApplicationArguments

Especifica um dicionário primitivo que é enviado para a sessão remota. Comandos e scripts na sessão remota, incluindo scripts de inicialização na configuração da sessão, podem encontrar esse dicionário na propriedade ApplicationArguments da variável automática$PSSenderInfo. Você pode usar esse parâmetro para enviar dados para a sessão remota.

Para obter mais informações, consulte about_Hash_Tables, about_Session_Configurationse about_Automatic_Variables.

Propriedades dos parâmetros

Conjuntos de parâmetros

-CancelTimeout

Determina quanto tempo o PowerShell aguarda a conclusão de uma operação de cancelamento (CTRL+C) antes de encerrá-la. Insira um valor em milissegundos.

O valor padrão é 60000 (um minuto). Um valor de 0 (zero) significa que não há tempo limite; O comando continua indefinidamente.

Propriedades dos parâmetros

Conjuntos de parâmetros

-Culture

Especifica a cultura a ser usada para a sessão. Insira um nome de cultura em formato <languagecode2>-<country/regioncode2> (como ja-JP), uma variável que contenha um objeto CultureInfo ou um comando que obtenha um objeto CultureInfo.

O valor padrão é $Nulle a cultura definida no sistema operacional é usada na sessão.

Propriedades dos parâmetros

Conjuntos de parâmetros

-IdleTimeout

Determina por quanto tempo a sessão permanece aberta se o computador remoto não receber nenhuma comunicação do computador local. Isto inclui o sinal de batimento cardíaco. Quando o intervalo expira, a sessão é fechada.

O valor de tempo limite ocioso é de importância significativa se você pretende desconectar e reconectar a uma sessão. Você pode se reconectar somente se a sessão não tiver expirado.

Insira um valor em milissegundos. O valor mínimo é 60000 (1 minuto). O máximo é o valor da propriedade MaxIdleTimeoutms da configuração da sessão. O valor padrão, -1, não define um tempo limite ocioso.

A sessão usa o tempo limite ocioso definido nas opções de sessão, se houver. Se nenhum estiver definido (-1), a sessão usará o valor da propriedade IdleTimeoutMs da configuração da sessão ou o valor de tempo limite do shell WSMan (WSMan:\<ComputerName>\Shell\IdleTimeout), o que for mais curto.

Se o tempo limite ocioso definido nas opções de sessão exceder o valor da propriedade MaxIdleTimeoutMs da configuração da sessão, o comando para criar uma sessão falhará.

O valor de IdleTimeoutMs da configuração de sessão padrão do Microsoft.PowerShell é 7200000 milissegundos (2 horas). Seu valor de MaxIdleTimeoutMs é de 2147483647 milissegundos (>24 dias). O valor padrão do tempo limite ocioso do shell WSMan (WSMan:\<ComputerName>\Shell\IdleTimeout) é 7200000 milissegundos (2 horas).

O valor de tempo limite ocioso de uma sessão também pode ser alterado ao se desconectar de uma sessão ou se reconectar a uma sessão. Para obter mais informações, consulte Disconnect-PSSession e Connect-PSSession.

No Windows PowerShell 2.0, o valor padrão do parâmetro IdleTimeout é 240000 (4 minutos).

Propriedades dos parâmetros

Conjuntos de parâmetros

-IncludePortInSPN

Inclui o número da porta no SPN (Nome da Entidade de Serviço) usado para autenticação Kerberos, por exemplo, HTTP://<ComputerName>:5985. Essa opção permite que um cliente que usa um SPN não padrão se autentique em um computador remoto que usa a autenticação Kerberos.

A opção foi projetada para empresas em que vários serviços que suportam a autenticação Kerberos estão sendo executados em diferentes contas de usuário. Por exemplo, um aplicativo do IIS que permite a autenticação Kerberos pode exigir que o SPN padrão seja registrado em uma conta de usuário diferente da conta do computador. Nesses casos, a remotização do PowerShell não pode usar Kerberos para autenticar porque requer um SPN associado à conta do computador. Para resolver esse problema, os administradores podem criar SPNs diferentes, como usando Setspn.exe, que são registrados em contas de usuário diferentes e podem distinguir entre eles incluindo o número da porta no SPN.

Para obter mais informações, consulte Visão geral do Setspn.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Propriedades dos parâmetros

Conjuntos de parâmetros

-MaxConnectionRetryCount

Especifica o número de vezes que o PowerShell tenta fazer uma conexão com uma máquina de destino se a tentativa atual falhar devido a problemas de rede. O valor padrão é 5.

Este parâmetro foi adicionado para o PowerShell versão 5.0.

Propriedades dos parâmetros

Conjuntos de parâmetros

-MaximumReceivedDataSizePerCommand

Especifica o número máximo de bytes que o computador local pode receber do computador remoto em um único comando. Insira um valor em bytes. Por padrão, não há limite de tamanho de dados.

Esta opção foi concebida para proteger os recursos no computador cliente.

Propriedades dos parâmetros

Conjuntos de parâmetros

-MaximumReceivedObjectSize

Especifica o tamanho máximo de um objeto que o computador local pode receber do computador remoto. Esta opção foi concebida para proteger os recursos no computador cliente. Insira um valor em bytes.

No Windows PowerShell 2.0, se você omitir esse parâmetro, não haverá limite de tamanho de objeto. A partir do Windows PowerShell 3.0, se você omitir esse parâmetro, o valor padrão será 200 MB.

Propriedades dos parâmetros

Conjuntos de parâmetros

-MaximumRedirection

Determina quantas vezes o PowerShell redireciona uma conexão para um URI (Uniform Resource Identifier) alternativo antes que a conexão falhe. O valor padrão é 5. Um valor de 0 (zero) impede todo o redirecionamento.

Essa opção é usada na sessão somente quando o parâmetro AllowRedirection é usado no comando que cria a sessão.

Propriedades dos parâmetros

Conjuntos de parâmetros

-NoCompression

Desativa a compactação de pacotes na sessão. A compressão usa mais ciclos de processador, mas torna a transmissão mais rápida.

Propriedades dos parâmetros

Conjuntos de parâmetros

-NoEncryption

Desativa a encriptação de dados.

Propriedades dos parâmetros

Conjuntos de parâmetros

-NoMachineProfile

Impede o carregamento do perfil de usuário do Windows do usuário. Como resultado, a sessão pode ser criada mais rapidamente, mas configurações de registro específicas do usuário, itens como variáveis de ambiente e certificados não estão disponíveis na sessão.

Propriedades dos parâmetros

Conjuntos de parâmetros

-OpenTimeout

Determina quanto tempo o computador cliente aguarda para que a conexão de sessão seja estabelecida. Quando o intervalo expira, o comando para estabelecer a conexão falha. Insira um valor em milissegundos.

O valor padrão é 180000 (3 minutos). Um valor de 0 (zero) significa que não há tempo limite; O comando continua indefinidamente.

Propriedades dos parâmetros

Conjuntos de parâmetros

-OperationTimeout

Determina o tempo máximo que qualquer operação na sessão pode ser executada. Quando o intervalo expira, a operação falha. Insira um valor em milissegundos.

O valor padrão é 180000 (3 minutos). Um valor de 0 (zero) significa que não há tempo limite; A operação continua por tempo indeterminado.

Propriedades dos parâmetros

Conjuntos de parâmetros

-OutputBufferingMode

Determina como a saída do comando é gerenciada em sessões desconectadas quando o buffer de saída fica cheio.

Se o modo de buffer de saída não estiver definido na sessão ou na configuração da sessão, o valor padrão será Bloco. Os usuários também podem alterar o modo de buffer de saída ao desconectar a sessão.

Se você omitir esse parâmetro, o valor do OutputBufferingMode do objeto de opção session será None. Um valor de Block ou Drop substitui a opção de transporte do modo de buffer de saída definida na configuração da sessão. Os valores aceitáveis para este parâmetro são:

• Bloquear. Quando o buffer de saída está cheio, a execução é suspensa até que o buffer esteja limpo.
• Solte. Quando o buffer de saída estiver cheio, a execução continuará. À medida que a nova saída é salva, a saída mais antiga é descartada.
• Nenhum. Nenhum modo de buffer de saída é especificado.

Para obter mais informações sobre a opção de transporte do modo de buffer de saída, consulte New-PSTransportOption.

Esse parâmetro foi introduzido no Windows PowerShell 3.0.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ProxyAccessType

Determina qual mecanismo é usado para resolver o nome do host. Os valores aceitáveis para este parâmetro são:

• IEConfig
• WinHttpConfig
• Deteção Automática
• NoProxyServer
• Nenhum

O valor padrão é None.

Para obter informações sobre os valores desse parâmetro, consulte ProxyAccessType Enumeration.

Propriedades dos parâmetros

Conjuntos de parâmetros

-ProxyAuthentication

Especifica o método de autenticação usado para a resolução de proxy. Os valores aceitáveis para este parâmetro são: Basic, Digeste Negotiate. O valor padrão é Negociar.

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

Propriedades dos parâmetros

Conjuntos de parâmetros

-ProxyCredential

Especifica as credenciais a serem usadas para autenticação de proxy. Insira uma variável que contenha um objeto PSCredential ou um comando que obtenha um objeto PSCredential, como um comando Get-Credential. Se essa opção não estiver definida, nenhuma credencial será especificada.

Propriedades dos parâmetros

Conjuntos de parâmetros

-SkipCACheck

Especifica que, quando ele se conecta por HTTPS, o cliente não valida se o certificado do servidor é assinado por uma autoridade de certificação (CA) confiável.

Use essa opção somente quando o computador remoto for confiável usando outro mecanismo, como quando o computador remoto fizer parte de uma rede fisicamente segura e isolada ou quando o computador remoto estiver listado como um host confiável em uma configuração do WinRM.

Propriedades dos parâmetros

Conjuntos de parâmetros

-SkipCNCheck

Especifica que o nome comum do certificado (CN) do servidor não precisa corresponder ao nome do host do servidor. Esta opção é usada apenas em operações remotas que usam o protocolo HTTPS.

Utilize esta opção apenas para computadores fidedignos.

Propriedades dos parâmetros

Conjuntos de parâmetros

-SkipRevocationCheck

Não valida o status de revogação do certificado do servidor.

Propriedades dos parâmetros

Conjuntos de parâmetros

-UICulture

Especifica a cultura da interface do usuário a ser usada para a sessão.

Os valores válidos incluem:

• Um nome de cultura no formato <languagecode2>-<country/regioncode2>, como ja-JP
• Uma variável que contém um objeto CultureInfo
• Um comando que obtém um objeto CultureInfo , assim como Get-Culture

O valor padrão é $nulle a cultura da interface do usuário definida no sistema operacional quando a sessão é criada é usada na sessão.

Propriedades dos parâmetros

Conjuntos de parâmetros

-UseUTF16

Indica que esse cmdlet codifica a solicitação no formato UTF16 em vez do formato UTF8.

Propriedades dos parâmetros

Conjuntos de parâmetros

CommonParameters

Entradas

None

Saídas

PSSessionOption

Notas

Ligações Relacionadas

• Entrar na sessão do PowerShell (Enter-PSSession)
• Invoke-Command
• New-PSSession