Set-PSSessionConfiguration

Sintaxe

NameParameterSet (Default)

Set-PSSessionConfiguration
    [-Name] <String>
    [-ApplicationBase <String>]
    [-RunAsCredential <PSCredential>]
    [-ThreadApartmentState <ApartmentState>]
    [-ThreadOptions <PSThreadOptions>]
    [-AccessMode <PSSessionConfigurationAccessMode>]
    [-UseSharedProcess]
    [-StartupScript <String>]
    [-MaximumReceivedDataSizePerCommandMB <Double>]
    [-MaximumReceivedObjectSizeMB <Double>]
    [-SecurityDescriptorSddl <String>]
    [-ShowSecurityDescriptorUI]
    [-Force]
    [-NoServiceRestart]
    [-PSVersion <Version>]
    [-SessionTypeOption <PSSessionTypeOption>]
    [-TransportOption <PSTransportOption>]
    [-ModulesToImport <Object[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

AssemblyNameParameterSet

Set-PSSessionConfiguration
    [-Name] <String>
    [-AssemblyName] <String>
    [-ConfigurationTypeName] <String>
    [-ApplicationBase <String>]
    [-RunAsCredential <PSCredential>]
    [-ThreadApartmentState <ApartmentState>]
    [-ThreadOptions <PSThreadOptions>]
    [-AccessMode <PSSessionConfigurationAccessMode>]
    [-UseSharedProcess]
    [-StartupScript <String>]
    [-MaximumReceivedDataSizePerCommandMB <Double>]
    [-MaximumReceivedObjectSizeMB <Double>]
    [-SecurityDescriptorSddl <String>]
    [-ShowSecurityDescriptorUI]
    [-Force]
    [-NoServiceRestart]
    [-PSVersion <Version>]
    [-SessionTypeOption <PSSessionTypeOption>]
    [-TransportOption <PSTransportOption>]
    [-ModulesToImport <Object[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SessionConfigurationFile

Set-PSSessionConfiguration
    [-Name] <String>
    -Path <String>
    [-RunAsCredential <PSCredential>]
    [-ThreadApartmentState <ApartmentState>]
    [-ThreadOptions <PSThreadOptions>]
    [-AccessMode <PSSessionConfigurationAccessMode>]
    [-UseSharedProcess]
    [-StartupScript <String>]
    [-MaximumReceivedDataSizePerCommandMB <Double>]
    [-MaximumReceivedObjectSizeMB <Double>]
    [-SecurityDescriptorSddl <String>]
    [-ShowSecurityDescriptorUI]
    [-Force]
    [-NoServiceRestart]
    [-TransportOption <PSTransportOption>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Exemplos

Exemplo 1: alterar o estado do thread apartment

PS C:\> Set-PSSessionConfiguration -Name "MaintenanceShell" -ThreadApartmentState STA

Exemplo 2: Criar e alterar uma configuração de sessão

Register-PSSessionConfiguration -Name "AdminShell" -AssemblyName "C:\Shells\AdminShell.dll" -ConfigurationTypeName "AdminClass"
Set-PSSessionConfiguration -Name "AdminShell" -StartupScript "AdminConfig.ps1"
Set-PSSessionConfiguration -Name "AdminShell" -StartupScript $null

Exemplo 3: Exibir resultados

Set-PSSessionConfiguration -Name "IncObj" -MaximumReceivedObjectSizeMB 20

WSManConfig: Microsoft.WSMan.Management\WSMan::localhost\Plugin\IncObj\InitializationParameters

ParamName                       ParamValue
---------                       ----------
psmaximumreceivedobjectsizemb   20

"Restart WinRM service"
WinRM service need to be restarted to make the changes effective. Do you want to run the command "Restart-Service winrm"?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y

Exemplo 3: Exibir resultados de maneiras diferentes

Set-PSSessionConfiguration -Name "MaintenanceShell" -StartupScript "C:\ps-test\Maintenance.ps1"

WSManConfig: Microsoft.WSMan.Management\WSMan::localhost\Plugin\MaintenanceShell\InitializationParameters

ParamName            ParamValue
---------            ----------
startupscript        C:\ps-test\Mainte...

"Restart WinRM service"
WinRM service need to be restarted to make the changes effective. Do you want to run
the command "Restart-Service winrm"?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y

Get-PSSessionConfiguration MaintenanceShell | Format-List -Property *

xmlns            : http://schemas.microsoft.com/wbem/wsman/1/config/PluginConfiguration
Name             : MaintenanceShell
Filename         : %windir%\system32\pwrshplugin.dll
SDKVersion       : 1
XmlRenderingType : text
lang             : en-US
PSVersion        : 2.0
startupscript    : C:\ps-test\Maintenance.ps1
ResourceUri      : http://schemas.microsoft.com/powershell/MaintenanceShell
SupportsOptions  : true
ExactMatch       : true
Capability       : {Shell}
Permission       :

Get-ChildItem WSMan:\localhost\Plugin\MaintenanceShell\InitializationParameters

ParamName     ParamValue
---------     ----------
PSVersion     2.0
startupscript C:\ps-test\Maintenance.ps1

Parâmetros

-AccessMode

Habilita e desabilita a configuração da sessão e determina se ela pode ser usada para sessões remotas ou locais no computador. Os valores aceitáveis para este parâmetro são:

• Disabled. Desabilita a configuração da sessão. Ele não pode ser usado para acesso remoto ou local ao computador. Esse valor define a propriedade Enabled da configuração da sessão (WSMan:\<ComputerName>\PlugIn\<SessionConfigurationName>\Enabled) como False.
• Local. Adiciona uma entrada Network_Deny_All ao descritor de segurança da configuração de sessão. Os usuários do computador local podem usar a configuração de sessão para criar uma sessão de loopback local no mesmo computador, mas os usuários remotos têm acesso negado.
• Remote. Remove entradas Deny_All e Network_Deny_All dos descritores de segurança da configuração da sessão. Os usuários de computadores locais e remotos podem usar a configuração de sessão para criar sessões e executar comandos neste computador.

O valor padrão é Remote.

Outros cmdlets podem substituir o valor desse parâmetro posteriormente. Por exemplo, o cmdlet Enable-PSRemoting habilita todas as configurações de sessão no computador e permite acesso remoto a elas, e o cmdlet Disable-PSRemoting permite apenas acesso local a todas as configurações de sessão no computador.

Esse parâmetro foi introduzido no PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-ApplicationBase

Especifica o caminho do arquivo de assembly (*.dll) especificado no valor do parâmetro AssemblyName .

Propriedades do parâmetro

Conjuntos de parâmetros

-AssemblyName

Especifica o nome do assembly. Esse cmdlet cria uma configuração de sessão com base em uma classe definida em um assembly.

Insira o nome do arquivo ou o caminho completo de um arquivo de assembly .dll que define uma configuração de sessão. Se você inserir apenas o nome do arquivo, poderá inserir o caminho no valor do parâmetro ApplicationBase.

Propriedades do parâmetro

Conjuntos de parâmetros

-ConfigurationTypeName

Especifica o tipo da configuração de sessão definida no assembly no parâmetro AssemblyName . O tipo especificado deve implementar a classe System.Management.Automation.Remoting.PSSessionConfiguration.

Esse parâmetro é necessário quando você especifica um nome de assembly.

Propriedades do parâmetro

Conjuntos de parâmetros

-Confirm

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

Propriedades do parâmetro

Conjuntos de parâmetros

-Force

Suprime todos os prompts do usuário e reinicia o serviço WinRM sem solicitar. Reiniciar o serviço torna a alteração de configuração eficaz.

Para impedir uma reinicialização e suprimir o prompt de reinicialização, use o parâmetro NoServiceRestart.

Propriedades do parâmetro

Conjuntos de parâmetros

-MaximumReceivedDataSizePerCommandMB

Especifica o limite da quantidade de dados que podem ser enviados para este computador em qualquer comando remoto único. Insira o tamanho dos dados em megabytes (MB). O padrão é 50.

Se um limite de tamanho de dados for definido no tipo de configuração especificado no parâmetro ConfigurationTypeName, o limite no tipo de configuração será usado. O valor desse parâmetro é ignorado.

Propriedades do parâmetro

Conjuntos de parâmetros

-MaximumReceivedObjectSizeMB

Especifica os limites da quantidade de dados que podem ser enviados para este computador em qualquer objeto único. Insira o tamanho dos dados em megabytes. O padrão é 10.

Se um limite de tamanho de objeto for definido no tipo de configuração especificado no parâmetro ConfigurationTypeName, o limite no tipo de configuração será usado. O valor desse parâmetro é ignorado.

Propriedades do parâmetro

Conjuntos de parâmetros

-ModulesToImport

Especifica os módulos e snap-ins que são importados automaticamente para sessões que usam a configuração da sessão. Insira os nomes de módulo e snap-in.

Por padrão, somente o módulo Microsoft.PowerShell.Core é importado para sessões, mas, a menos que os cmdlets sejam excluídos, você pode usar os cmdlets e Add-PSSnapin os Import-Module cmdlets para adicionar módulos e snap-ins à sessão.

Os módulos especificados nesse valor de parâmetro são importados em adições a módulos especificados no arquivo de configuração de sessão (New-PSSessionConfigurationFile). No entanto, as configurações no arquivo de configuração de sessão podem ocultar os comandos exportados por módulos ou impedir que os usuários os usem.

Os módulos especificados nesse valor de parâmetro substituem a lista de módulos especificados pelo parâmetro ModulesToImport do Register-PSSessionConfiguration cmdlet.

Esse parâmetro foi introduzido no PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-Name

Especifica o nome da configuração de sessão que você deseja alterar.

Você não pode usar esse parâmetro para alterar o nome da configuração da sessão.

Propriedades do parâmetro

Conjuntos de parâmetros

-NoServiceRestart

Não reinicia o serviço WinRM e suprime o prompt para reiniciar o serviço.

Por padrão, ao executar , você será solicitado a reiniciar o serviço WinRM para tornar a nova configuração de sessão eficaz. Até que o serviço WinRM seja reiniciado, a nova configuração de sessão não será eficaz.

Para reiniciar o serviço WinRM sem solicitar, use o parâmetro Force. Para reiniciar o serviço WinRM manualmente, use o cmdlet .

Propriedades do parâmetro

Conjuntos de parâmetros

-Path

Especifica o caminho de um arquivo de configuração de sessão (.pssccomo um criado pelo New-PSSessionConfigurationFile cmdlet). Se você omitir o caminho, o padrão será o diretório atual.

Para obter informações sobre como modificar um arquivo de configuração de sessão, consulte o tópico de ajuda do cmdlet New-PSSessionConfigurationFile.

Esse parâmetro foi introduzido no PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-PSVersion

Especifica a versão do PowerShell em sessões que usam essa configuração de sessão.

O valor desse parâmetro tem precedência sobre o valor da chave PowerShellVersion no arquivo de configuração de sessão.

Esse parâmetro foi introduzido no PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-RunAsCredential

Especifica as credenciais para comandos na sessão. Por padrão, os comandos são executados com as permissões do usuário atual.

Esse parâmetro foi introduzido no PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-SecurityDescriptorSddl

Especifica uma cadeia de caracteres SDDL (Linguagem de Definição de Descritor de Segurança) diferente para a configuração.

Essa cadeia de caracteres determina as permissões necessárias para usar a nova configuração de sessão. Para usar uma configuração de sessão em uma sessão, os usuários devem ter pelo menos Execute(Invoke) permissão para a configuração.

Para usar o descritor de segurança padrão para a configuração, insira uma cadeia de caracteres vazia ("") ou um valor de $null. O padrão é o SDDL raiz na WSMan: unidade.

Se o descritor de segurança for complexo, considere usar o parâmetro ShowSecurityDescriptorUI em vez deste. Você não pode usar ambos os parâmetros no mesmo comando.

Propriedades do parâmetro

Conjuntos de parâmetros

-SessionTypeOption

Especifica opções específicas de tipo para a configuração da sessão. Insira um objeto de opções de tipo de sessão, como o objeto PSWorkflowExecutionOption que o cmdlet New-PSWorkflowExecutionOption retorna.

As opções de sessões que usam a configuração da sessão são determinadas pelos valores das opções de sessão e das opções de configuração de sessão. A menos que especificado, as opções definidas na sessão, como com o New-PSSessionOption cmdlet, têm precedência sobre as opções definidas na configuração da sessão. No entanto, os valores de opção de sessão não podem exceder os valores máximos definidos na configuração da sessão.

Esse parâmetro foi introduzido no PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-ShowSecurityDescriptorUI

Quando esse parâmetro é usado, o cmdlet abre uma folha de propriedades que ajuda você a criar um novo SDDL para a configuração da sessão. A folha de propriedades é exibida depois que você executa o comando e, em seguida, reinicia o serviço WinRM.

Ao definir permissões para a configuração, lembre-se de que os usuários devem ter pelo menos Execute(Invoke) permissão para usar a configuração de sessão em uma sessão.

Não é possível usar o parâmetro SecurityDescriptorSDDL e esse parâmetro no mesmo comando.

Propriedades do parâmetro

Conjuntos de parâmetros

-StartupScript

Especifica o script de inicialização para a configuração. Insira o caminho totalmente qualificado de um script do PowerShell. O script especificado é executado na nova sessão que usa a configuração da sessão.

Para excluir um script de inicialização de uma configuração de sessão, insira uma cadeia de caracteres vazia ("") ou um valor igual $nulla .

Você pode usar um script de inicialização para configurar ainda mais a sessão do usuário. Se o script gerar um erro, mesmo um erro de não encerramento, a sessão não será criada e o comando New-PSSession falhará.

Propriedades do parâmetro

Conjuntos de parâmetros

-ThreadApartmentState

Especifica o estado do apartamento do módulo de threading a ser usado. Os valores aceitáveis são:

• Unknown
• MTA
• STA

Propriedades do parâmetro

Conjuntos de parâmetros

-ThreadOptions

Especifica a configuração de opções de thread na configuração. Essa configuração define como os threads são criados e usados quando um comando é executado na sessão. Os valores aceitáveis para este parâmetro são:

• Default
• ReuseThread
• UseCurrentThread
• UseNewThread

O valor padrão é UseCurrentThread.

Para obter mais informações, consulte de Enumeração PSThreadOptions .

Propriedades do parâmetro

Conjuntos de parâmetros

-TransportOption

Especifica as opções de transporte para a configuração da sessão. Insira um objeto de opções de transporte, como o objeto WSManConfigurationOption que o cmdlet retorna.

As opções de sessões que usam a configuração da sessão são determinadas pelos valores das opções de sessão e das opções de configuração de sessão. A menos que especificado, as opções definidas na sessão, como com o New-PSSessionOption cmdlet, têm precedência sobre as opções definidas na configuração da sessão. No entanto, os valores de opção de sessão não podem exceder os valores máximos definidos na configuração da sessão.

Esse parâmetro foi introduzido no PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-UseSharedProcess

Use apenas um processo para hospedar todas as sessões iniciadas pelo mesmo usuário e usar a mesma configuração de sessão. Por padrão, cada sessão é hospedada em seu próprio processo.

Esse parâmetro foi introduzido no PowerShell 3.0.

Propriedades do parâmetro

Conjuntos de parâmetros

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Conjuntos de parâmetros

CommonParameters

Entradas

None

Saídas

WSManConfigLeafElement

Observações

Links Relacionados

• Disable-PSSessionConfiguration
• Disable-PSSessionConfiguration
• Get-PSSessionConfiguration
• New-PSSessionConfigurationFile
• New-PSSessionOption
• New-PSTransportOption
• New-PSWorkflowExecutionOption
• Register-PSSessionConfiguration
• Test-PSSessionConfigurationFile
• Unregister-PSSessionConfiguration
• Provedor WSMan
• sobre_Configurações_de_Sessão
• about_Session_Configuration_Files