Export-PSSession

Syntax

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

Description

O Export-PSSession cmdlet 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 Import-Module cmdlet.

Ao contrário Import-PSSessiondo , 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 New-PSSession cmdlet para criar uma PSSession que tenha os comandos que você deseja exportar. Em seguida, use o Export-PSSession cmdlet para exportar os comandos.

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

O Export-PSSession cmdlet 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.

Exemplos

Exemplo 1: Exportar comandos de uma PSSession

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 New-PSSession comando cria uma PSSession no computador Server01. O PSSession é armazenado na $S variável. O Export-PSSession comando exporta os comandos da variável e os $S dados de formatação para o módulo Server01.

Exemplo 2: Exportar os comandos Get e set

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

$S = New-PSSession -ConnectionUri https://exchange.microsoft.com/mailbox -Credential exchangeadmin01@hotmail.com -Authentication Negotiate
Export-PSSession -Session $S -Module exch* -CommandName Get-*, Set-* -FormatTypeName * -OutputModule $PSHOME\Modules\Exchange -Encoding ASCII

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

Exemplo 3: Exportar comandos de um computador remoto

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.

$S = New-PSSession -ComputerName Server01 -Credential Server01\User01
Export-PSSession -Session $S -OutputModule TestCmdlets -Type Cmdlet -CommandName *test* -FormatTypeName *
Remove-PSSession $S
Import-Module TestCmdlets
Get-Help Test*
Test-Files

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

O Remove-PSSession cmdlet exclui a PSSession da $S 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 Import-Module cmdlet adiciona os cmdlets no módulo TestCmdlets à sessão atual. O comando pode ser executado em qualquer sessão a qualquer momento.

O Get-Help cmdlet 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 Get-Help cmdlets e Get-Command para aprender sobre os comandos importados. O Test-Files cmdlet foi exportado do computador Server01 e adicionado à sessão. O Test-Files cmdlet é 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.

Exemplo 4: Comandos de exportação e clobber na sessão atual

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

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

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

Exemplo 5: Exportar comandos de uma PSSession fechada

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

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

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

Parâmetros

-AllowClobber

-ArgumentList

-Certificate

-CommandName

-CommandType

-Encoding

-Force

-FormatTypeName

-FullyQualifiedModule

-Module

-OutputModule

-Session

Entradas

None

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

Saídas

FileInfo

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

Notas

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.

Você não pode 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 ele 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 capturam e salvam no módulo não incluem opções de sessão, como aquelas especificadas na $PSSessionOption variável de preferência ou usando o parâmetro SessionOption dos New-PSSessioncmdlets , 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 use o Invoke-Command cmdlet para executar um Get-Command comando no PSSession. Para obter e salvar dados de formatação para os comandos, ele usa os Get-FormatData cmdlets e Export-FormatData . Poderá ver mensagens de erro de Invoke-Command, Get-Command, Get-FormatDatae Export-FormatData quando executa um Export-PSSession comando. Além disso, Export-PSSession não é possível exportar comandos de uma sessão que não inclua os Get-Commandcmdlets , Get-FormatData, Select-Objecte Get-Help .

Export-PSSession usa o Write-Progress cmdlet 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 Invoke-Command comando para executar o perfil no PSSession manualmente antes de exportar comandos.

O módulo que cria pode incluir um arquivo de formatação, mesmo que Export-PSSession 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.

Ligações Relacionadas

• about_Command_Precedence
• about_PSSessions
• about_PSSnapins
• about_Remote_Requirements
• Import-Module
• Import-PSSession
• Invoke-Command
• New-PSSession
• New-PSSessionOption
• Remove-PSSession