Export-PSSession

Export-PSSession
    [-OutputModule] <String>
    [[-CommandName] <String[]>]
    [[-FormatTypeName] <String[]>]
    [-Session] <PSSession>
    [-Force]
    [-Encoding <Encoding>]
    [-AllowClobber]
    [-ArgumentList <Object[]>]
    [-CommandType <CommandTypes>]
    [-Module <String[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [-Certificate <X509Certificate2>]
    [<CommonParameters>]

O cmdlet Export-PSSession obtém cmdlets, funções, aliases e outros tipos de comando de outra sessão do PowerShell (PSSession) em um computador local ou remoto e os salva em um módulo do PowerShell. Para adicionar os comandos do módulo à sessão atual, use o cmdlet Import-Module.

Ao contrário do Import-PSSession, que importa comandos de outro PSSession para a sessão atual, Export-PSSession salva os comandos em um módulo. Os comandos não são importados para a sessão atual.

Para exportar comandos, use o cmdlet New-PSSession para criar um PSSession que tenha os comandos que você deseja exportar. Em seguida, use o cmdlet Export-PSSession para exportar os comandos.

Para evitar conflitos de nome de comando, o padrão para Export-PSSession é exportar todos os comandos, exceto os comandos que existem na sessão atual. Você pode usar o parâmetro CommandName para especificar os comandos a serem exportados.

O cmdlet Export-PSSession usa o recurso de comunicação remota implícita do PowerShell. Quando você importa comandos para a sessão atual, eles são executados implicitamente na sessão original ou em uma sessão semelhante no computador de origem.

Este exemplo cria uma nova PSSession do computador local para o computador Server01. Todos os comandos, exceto aqueles que existem na sessão atual, são exportados para o módulo chamado Server01 no computador local. A exportação inclui os dados de formatação para os comandos.

$S = New-PSSession -ComputerName Server01
Export-PSSession -Session $S -OutputModule Server01

O comando New-PSSession cria uma PSSession no computador Server01. A PSSession é armazenada na variável $S. O comando Export-PSSession exporta os comandos e dados de formatação da variável $S para o módulo Server01.

Este exemplo exporta todos os comandos Get e Set de um servidor.

$newSession = @{
    ConnectionUri = 'https://exchange.microsoft.com/mailbox'
    Credential = 'exchangeadmin01@hotmail.com'
    Authentication = 'Negotiate'
}
$S = New-PSSession @newSession

$exportSession = @{
    Session = $S
    Module = 'exch*'
    CommandName = 'Get-*', 'Set-*'
    FormatTypeName = '*'
    OutputModule = "$PSHOME\Modules\Exchange"
    Encoding = 'ascii'
}

Export-PSSession @exportSession

Esses comandos exportam os comandos Get e Set de um snap-in do Microsoft Exchange Server em um computador remoto para um módulo do Exchange no diretório $PSHOME\Modules no computador local. Colocar o módulo no diretório $PSHOME\Modules o torna acessível a todos os usuários do computador.

Este exemplo exporta cmdlets de uma PSSession em um computador remoto e os salva em um módulo no computador local. Os cmdlets do módulo são adicionados à sessão atual para que possam ser usados.

$newSession = @{
    ComputerName = 'Server01'
    Credential = 'Server01\User01'
}
$S = New-PSSession @newSession

$exportSession = @{
    Session = $S
    OutputModule = 'TestCmdlets'
    Type = 'Cmdlet'
    CommandName = '*test*'
    FormatTypeName = '*'
}
Export-PSSession @exportSession

Remove-PSSession $S
Import-Module TestCmdlets
Get-Help Test*
Test-Files

O comando New-PSSession cria uma PSSession no computador Server01 e a salva na variável $S. O comando Export-PSSession exporta os cmdlets cujos nomes começam com Test do PSSession no $S para o módulo TestCmdlets no computador local.

O cmdlet Remove-PSSession exclui o PSSession em $S da sessão atual. Este comando mostra que o PSSession não precisa estar ativo para usar os comandos que foram importados da sessão. O cmdlet Import-Module adiciona os cmdlets no módulo TestCmdlets à sessão atual. O comando pode ser executado em qualquer sessão a qualquer momento.

O cmdlet Get-Help obtém ajuda para cmdlets cujos nomes começam com Test. Depois que os comandos em um módulo forem adicionados à sessão atual, você poderá usar os cmdlets Get-Help e Get-Command para aprender sobre os comandos importados. O cmdlet Test-Files foi exportado do computador Server01 e adicionado à sessão. O cmdlet Test-Files é executado em uma sessão remota no computador do qual o comando foi importado. O PowerShell cria uma sessão a partir de informações armazenadas no módulo TestCmdlets.

Este exemplo exporta comandos armazenados em uma variável para a sessão atual.

Export-PSSession -Session $S -AllowClobber -OutputModule AllCommands

Este comando Export-PSSession exporta todos os comandos e todos os dados de formatação da PSSession na variável $S para a sessão atual. O parâmetro AllowClobber inclui comandos com os mesmos nomes que os comandos na sessão atual.

Este exemplo mostra como executar os comandos exportados com opções especiais quando a PSSession que criou os comandos exportados é fechada.

Se a sessão remota original for fechada quando um módulo for importado, o módulo usará qualquer sessão remota aberta que se conecte ao computador de origem. Se não houver nenhuma sessão atual para o computador de origem, o módulo restabelecerá uma sessão.

Para executar comandos exportados com opções especiais em uma sessão remota, você deve criar uma sessão remota com essas opções antes de importar o módulo. Use o cmdlet New-PSSession com o parâmetro SessionOption

$Options = New-PSSessionOption -NoMachineProfile
$S = New-PSSession -ComputerName Server01 -SessionOption $Options
Export-PSSession -Session $S -OutputModule Server01
Remove-PSSession $S
New-PSSession -ComputerName Server01 -SessionOption $Options
Import-Module Server01

O cmdlet New-PSSessionOption cria um objeto PSSessionOption e salva o objeto na variável $Options. O comando New-PSSession cria uma PSSession no computador Server01. O parâmetro SessionOption usa o objeto armazenado em $Options. A sessão é armazenada na variável $S.

O cmdlet Export-PSSession exporta comandos do PSSession no $S para o módulo Server01. O cmdlet Remove-PSSession exclui o PSSession na variável $S.

O cmdlet New-PSSession cria uma nova PSSession que se conecta ao computador Server01. O parâmetro SessionOption usa o objeto armazenado em $Options. O cmdlet Import-Module importa os comandos do módulo Server01. Os comandos no módulo são executados no PSSession no computador Server01.

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.

Não é possível canalizar objetos para este cmdlet.

Este cmdlet retorna uma lista de arquivos que compõem o módulo que ele criou.

Export-PSSession depende da infraestrutura remota do PowerShell. Para usar esse cmdlet, o computador deve ser configurado para comunicação remota. Para obter mais informações, consulte about_Remote_Requirements.

Não é possível usar Export-PSSession para exportar um provedor do PowerShell.

Os comandos exportados são executados implicitamente na PSSession da qual foram exportados. Os detalhes da execução remota dos comandos são tratados inteiramente pelo PowerShell. Você pode executar os comandos exportados da mesma forma que executaria os comandos locais.

Export-ModuleMember captura e salva informações sobre o PSSession no módulo que exporta. Se o PSSession do qual os comandos foram exportados for fechado quando você importar o módulo e não houver PSSessions ativos para o mesmo computador, os comandos no módulo tentarão recriar o PSSession. Se as tentativas de recriar o PSSession falharem, os comandos exportados não serão executados.

As informações de sessão que Export-ModuleMember captura e salva no módulo não incluem opções de sessão, como aquelas especificadas na variável de preferência $PSSessionOption ou usando o parâmetro SessionOption dos cmdlets New-PSSession, Enter-PSSessionou Invoke-Command. Se o PSSession original for fechado quando você importar o módulo, o módulo usará outro PSSession para o mesmo computador, se houver um disponível. Para permitir que os comandos importados sejam executados em uma sessão configurada corretamente, crie uma PSSession com as opções desejadas antes de importar o módulo.

Para localizar os comandos a serem exportados, Export-PSSession usa o cmdlet Invoke-Command para executar um comando Get-Command no PSSession. Para obter e salvar dados de formatação para os comandos, ele usa os cmdlets Get-FormatData e Export-FormatData. Poderá ver mensagens de erro de Invoke-Command, Get-Command, Get-FormatDatae Export-FormatData quando executa um comando Export-PSSession. Além disso, Export-PSSession não pode exportar comandos de uma sessão que não inclua os cmdlets Get-Command, Get-FormatData, Select-Objecte Get-Help.

Export-PSSession usa o cmdlet Write-Progress para exibir o progresso do comando. Você pode ver a barra de progresso enquanto o comando está em execução.

Os comandos exportados têm as mesmas limitações que outros comandos remotos, incluindo a incapacidade de iniciar um programa com uma interface de usuário, como o Bloco de Notas.

Como os perfis do PowerShell não são executados em PSSessions, os comandos que um perfil adiciona a uma sessão não estão disponíveis para Export-PSSession. Para exportar comandos de um perfil, use um comando Invoke-Command para executar o perfil no PSSession manualmente antes de exportar comandos.

O módulo que Export-PSSession cria pode incluir um arquivo de formatação, mesmo que o comando não importe dados de formatação. Se o comando não importar dados de formatação, os arquivos de formatação criados não conterão dados de formatação.