Save-Help

Save-Help コマンドレットは、PowerShell モジュールの最新のヘルプ ファイルをダウンロードし、指定したディレクトリに保存します。 この機能を使用すると、インターネットにアクセスできないコンピューター上のヘルプ ファイルを更新し、複数のコンピューター上のヘルプ ファイルを簡単に更新できます。 このコマンドレットは、Windows PowerShell 3.0 で導入されました。

Windows PowerShell 4.0 以降では、 Save-Help を使用して、リモート コンピューターにインストールされているモジュールのヘルプ ファイルをダウンロードできます。 インターネットにアクセスできないコンピューターにを使用して Export-Clixml オブジェクトを保存し、インターネットにアクセスできるコンピューターにオブジェクトをインポートしてから、Save-Help オブジェクトで実行することもできます。 保存したヘルプをリモート コンピューターにコピーし、 Update-Helpを実行してインストールできます。 このプロセスを使用して、ネットワーク アクセス権のないコンピューターにヘルプをインストールできます。

パラメーターがない場合、 Save-Help コマンドは、セッション内のすべてのモジュールと、 PSModulePath 環境変数にリストされている場所にあるコンピューターにインストールされているモジュールに関する最新のヘルプをダウンロードします。 このアクションでは、警告なしで更新可能なヘルプをサポートしていないモジュールはスキップされます。

Save-Help コマンドレットは、移動先フォルダー内のヘルプ ファイルのバージョンを確認します。 新しいヘルプ ファイルが使用可能な場合、このコマンドレットは最新のヘルプ ファイルをインターネットからダウンロードし、フォルダーに保存します。 Save-Help コマンドレットは、ヘルプ ファイルを抽出してコンピューターにインストールするのではなく、ダウンロードしたコンテンツを保存する点を除いて、Update-Help コマンドレットと同じように動作します。

各モジュールの保存されたヘルプは、1 つのヘルプ情報 (HelpInfo XML) ファイルと、各言語のヘルプ ファイルのキャビネットまたは ZIP アーカイブ (.cab または .zip) で構成されます。 Windows では、コマンドによってキャビネット ファイルがダウンロードされます。 Linux および macOS では、コマンドによって ZIP ファイルがダウンロードされます。

モジュールのヘルプ ファイルを PowerShell インストール フォルダー ($PSHOME\Modules) に保存するには、[ 管理者として実行] オプションを使用して PowerShell を起動します。 これらのモジュールのヘルプ ファイルをダウンロードするには、コンピューターの Administrators グループのメンバーである必要があります。

保存したヘルプ ファイルをインストールするには、Update-Help パラメーターを指定してを実行し、保存されたヘルプ ファイルを含むフォルダーを指定します。 Update-Help は、アーカイブからヘルプ ファイルを抽出し、適切な場所にインストールします。

この例では、 Save-Help を使用して、 DhcpServer モジュールまたは DHCP サーバーの役割をローカル コンピューターにインストールせずに、インターネットに接続されたクライアント コンピューターから DhcpServer モジュールのヘルプを保存する 3 つの異なる方法を示します。

# 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"

この例では、ネットワークに接続されていないコンピューターのヘルプをインストールする方法を示します。 この例では、最初のコンピューターがアクセス可能なネットワークに接続されていません。 リムーバブル メディアを使用してファイルをコピーする必要があります。 2 台目のコンピューターはインターネットに接続されており、ヘルプ ファイルをダウンロードできます。

# 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 モジュールはコンピューターにインストールされていないため、シーケンスには、Server02 コンピューターから CustomSQL モジュールのモジュール オブジェクトを取得し、モジュール オブジェクトを Invoke-Command コマンドレットにパイプするSave-Help コマンドが含まれています。

モジュールがコンピューターにインストールされていない場合、 Save-Help は最新のヘルプ ファイルの場所に関する情報を含むモジュール オブジェクトを必要とします。

このコマンドは、4 つの異なる UI カルチャのコア PowerShell モジュールのヘルプを保存します。 これらのロケールの言語パックをコンピューターにインストールする必要はありません。

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

Save-Help では、モジュール所有者が翻訳されたファイルをインターネット上で使用できるようにする場合にのみ、異なる UI カルチャのモジュールのヘルプ ファイルをダウンロードできます。

このコマンドは、コンピューターにインストールされているすべてのモジュールのヘルプを保存します。 このコマンドは、 コマンドレットが 24 時間ごとに複数回ヘルプをダウンロードできないようにするルールをオーバーライドする Save-Help パラメーターを指定します。

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

Force パラメーターは、1 GB の制限をオーバーライドし、バージョン チェックを回避します。 そのため、バージョンが移行先フォルダーのバージョンより後でない場合でも、ファイルをダウンロードできます。

このコマンドでは、 Save-Help コマンドレットを使用して、ヘルプ ファイルをダウンロードし、指定したフォルダーに保存します。 Force パラメーターは、Save-Help コマンドを毎日複数回実行する必要がある場合に必要です。

PSModuleInfo

モジュール オブジェクトをこのコマンドレットにパイプできます。

None

このコマンドレットは出力を返しません。

• $PSHOME\Modules フォルダーにモジュールのヘルプを保存するには、[管理者として実行] オプションを使用して PowerShell を起動します。 コンピューター上の Administrators グループのメンバーのみが、$PSHOME\Modules フォルダー内のモジュールのヘルプをダウンロードできます。
• 各モジュールの保存されたヘルプは、1 つのヘルプ情報 (HelpInfo XML) ファイルと、各 UI カルチャのヘルプ ファイル用の 1 つのキャビネット (.cab) ファイルで構成されます。 キャビネット ファイルからヘルプ ファイルを抽出する必要はありません。 Update-Help コマンドレットは、ヘルプ ファイルを抽出し、XML を検証してから、ヘルプ ファイルとヘルプ情報ファイルをモジュール フォルダーの言語固有のサブフォルダーにインストールします。
• Save-Help コマンドレットは、コンピューターにインストールされていないモジュールのヘルプを保存できます。 ただし、ヘルプ ファイルはモジュール フォルダーにインストールされるため、 Update-Help コマンドレットは、コンピューターにインストールされているモジュールに対してのみ、更新されたヘルプ ファイルをインストールできます。
• Save-Helpモジュールの更新されたヘルプ ファイルが見つからない場合、または指定した言語で更新されたヘルプ ファイルが見つからない場合は、エラー メッセージが表示されずにメッセージが表示されずに続行されます。 コマンドによって保存されたファイルを確認するには、 Verbose パラメーターを指定します。
• モジュールは、更新可能なヘルプの最小単位です。 特定のコマンドレットのヘルプを保存することはできません。モジュール内のすべてのコマンドレットに対してのみ保存できます。 特定のコマンドレットを含むモジュールを検索するには、 ModuleName プロパティを Get-Command コマンドレットと共に使用します(例: (Get-Command \<cmdlet-name\>).ModuleName
• Save-Help では、すべてのモジュールとコア PowerShell スナップインがサポートされます。他のスナップインはサポートされていません。
• Update-Help および Save-Help コマンドレットは、ヘルプ ファイルをダウンロードするために次のポートを使用します。HTTP の場合はポート 80、HTTPS の場合はポート 443 です。
• Update-Help コマンドレットと Save-Help コマンドレットは、Windows プレインストール環境 (Windows PE) ではサポートされていません。