Export-Console
將目前工作階段中嵌入式管理單元的名稱匯出至主控台檔案。
語法
Export-Console [[-Path] <string>] [-Force] [-NoClobber] [-Confirm] [-WhatIf] [<CommonParameters>]
描述
Export-Console Cmdlet 會將目前工作階段中 Windows PowerShell 嵌入式管理單元的名稱匯出至 Windows PowerShell 主控台檔案 (.psc1)。您可以使用此 Cmdlet 儲存嵌入式管理單元,在未來的工作階段中使用。
若要將 .psc1 主控台檔案中的嵌入式管理單元新增至工作階段,請透過使用 Cmd.exe 或另一個 Windows PowerShell 工作階段,在命令列啟動 Windows PowerShell (PowerShell.exe),然後使用 PowerShell.exe 的 PSConsoleFile 參數指定主控台檔案。
如需 Windows PowerShell 嵌入式管理單元的詳細資訊,請參閱 about_PSSnapins。
參數
-Force
覆寫主控台檔案的資料而不顯示警告,即使檔案具有唯讀屬性也一樣。唯讀屬性將被變更,且命令完成後不會重設。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-NoClobber
不會覆寫 (取代) 現有主控台檔案的內容。根據預設,如果有檔案現存於指定的路徑,Export-Console 將覆寫該檔案而不顯示警告。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-Path <string>
指定主控台檔案 (*.psc1) 的路徑和檔名。輸入路徑 (選擇性) 和名稱。不允許使用萬用字元。
如果只輸入檔名,Export-Console 會在目前目錄中建立具有該名稱和 ".psc1" 副檔名的檔案。
除非您在目前工作階段期間曾經以 PSConsoleFile 參數開啟 Windows PowerShell 或匯出主控台檔案,否則一定要指定此參數。若您使用 NoClobber 參數防止覆寫目前的主控台檔案,也必須指定此參數。
如果省略此參數,Export-Console 會覆寫目前工作階段中最近使用的主控台檔案 (取代檔案內容)。最近所使用之主控台檔案的路徑係儲存在 $ConsoleFileName 自動變數的值中。如需詳細資訊,請參閱 about_Automatic_Variables。
必要? |
false |
位置? |
1 |
預設值 |
|
接受管線輸入? |
true (ByValue, ByPropertyName) |
接受萬用字元? |
false |
-Confirm
在執行命令前先提示確認。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
-WhatIf
說明執行命令時將會發生何種情況,但不會實際執行命令。
必要? |
false |
位置? |
named |
預設值 |
|
接受管線輸入? |
false |
接受萬用字元? |
false |
<CommonParameters>
這個 Cmdlet 支援一般參數:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。如需詳細資訊,請參閱 about_Commonparameters.
輸入和輸出
輸入型別是可經由管道輸出至 Cmdlet 的物件型別。傳回型別則是 Cmdlet 所傳回的物件型別。
輸入 |
System.String 您可以經由管道將路徑字串輸出至 Export-Console。 |
輸出 |
System.IO.FileInfo Export-Console 會建立包含匯出別名的檔案。 |
附註
使用主控台檔案 (.psc1) 啟動工作階段時,主控台檔案的名稱會自動儲存在 $ConsoleFileName 自動變數中。當您使用 Export-Console 的 Path 參數指定新的主控台檔案時,便會更新 $ConsoleFileName 的值。未使用主控台檔案時,$ConsoleFileName 就沒有值 ($null)。
若要在新的工作階段中使用 Windows PowerShell 主控台檔案,請使用下列語法啟動 Windows PowerShell:
"powershell.exe -PsConsoleFile <ConsoleFile>.psc1"。
您也可以將 Add-PSSnapin 命令新增至 Windows PowerShell 設定檔,藉以儲存 Windows PowerShell 嵌入式管理單元供未來工作階段使用。如需詳細資訊,請參閱 about_Profiles。
範例 1
C:\PS>export-console -path $pshome\Consoles\ConsoleS1.psc1
描述
-----------
這個命令會將目前工作階段中 Windows PowerShell 嵌入式管理單元的名稱匯出至 Windows PowerShell 安裝目錄 $pshome 之 Consoles 子目錄中的 ConsoleS1.psc1 檔案。
範例 2
C:\PS>export-console
描述
-----------
這個命令會從目前的工作階段,將 Windows PowerShell 嵌入式管理單元的名稱匯出至目前工作階段中最近所使用的 Windows PowerShell 主控台檔案。它會覆寫先前的檔案內容。
如果您未在目前工作階段期間匯出主控台檔案,便會出現提示,要求您提供權限才能繼續執行,並接著提示您提供檔名。
範例 3
C:\PS>add-pssnapin NewPSSnapin
C:\PS> export-console -path NewPSSnapinConsole.psc1
C:\PS> powershell.exe -PsConsoleFile NewPsSnapinConsole.psc1
描述
-----------
這些命令會將 NewPSSnapin Windows PowerShell 嵌入式管理單元新增至目前工作階段、將目前工作階段中 Windows PowerShell 嵌入式管理單元的名稱匯出至主控台檔案,再以該主控台檔案啟動 Windows PowerShell 工作階段。
第一個命令會使用 Add-PSSnapin Cmdlet 將 NewPSSnapin 嵌入式管理單元新增至目前工作階段。您只能新增系統上已註冊的 Windows PowerShell 嵌入式管理單元。
第二個命令會將 Windows PowerShell 嵌入式管理單元的名稱匯出至 NewPSSnapinConsole.psc1 檔案。
第三個命令會以 NewPSSnapinConsole.psc1 檔案啟動 Windows PowerShell。因為主控台檔案包含 Windows PowerShell 嵌入式管理單元的名稱,所以您就可以在目前工作階段中使用該嵌入式管理單元內的 Cmdlet 和提供者。
範例 4
C:\PS>export-console -path Console01
C:\PS> notepad console01.psc1
<?xml version="1.0" encoding="utf-8"?>
<PSConsoleFile ConsoleSchemaVersion="1.0">
<PSVersion>2.0</PSVersion>
<PSSnapIns>
<PSSnapIn Name="NewPSSnapin" />
</PSSnapIns>
</PSConsoleFile>
描述
-----------
這個命令會將目前工作階段中 Windows PowerShell 嵌入式管理單元的名稱匯出至目前目錄中的 Console01.psc1 檔案。
第二個命令會在 [記事本] 中顯示 Console01.psc1 檔案的內容。
範例 5
C:\PS>powershell.exe -PSConsoleFile Console01.psc1
C:\PS> add-pssnapin MySnapin
C:\PS> export-console NewConsole.psc1
C:\PS> $consolefilename
C:\PS> add-pssnapin SnapIn03
C:\PS> export-console
描述
-----------
在這個範例中,會示範如何利用 $ConsoleFileName 自動變數,在您使用 Export-Console 但未指定 Path 參數值時,決定將會更新的主控台檔案。
第一個命令會使用 PowerShell.exe 的 PSConsoleFile 參數,開啟 Windows PowerShell 及 Console01.psc1 檔案。
第二個命令會使用 Add-PSSnapin Cmdlet 將 MySnapin Windows PowerShell 嵌入式管理單元新增至目前工作階段。
第三個命令會使用 Export-Console Cmdlet 將工作階段中所有 Windows PowerShell 嵌入式管理單元的名稱匯出至 NewConsole.psc1 檔案。
第四個命令會使用 $ConsoleFileName 參數,顯示最近使用的主控台檔案。範例輸出顯示 NewConsole.ps1 是最近使用的檔案。
第五個命令會將 SnapIn03 新增至目前主控台。
第六個命令會使用 ExportConsole Cmdlet 但不指定 Path 參數,將目前工作階段中所有 Windows PowerShell 嵌入式管理單元的名稱匯出至最近使用的檔案 NewConsole.psc1。