Save-Help

模組:

Microsoft.PowerShell.Core

下載並儲存最新的說明檔至檔案系統目錄。

語法

Save-Help
    [-DestinationPath] <String[]>
    [[-Module] <PSModuleInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [[-UICulture] <CultureInfo[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [<CommonParameters>]

Save-Help
    -LiteralPath <String[]>
    [[-Module] <PSModuleInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [[-UICulture] <CultureInfo[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [<CommonParameters>]

Description

Save-Help Cmdlet 會下載 PowerShell 模組的最新說明檔，並將其儲存至您指定的目錄。 此功能可讓您更新無法存取因特網之電腦上的說明檔，並讓您更輕鬆地更新多部計算機上的說明檔。

在 Windows PowerShell 3.0 中，Save-Help 僅適用於本機電腦上安裝的模組。 雖然您可以從遠端計算機匯入模組，或從遠端電腦取得 PSModuleInfo 對象的參考，但 HelpInfoUri 屬性並未保留，Save-Help 不適用於遠端模組說明。

在 Windows PowerShell 4.0 中，HelpInfoUri 屬性會透過 PowerShell 遠端功能保留，這可讓 Save-Help 適用於安裝在遠端電腦上的模組。 您也可以將 PSModuleInfo 物件儲存到磁碟或卸除式媒體，方法是在沒有因特網存取的計算機上執行 Export-Clixml、將具有因特網存取權的計算機上匯入物件，然後在 PSModuleInfo 物件上 執行 save-Help。 儲存的說明可以使用抽取式儲存媒體，例如 USB 磁碟驅動器，將已儲存的說明傳輸至遠端電腦。 您可以執行 Update-Help，將說明安裝在遠端電腦上。 此程式可用來在沒有任何網路存取權的計算機上安裝說明。

若要安裝儲存的說明檔，請執行 Update-Help Cmdlet。 新增其 SourcePath 參數，以指定儲存說明檔的資料夾。

如果沒有參數，Save-Help 命令會下載會話中所有模組的最新說明，以及安裝在電腦上之 PSModulePath 環境變數中所列位置的模組。 此動作會略過不支援可更新說明且沒有警告的模組。

Save-Help Cmdlet 會檢查目的地資料夾中任何說明檔的版本。 如果有較新的說明檔可用，此 Cmdlet 會從因特網下載最新的說明檔，然後將它們儲存在資料夾中。 Save-Help Cmdlet 的運作方式就像 Update-Help Cmdlet 一樣，不同之處在於它會儲存下載的封包 （.cab） 檔案，而不是從封包檔案擷取說明檔，並將其安裝在計算機上。

每個模組的已儲存說明包含一個說明資訊 （HelpInfo XML） 檔案，以及每個 UI 文化特性的說明檔一個封包 （.cab） 檔案。 您不需要從封包檔案擷取說明檔。 Update-Help Cmdlet 會擷取說明檔、驗證 XML 的安全性，然後在模組資料夾的語言特定子資料夾中安裝說明檔和說明資訊檔。

若要將模組的說明檔儲存在PowerShell安裝資料夾中（$pshome\Modules），請使用 [以系統管理員身分執行] 選項啟動 PowerShell。 您必須是計算機上的 Administrators 群組成員，才能下載這些模組的說明檔。

此 Cmdlet 已在 Windows PowerShell 3.0 中引進。

範例

範例 1：儲存 DhcpServer 模組的說明

# Option 1: Run Invoke-Command to get the PSModuleInfo object for the remote DHCP Server module, save the PSModuleInfo object in the variable $m, and then run Save-Help.

$m = Invoke-Command -ComputerName RemoteServer -ScriptBlock { Get-Module -Name DhcpServer -ListAvailable }
Save-Help -Module $m -DestinationPath "C:\SavedHelp"


# Option 2: Open a PSSession--targeted at the remote computer that is running the DhcpServer module--to get the PSModuleInfo object for the remote module, and then run Save-Help.

$s = New-PSSession -ComputerName "RemoteServer"
$m = Get-Module -PSSession $s -Name "DhcpServer" -ListAvailable
Save-Help -Module $m -DestinationPath "C:\SavedHelp"


# Option 3: Open a CIM session--targeted at the remote computer that is running the DhcpServer module--to get the PSModuleInfo object for the remote module, and then run Save-Help.

$c = New-CimSession -ComputerName "RemoteServer"
$m = Get-Module -CimSession $c -Name "DhcpServer" -ListAvailable
Save-Help -Module $m -DestinationPath "C:\SavedHelp"

此範例示範三種不同的方式，使用 Save-Help，從因特網連線的用戶端電腦儲存 DhcpServer 模組的說明，而不需在本機計算機上安裝 DhcpServer 模組或 DHCP 伺服器角色。

範例 2：安裝 DhcpServer 模組的說明

# First, run Export-CliXml to export the PSModuleInfo object to a shared folder or to removable media.

$m = Get-Module -Name "DhcpServer" -ListAvailable
Export-CliXml -Path "E:\UsbFlashDrive\DhcpModule.xml" -InputObject $m

# Next, transport the removable media to a computer that has Internet access, and then import the PSModuleInfo object with Import-CliXml. Run Save-Help to save the Help for the imported DhcpServer module PSModuleInfo object.

$deserialized_m = Import-CliXml "E:\UsbFlashDrive\DhcpModule.xml"
Save-Help -Module $deserialized_m -DestinationPath "E:\UsbFlashDrive\SavedHelp"

# Finally, transport the removable media back to the computer that does not have network access, and then install the help by running Update-Help.

Update-Help -Module DhcpServer -SourcePath "E:\UsbFlashDrive\SavedHelp"

此範例示範如何在沒有因特網存取的計算機上，針對 DhcpServer 模組，安裝您在範例 1 中儲存的說明。

範例 3：儲存所有模組的說明

Save-Help -DestinationPath "\\Server01\FileShare01"

此命令會針對本機電腦上的 Windows UI 文化特性集中的所有模組下載最新的說明檔。 它會將說明檔儲存在 \\Server01\Fileshare01 資料夾中。

範例 4：儲存計算機上模組的說明

Save-Help -Module ServerManager -DestinationPath "\\Server01\FileShare01" -Credential Domain01/Admin01

此命令會下載 ServerManager 模組的最新說明檔，然後將它們儲存在 \\Server01\Fileshare01 資料夾中。

當計算機上安裝模組時，即使模組未匯入目前的會話，您也可以將模組名稱輸入為 Module 參數的值。

此命令會使用 Credential 參數來提供有權寫入檔案共享的用戶認證。

範例 5：在不同的計算機上儲存模組的說明

Invoke-Command -ComputerName Server02 {Get-Module -Name CustomSQL -ListAvailable} | Save-Help -DestinationPath \\Server01\FileShare01 -Credential Domain01\Admin01

這些命令會下載 CustomSQL 模組的最新說明檔，並將其儲存在 \\Server01\Fileshare01 資料夾中。

因為 CustomSQL 模組未安裝在計算機上，因此序列包含 Invoke-Command 命令，該命令會從 Server02 計算機取得 CustomSQL 模組的模組對象，然後將模組對象傳送至 Save-Help Cmdlet。

未在計算機上安裝模組時，Save-Help 需要模組物件，其中包含最新說明檔位置的相關信息。

範例 6：以多種語言儲存模組的說明

Save-Help -Module Microsoft.PowerShell* -UICulture de-DE, en-US, fr-FR, ja-JP -DestinationPath "D:\Help"

此命令會將PowerShell Core 模組的說明儲存在四種不同的UI文化特性中。 這些地區設定的語言套件不需要安裝在計算機上。

Save-Help 只有在模組擁有者在因特網上提供翻譯檔案時，才能下載不同 UI 文化特性模組的說明檔。

範例 7：每天儲存一次以上的說明

Save-Help -Force -DestinationPath "\\Server3\AdminShare\Help"

此命令會儲存電腦上所安裝之所有模組的說明。 命令會指定 Force 參數，以覆寫規則，以防止 Save-Help Cmdlet 在每 24 小時期間下載說明一次以上。

Force 參數也會覆寫 1 GB 的限制，並規避版本檢查。 因此，即使版本不晚於目的地資料夾中的版本，您仍可下載檔。

命令會使用 Save-Help Cmdlet 來下載說明檔，並將說明檔儲存至指定的資料夾。 當您必須每天多次執行 Save-Help 命令時，需要 Force 參數。

參數

-Credential

指定用戶認證。 此 Cmdlet 會使用有權存取 DestinationPath 參數所指定文件系統位置的使用者認證來執行命令。 只有當命令中使用 DestinationPath 或 LiteralPath 參數時，此參數才有效。

此參數可讓您在遠端電腦上執行使用 DestinationPath 參數的 save-Help 命令 。 藉由提供明確的認證，您可以在遠端計算機上執行 命令，並在第三部計算機上存取檔案共用，而不會發生拒絕存取錯誤或使用 CredSSP 驗證來委派認證。

類型:	PSCredential
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-DestinationPath

指定儲存說明檔的資料夾路徑。 請勿指定檔名或擴展名。

類型:	String[]
Position:	0
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-Force

表示此 Cmdlet 不會遵循每天一次的限制、略過版本檢查，以及下載超過 1 GB 限制的檔案。

如果沒有此參數，每個模組只允許每個模組的一個 Save-Help 命令，每個模組的下載限制為 1 GB 的未壓縮內容，而模組的說明檔只有在比計算機上的檔案還新時才安裝。

每天一次的限制可保護裝載說明檔的伺服器，並讓您將 Save-Help 命令新增至 PowerShell 配置檔。

若要在多個 UI 文化特性中儲存模組的說明，而不需使用 Force 參數，請在相同的命令中包含所有 UI 文化特性，例如： Save-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR

類型:	SwitchParameter
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-FullyQualifiedModule

指定以ModuleSpecification物件形式指定之名稱的模組。 這會在 MSDN 連結庫中 ModuleSpecification 建構函式 （Hashtable） 的一節中說明。 例如，FullyQualifiedModule 參數接受以 @{ModuleName = “modulename” 格式指定的模組名稱;ModuleVersion = “version_number”} 或 @{ModuleName = “modulename”;ModuleVersion = “version_number”;Guid = “GUID”}。 需要 ModuleName 和 ModuleVersion，但 Guid 是選擇性的。

您無法在與 Module 參數相同的命令中指定 FullyQualifiedModule 參數。

類型:	ModuleSpecification[]
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-LiteralPath

指定目的地資料夾的路徑。 不同於 DestinationPath 參數的值，LiteralPath 參數的值會與類型完全相同。 不會將任何字元解譯為通配符。 如果路徑包含逸出字元，請以單引弧括住它。 單引號會告知PowerShell不要將任何字元解譯為逸出序列。

類型:	String[]
別名:	PSPath
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-Module

指定此 Cmdlet 下載說明的模組。 在逗號分隔清單中，或在每一行有一個模組名稱的檔案中，輸入一或多個模組名稱或名稱分頁。 允許通配符。 您也可以使用管線將模組物件從 Get-Module Cmdlet 傳送至 Save-Help。

根據預設，Save-Help 會針對支援可更新說明的所有模組下載說明，並安裝在本機計算機上，該位置列在 PSModulePath 環境變數中。

若要儲存電腦上未安裝之模組的說明，請在遠端電腦上執行 Get-Module 命令。 然後將產生的模組對象傳送至 save-Help Cmdlet ，或將模組物件送出為 Module 或 InputObject 參數的值。

如果您指定的模組已安裝在電腦上，您可以輸入模組名稱或模組物件。 如果模組未安裝在計算機上，您必須輸入模組物件，例如 Get-Module Cmdlet 所傳回的模組物件。

Save-Help Cmdlet Module 參數不接受模組檔案或模組指令清單檔的完整路徑。 若要儲存不在 PSModulePath 位置的模組說明，請在執行 save-Help 命令之前，先將模組匯入目前的會話。

值 “*” （all） 會嘗試更新計算機上所安裝之所有模組的說明。 這包括不支援可更新說明的模組。 當命令遇到不支援可更新說明的模組時，這個值可能會產生錯誤。

類型:	PSModuleInfo[]
別名:	Name
Position:	1
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	True

-UICulture

指定此 Cmdlet 取得更新說明檔的 UI 文化特性值。 輸入一或多個語言代碼，例如 es-ES、包含文化特性物件的變數，或取得文化特性物件的命令，例如 Get-Culture 或 Get-UICulture 命令。

不允許通配符。 請勿指定部分語言代碼，例如 「de」。

根據預設，Save-Help 在 Windows 或其後援文化特性設定的 UI 文化特性中取得說明檔案。 如果您指定 UICulture 參數，Save-Help 只尋找指定 UI 文化特性的說明，而不是在任何後援文化特性中。

類型:	CultureInfo[]
Position:	2
預設值:	Current UI culture
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-UseDefaultCredentials

指出此 Cmdlet 會執行命令，包括 Web 下載，以及目前用戶的認證。 根據預設，命令會執行，而不需明確認證。

只有當 Web 下載使用 NTLM、交涉或 Kerberos 型驗證時，此參數才有效。

類型:	SwitchParameter
Position:	Named
預設值:	False
必要:	False
接受管線輸入:	False
接受萬用字元:	False

輸入

PSModuleInfo

您可以使用管線將模組對象從 Get-Module Cmdlet 傳送至 Save-Help的 Module 參數。

輸出

None

此 Cmdlet 不會產生任何輸出。

備註

• 若要在 [$pshome\Modules] 資料夾中儲存模組的說明，請使用 [以系統管理員身分執行] 選項啟動 PowerShell。 只有電腦上的 Administrators 群組成員可以下載 $pshome\Modules 資料夾中模組的說明。
• 每個模組的已儲存說明包含一個說明資訊 （HelpInfo XML） 檔案，以及每個 UI 文化特性的說明檔一個封包 （.cab） 檔案。 您不需要從封包檔案擷取說明檔。 Update-Help Cmdlet 會擷取說明檔、驗證 XML，然後在模組資料夾的語言特定子資料夾中安裝說明檔和說明信息檔。
• Save-Help Cmdlet 可以儲存電腦上未安裝之模組的說明。 不過，由於說明檔已安裝在模組資料夾中，Update-Help Cmdlet 只能針對電腦上安裝的模組安裝更新的說明檔。
• 如果 Save-Help 找不到模組的更新說明檔，或找不到指定語言的更新說明檔，它會以無訊息方式繼續，而不會顯示錯誤訊息。 若要查看命令儲存的檔案，請指定 Verbose 參數。
• 模組是可更新說明的最小單位。 您無法儲存特定 Cmdlet 的說明，僅適用於模組中的所有 Cmdlet。 若要尋找包含特定 Cmdlet 的模組，請使用 ModuleName 屬性與 Get-Command Cmdlet，例如 (Get-Command \<cmdlet-name\>).ModuleName
• Save-Help 支援所有模組和 PowerShell Core 嵌入式管理單元。它不支援任何其他嵌入式管理單元。
• Update-Help 和 Save-Help Cmdlet 會使用下列埠來下載說明檔：HTTP 的埠 80 和 HTTPS 的埠 443。
• Windows 預安裝環境 （Windows PE） 不支援 Update-Help 和 Save-Help Cmdlet。

相關連結

• Get-Help
• Get-Module
• Update-Help