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>]

説明

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

Windows PowerShell 3.0 では、Save-Help はローカルコンピューターにインストールされているモジュールに対してのみ機能しました。 PowerShell リモート処理を使用してリモートコンピューターからモジュールをインポートしたり、リモートコンピューターから PSModuleInfo オブジェクトへの参照を取得したりすることは可能でしたが、 HelpInfoUri プロパティは保持されず、 Save-Help はリモートモジュールヘルプでは機能しません。

Windows PowerShell 4.0 では、HelpInfoUri プロパティは PowerShell リモート処理を介して保持されます。これにより、リモートコンピューターにインストールされているモジュールに対して Save-Help を機能できます。また、インターネットにアクセスできないコンピューターで Export-Clixml を実行し、インターネットにアクセスできるコンピューターにオブジェクトをインポートし、PSModuleInfo オブジェクトで Save-Help を実行して、PSModuleInfo オブジェクトをディスクまたはリムーバブルメディアに保存することもできます。保存されたヘルプは、USB ドライブなどのリムーバブル記憶域メディアを使用してリモートコンピューターに転送できます。このヘルプは、 Update-Help を実行してリモートコンピューターにインストールできます。このプロセスを使用すれば、どのようなネットワークアクセスも実行できないコンピューターにヘルプをインストールできます。

保存したヘルプファイルをインストールするには、Update-Help コマンドレットを実行します。 SourcePath パラメーターを追加して、ヘルプファイルを保存したフォルダーを指定します。

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

Save-Help コマンドレットは、移動先フォルダー内のヘルプファイルのバージョンを確認します。新しいヘルプファイルが使用可能な場合、このコマンドレットはインターネットから最新のヘルプファイルをダウンロードし、フォルダーに保存します。 Save-Help コマンドレットは、Update-Help コマンドレットと同様に機能しますが、キャビネットファイルからヘルプファイルを抽出してコンピューターにインストールする代わりに、ダウンロードしたキャビネット (.cab) ファイルを保存する点が異なります。

保存されたモジュール用ヘルプはそれぞれ、UI カルチャごとに、ヘルプ情報 (HelpInfo XML) ファイル 1 つと、ヘルプファイルのキャビネット (.cab) ファイル 1 つで構成されます。キャビネットファイルからヘルプファイルを抽出する必要はありません。 Update-Help コマンドレットは、ヘルプファイルを抽出し、XML の安全性を検証してから、モジュールフォルダーの言語固有のサブフォルダーにヘルプファイルとヘルプ情報ファイルをインストールします。

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

このコマンドレットは、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 モジュールまたは DHCP サーバーの役割をローカルコンピューターにインストールせずに、インターネットに接続されたクライアントコンピューターから DhcpServer モジュールのヘルプを保存する 3 つの異なる方法を示します。

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

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

例 6: モジュールのヘルプを複数の言語で保存する

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

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

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

例 7: ヘルプを毎日複数回保存する

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

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

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

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

パラメーター

-Credential

ユーザー資格情報を指定します。このコマンドレットは、 DestinationPath パラメーターで指定されたファイルシステムの場所にアクセスするアクセス許可を持つユーザーの資格情報を使用してコマンドを実行します。このパラメーターは、 DestinationPath または LiteralPath パラメーターがコマンドで使用されている場合にのみ有効です。

このパラメーターを使用すると、リモートコンピューターで DestinationPath パラメーターを使用する Save-Help コマンドを実行できます。明示的な資格情報を指定することで、リモートコンピューターでコマンドを実行し、アクセス拒否エラーが発生したり、CredSSP 認証を使用して資格情報を委任したりすることなく、3 台目のコンピューター上のファイル共有にアクセスできます。

Type:	PSCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DestinationPath

ヘルプファイルを保存するフォルダーのパスを指定します。ファイル名やファイル名拡張子を指定しないでください。

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

このコマンドレットが 1 日に 1 回の制限に従っていないことを示し、バージョンチェックをスキップし、1 GB の制限を超えるファイルをダウンロードします。

このパラメーターを指定しなかった場合、Save-Help コマンドは、モジュールごとに 24 時間に 1 回しか実行できません。また、ダウンロードはモジュールごとに最大 1 GB の圧縮されていないコンテンツに制限されます。モジュールのヘルプファイルは、コンピューター上にあるファイルよりも新しい場合にのみ、インストールされます。

1 日に 1 回の制限により、ヘルプファイルをホストするサーバーが保護され、 PowerShell プロファイルに Save-Help コマンドを追加することが実用的になります。

Force パラメーターを使用せずに複数の UI カルチャでモジュールのヘルプを保存するには、次のようなすべての UI カルチャを同じコマンドに含めます。Save-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FullyQualifiedModule

ModuleSpecification オブジェクトの形式で指定された名前を持つモジュールを指定します。これについては、MSDN ライブラリの ModuleSpecification Constructor (Hashtable) の「解説」セクションで説明されています。たとえば、 FullyQualifiedModule パラメーターは、@{ModuleName = "modulename" という形式で指定されたモジュール名を受け入れます。ModuleVersion = "version_number"} または @{ModuleName = "modulename";ModuleVersion = "version_number";Guid = "GUID"}。 ModuleName と ModuleVersion は必須ですが、Guid は省略可能です。

