Export-PSSession

Syntax

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

Description

Cmdlet 會 Export-PSSession 從本機或遠端電腦上的另一個 PowerShell 會話 （PSSession） 取得 Cmdlet、函式、別名和其他命令類型，並將其儲存在 PowerShell 模組中。 若要將模組中的命令新增至目前的會話，請使用 Import-Module Cmdlet。

不同於 Import-PSSession將命令從另一個 PSSession 匯入至目前工作階段的 ，會將 Export-PSSession 命令儲存在模組中。 命令不會匯入目前的會話。

若要匯出命令，請使用 New-PSSession Cmdlet 建立具有您要匯出之命令的 PSSession。 Export-PSSession然後使用 Cmdlet 匯出命令。

若要防止命令名稱衝突，的預設值 Export-PSSession 是導出所有命令，但目前會話中存在的命令除外。 您可以使用 CommandName 參數來指定要匯出的命令。

Cmdlet Export-PSSession 使用 PowerShell 的隱含遠端功能。 當您將命令匯入目前工作階段時，它們會在原始工作階段或原始電腦上的類似工作階段中隱含執行。

範例

範例 1：從 PSSession 導出命令

此範例會從本機計算機建立新的 PSSession 到 Server01 計算機。 除了目前會話中存在的命令之外，所有命令都會匯出至本機計算機上的名為 Server01 的模組。 匯出包含命令的格式數據。

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

命令 New-PSSession 會在 Server01 計算機上建立 PSSession。 PSSession 會儲存在變數中 $S 。 命令會將Export-PSSession$S變數的命令和格式化數據匯出至 Server01 模組。

範例 2：匯出 Get 和 Set 命令

此範例會從伺服器匯出所有 Get 和 Set 命令。

$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

這些命令會將和 命令從遠端電腦上的 Microsoft Exchange Server 嵌入式管理單元導出GetSet至本機電腦上的目錄中的 Exchange 模組$PSHOME\Modules。 將模組放在 $PSHOME\Modules 目錄中可讓計算機的所有使用者存取。

範例 3：從遠端計算機匯出命令

此範例會從遠端電腦上的 PSSession 匯出 Cmdlet，並將其儲存在本機電腦上的模組中。 模組中的 Cmdlet 會新增至目前的工作階段，以便使用它們。

$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

New-PSSession命令會在 Server01 計算機上建立 PSSession，並將它儲存在 變數中$S。 命令會將 Export-PSSession 名稱開頭為 Test 的 Cmdlet，從中的 PSSession $S 匯出至本機電腦上的 TestCmdlets 模組。

Cmdlet Remove-PSSession 會從目前的會話中刪除 中的 $S PSSession。 此命令顯示 PSSession 不需要使用從工作階段匯入的命令。 Cmdlet 會將 Import-Module TestCmdlet 模組中的 Cmdlet 新增至目前的作業階段。 命令可以隨時在任何會話中執行。

Cmdlet Get-Help 會取得名稱開頭為 Test 之 Cmdlet 的說明。 將模組中的命令新增至目前的會話之後，您可以使用 Get-Help 和 Get-Command Cmdlet 來了解匯入的命令。 Cmdlet Test-Files 是從 Server01 計算機導出，並新增至會話。 Cmdlet Test-Files 會在匯入命令的計算機遠端會話中執行。 PowerShell 會從儲存在 TestCmdlet 模組中的資訊建立會話。

範例 4：目前會話中的導出和 clobber 命令

此範例會將儲存在變數中的命令導出至目前的會話。

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

此命令 Export-PSSession 會將變數中 $S PSSession 的所有命令和所有格式化數據匯出至目前的會話。 AllowClobber 參數包含與目前工作階段中命令名稱相同的命令。

範例 5：從關閉的 PSSession 導出命令

此範例示範如何在關閉建立匯出命令的 PSSession 關閉時，以特殊選項執行導出的命令。

如果匯入模組時關閉原始遠端會話，模組將會使用任何連線到原始計算機的開啟遠端會話。 如果原始計算機沒有目前的會話，模組將會重新建立會話。

