Save-Help

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

從 Windows PowerShell 4.0 開始，您可以使用 Save-Help 下載遠端電腦上所安裝模組的說明檔。 您也可以在沒有因特網存取的計算機上使用 Export-Clixml 儲存 PSModuleInfo 物件、在具有因特網存取的計算機上匯入物件，然後在 PSModuleInfo 對象上執行 Save-Help。 儲存說明之後，您可以執行 Update-Help，將它複製到遠端電腦並加以安裝。 此程式可用來在沒有任何網路存取權的計算機上安裝說明。

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

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

每個模組的已儲存說明包含一個說明資訊（HelpInfo XML）檔案和封包或 ZIP 封存盤（.cab 或 .zip），以取得每個語言的說明檔。 在 Windows 上，命令會下載封包檔案。 在 Linux 和 macOS 上，命令會下載 ZIP 檔案。

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

若要安裝儲存的說明檔，請使用 SourcePath 參數執行 Update-Help，以指定包含已儲存說明檔案的資料夾。 Update-Help 從封存擷取說明檔，並將其安裝在適當的位置。

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

# Option 1:
# 1. Run Invoke-Command to get the PSModuleInfo object for the DhcpServer module,
# 2. Save-Help on the PSModuleInfo object to save the help files to a folder on
#    the local computer.

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


# Option 2:
# 1. Open a PSSession to the remote computer that's running the DhcpServer module
# 2. Get the PSModuleInfo object from the remote computer
# 3. Save-Help on the PSModuleInfo object

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


# Option 3:
# 1. Open a CimSession to the remote computer that's running the DhcpServer module
# 2. Get the PSModuleInfo object from the remote computer
# 3. Save-Help on the PSModuleInfo object
$cimsession = New-CimSession -ComputerName "RemoteServer"
$mod = Get-Module -CimSession $cimsession -Name "DhcpServer" -ListAvailable
Save-Help -Module $mod -DestinationPath "C:\SavedHelp"

此範例示範如何為未連線網路的計算機安裝說明。 在此範例中，第一部計算機未連線到可存取的網路。 檔案必須使用卸除式媒體複製到該檔案。 第二部計算機連線到因特網，並可下載說明檔。

# On the first computer, get the PSModuleInfo object for the module and save it to
# removable media.

Get-Module -Name "DhcpServer" -ListAvailable |
    Export-CliXml -Path E:\UsbFlashDrive\DhcpModule.xml

# Move the removable media to a computer that has internet access, and then import the
# PSModuleInfo object. Run Save-Help on the imported PSModuleInfo object and save the help
# files to the removable media.

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

# Finally, move the removable media back to the first computer and install the help.

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

此命令會下載本機計算機上所有模組的最新說明檔。 它會將說明檔儲存在 \\Server01\Fileshare01 資料夾中。

Save-Help -DestinationPath \\Server01\FileShare01

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

$saveHelpSplat = @{
    Module = 'ServerManager'
    DestinationPath = '\\Server01\FileShare01'
    Credential = 'Domain01/Admin01'
}
Save-Help @saveHelpSplat

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

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

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

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

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

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

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

$saveHelpSplat = @{
    Module = 'Microsoft.PowerShell*'
    UICulture = 'de-DE', 'en-US', 'fr-FR', 'ja-JP'
    DestinationPath = "D:\Help"
}
Save-Help @saveHelpSplat

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

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

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

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

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

PSModuleInfo

您可以使用管線將模組物件傳送至此 Cmdlet。

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 嵌入式管理單元。它不支援任何其他嵌入式管理單元。
• Update-Help 和 Save-Help Cmdlet 會使用下列埠來下載說明檔：HTTP 的埠 80 和 HTTPS 的埠 443。
• Windows 預安裝環境 （Windows PE） 不支援 Update-Help 和 Save-Help Cmdlet。