Module パラメーターと同じコマンドで FullyQualifiedModule パラメーターを指定することはできません。

Type:	ModuleSpecification[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-LiteralPath

コピー先フォルダーのパスを指定します。 DestinationPath パラメーターの値とは異なり、LiteralPath パラメーターの値は、型指定されたとおりに使用されます。ワイルドカードとして解釈される文字はありません。パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。単一引用符は、文字をエスケープシーケンスとして解釈しないように PowerShell に指示します。

Type:	String[]
Aliases:	PSPath
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Module

このコマンドレットがヘルプをダウンロードするモジュールを指定します。コンマ区切りリストまたは各行に 1 つのモジュール名を持つファイルに、1 つ以上のモジュール名または名前パッターを入力します。ワイルドカード文字を使用できます。 Get-Module コマンドレットからモジュールオブジェクトを Save-Help にパイプすることもできます。

既定では、Save-Help は、更新可能なヘルプをサポートし、PSModulePath 環境変数に設定された場所のローカルコンピューターにインストールされているすべてのモジュールのヘルプをダウンロードします。

コンピューターにインストールされていないモジュールのヘルプを保存するには、リモートコンピューターで Get-Module コマンドを実行します。その結果得られたモジュールオブジェクトを、パイプを使用して Save-Help コマンドレットに渡すか、Module パラメーターまたは InputObject パラメーターの値として送信します。

指定したモジュールがコンピューターにインストールされている場合は、モジュール名またはモジュールオブジェクトを入力できます。指定したモジュールがコンピューターにインストールされていない場合は、Get-Module コマンドレットによって返されたモジュールオブジェクトなど、モジュールオブジェクトを入力する必要があります。

Save-Help コマンドレットの Module パラメーターは、モジュールファイルまたはモジュールマニフェストファイルの完全なパスを受け入れません。 PSModulePath の場所にないモジュールのヘルプを保存するには、Save-Help コマンドを実行する前に、モジュールを現在のセッションにインポートします。

値 "*" (すべて) は、コンピューターにインストールされているすべてのモジュールのヘルプの更新を試みます。これには、更新可能なヘルプをサポートしていないモジュールが含まれます。この値は、更新可能なヘルプをサポートしていないモジュールがコマンドで検出されたときにエラーが発生する可能性があります。

Type:	PSModuleInfo[]
Aliases:	Name
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

-UICulture

このコマンドレットが更新されたヘルプファイルを取得する UI カルチャ値を指定します。 es-ES などの 1 つ以上の言語コード、カルチャオブジェクトを含む変数、またはカルチャオブジェクトを取得するコマンド (Get-Culture、Get-UICulture コマンドなど) を入力します。

ワイルドカード文字は使用できません。 "de" などの部分的な言語コードを指定しないでください。

既定では、 Save-Help は、Windows またはそのフォールバックカルチャ用に設定された UI カルチャ内のヘルプファイルを取得します。 UICulture パラメーターを指定すると、Save-Help は、フォールバックカルチャではなく、指定された UI カルチャについてのみヘルプを検索します。

Type:	CultureInfo[]
Position:	2
Default value:	Current UI culture
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseDefaultCredentials

このコマンドレットが、現在のユーザーの資格情報を使用して、Web ダウンロードを含むコマンドを実行することを示します。既定では、コマンドは明示的な資格情報がない状態で実行されます。

このパラメーターは、Web ダウンロードが、NTLM、Negotiate、または Kerberos ベース認証を使用する場合に限り有効です。

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

PSModuleInfo

Get-Module コマンドレットから Save-Help の Module パラメーターにモジュール オブジェクトをパイプ処理できます。

出力

None

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

メモ

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

次の方法で共有

Save-Help

構文

説明

例

例 1: DhcpServer モジュールのヘルプを保存する

例 2: DhcpServer モジュールのヘルプをインストールする

例 3: すべてのモジュールのヘルプを保存する

例 4: コンピューター上のモジュールのヘルプを保存する

例 5: 別のコンピューター上のモジュールのヘルプを保存する

例 6: モジュールのヘルプを複数の言語で保存する

例 7: ヘルプを毎日複数回保存する

パラメーター

-Credential

-DestinationPath

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-UICulture

-UseDefaultCredentials

入力

出力

メモ

その他のリソース

次の方法で共有

Save-Help

構文

説明

例

例 1: DhcpServer モジュールのヘルプを保存する

例 2: DhcpServer モジュールのヘルプをインストールする

例 3: すべてのモジュールのヘルプを保存する

例 4: コンピューター上のモジュールのヘルプを保存する

例 5: 別のコンピューター上のモジュールのヘルプを保存する

例 6: モジュールのヘルプを複数の言語で保存する

例 7: ヘルプを毎日複数回保存する

パラメーター

-Credential

-DestinationPath

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-UICulture

-UseDefaultCredentials

入力

出力

メモ

関連リンク

その他のリソース