若要在遠端會話中執行具有特殊選項的匯出命令，您必須先使用這些選項建立遠端會話，才能匯入模組。 搭配 SessionOption 參數使用 New-PSSession Cmdlet

$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

Cmdlet New-PSSessionOption 會 建立 PSSessionOption 物件，並將物件儲存在變數中 $Options 。 命令 New-PSSession 會在 Server01 計算機上建立 PSSession。 SessionOption 參數會使用儲存在 中的$Options物件。 會話會儲存在變數中 $S 。

Cmdlet 會將 Export-PSSession 命令從 中的 $S PSSession 匯出至 Server01 模組。 Cmdlet Remove-PSSession 會刪除變數中的 $S PSSession。

Cmdlet New-PSSession 會建立連線到 Server01 計算機的新 PSSession。 SessionOption 參數會使用儲存在 中的$Options物件。 Cmdlet Import-Module 會從 Server01 模組匯入命令。 模組中的命令會在 Server01 計算機上的 PSSession 中執行。

參數

-AllowClobber

-ArgumentList

-Certificate

-CommandName

-CommandType

-Encoding

-Force

-FormatTypeName

-FullyQualifiedModule

-Module

-OutputModule

-Session

輸入

None

您無法使用管線將物件傳送至此 Cmdlet。

輸出

FileInfo

此 Cmdlet 會傳回組成所建立模組的檔案清單。

備註

Windows PowerShell 包含下列的 Export-PSSession別名：

• epsn

Export-PSSession 依賴PowerShell遠端基礎結構。 若要使用此 Cmdlet，計算機必須設定為遠端處理。 如需詳細資訊，請參閱 about_Remote_Requirements。

您無法使用 Export-PSSession 匯出 PowerShell 提供者。

導出的命令會在導出的 PSSession 中隱含執行。 PowerShell 會完全處理遠端執行命令的詳細數據。 您可以執行導出的命令，就像執行本機命令一樣。

Export-ModuleMember 擷取並儲存其匯出模組中 PSSession 的相關信息。 如果您匯入模組時關閉匯出命令的 PSSession，而且同一部計算機沒有作用中的 PSSession，則模組中的命令會嘗試重新建立 PSSession。 如果嘗試重新建立 PSSession 失敗，則導出的命令將不會執行。

擷取並儲存在模組中的會話資訊不包含會話選項，例如您在$PSSessionOption喜好設定變數中指定的會話資訊Export-ModuleMember，或使用、 Enter-PSSession或 Invoke-Command Cmdlet 的 New-PSSessionSessionOption 參數。 如果您在匯入模組時關閉原始 PSSession，如果有另一部 PSSession 可供使用，該模組將會使用另一部 PSSession 至同一部計算機。 若要讓匯入的命令在正確設定的會話中執行，請使用您想要的選項建立 PSSession，再匯入模組。

若要尋找要導出的命令， Export-PSSession 請使用 Invoke-Command Cmdlet 在 PSSession 中執行 Get-Command 命令。 若要取得及儲存命令的格式數據，它會使用 Get-FormatData 和 Export-FormatData Cmdlet。 當您執行Export-PSSession命令時，您可能會看到 、Get-CommandInvoke-Command、 Get-FormatData和 Export-FormatData 的錯誤訊息。 此外， Export-PSSession 無法從不包含 Get-Command、 Get-FormatData、 Select-Object和 Get-Help Cmdlet 的工作階段匯出命令。

Export-PSSession 會使用 Write-Progress Cmdlet 來顯示命令的進度。 當命令執行時，您可能會看到進度列。

導出的命令與其他遠端命令具有相同的限制，包括無法使用使用者介面啟動程式，例如 記事本。

由於 PowerShell 設定檔不會在 PSSessions 中執行，因此設定檔新增至工作階段的命令不適用於 Export-PSSession。 若要從配置檔匯出命令，請在匯出命令之前，先使用 Invoke-Command 命令在 PSSession 中手動執行配置檔。

建立的模組 Export-PSSession 可能包含格式化檔案，即使命令未匯入格式化數據也一樣。 如果命令未匯入格式化數據，所建立的任何格式化檔案都不會包含格式化數據。

相關連結

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