about_Updatable_Help

  • [アーティクル]

簡単な説明

PowerShell の更新可能なヘルプ システムについて説明します。

詳細な説明

PowerShell には、PowerShell コマンドレットと概念に関する最新のヘルプ トピックにアクセスするためのさまざまな方法が用意されています。

PowerShell 3.0 で導入された更新可能なヘルプ システムは、コマンド ラインで読むことができるように、ローカル コンピューターに常に最新のヘルプ トピックがあることを保証するように設計されています。 これにより、ヘルプ ファイルをダウンロードしてインストールしたり、新しいヘルプ ファイルが利用可能になったときにいつでも更新したりできます。

企業内の複数のコンピューターとインターネットにアクセスできないコンピューターに対して更新されたヘルプを提供するために、更新可能なヘルプを使用すると、ヘルプ ファイルをファイル システム ディレクトリまたはファイル共有にダウンロードし、ファイル共有からヘルプ ファイルをインストールできます。

PowerShell 4.0 では、 HelpInfoUri プロパティは Windows PowerShell リモート処理経由で保持されます。これにより、 Save-Help リモート コンピューターにインストールされているが、必ずしもローカル コンピューターにインストールされていないモジュールに対して機能できます。 インターネットにアクセスできないコンピューターで実行し、インターネットにアクセスできるコンピューターに PSModuleInfo オブジェクトをインポートしてから、PSModuleInfo オブジェクトで実行Save-HelpExport-Clixmlすることで、PSModuleInfo オブジェクトをディスクまたはリムーバブル メディア (USB ドライブなど) に保存できます。 保存されたヘルプは、リムーバブル メディアを使用してリモートの切断されたコンピューターにコピーし、次に実行 Update-Helpしてインストールできます。 これらの機能の Save-Help 改善により、ネットワーク アクセスのないコンピューターにヘルプをインストールできます。 新しいSave-Help機能を使用する方法の例については、このトピックの「ファイル共有からヘルプを更新する方法」を参照してください。

更新可能なヘルプは、コンピューターにヘルプ ファイルがない場合でも、最新のヘルプ トピックとコマンドレットの基本的なヘルプへのオンライン アクセスもサポートします。

PowerShell にはヘルプ ファイルは付属していません。 更新可能なヘルプ機能を使用すると、PowerShell とすべての Windows モジュールに既定で含まれるすべてのコマンドのヘルプ ファイルをインストールできます。

更新可能なヘルプ コマンドレット

  • Update-Help: 最新のヘルプ ファイルをインターネットまたはファイル共有からダウンロードし、ローカル コンピューターにインストールします。

  • Save-Help: インターネットから最新のヘルプ ファイルをダウンロードし、ファイル システム ディレクトリまたはファイル共有に保存します。 ヘルプ ファイルをコンピューターにインストールするには、Update-Help

  • Get-Help: コマンド ラインにヘルプ トピックを表示します。 コンピューター上のヘルプ ファイルからヘルプを取得します。 ヘルプ ファイルがないコマンドレットと関数の自動生成されたヘルプを表示します。 既定のインターネット ブラウザーで、コマンドレット、関数、スクリプト、ワークフローのオンライン ヘルプ トピックを開きます。

自動生成されたヘルプ: ヘルプ ファイルのないヘルプ

コンピューターにコマンドレット、関数、またはワークフローのヘルプ ファイルがない場合、コマンドレットは自動生成されたヘルプを表示し、 Get-Help ヘルプ ファイルをダウンロードするかオンラインで読み取るように求められます。

自動生成されたヘルプには、構文とエイリアス、および更新可能なヘルプ コマンドレットの使用方法とオンライン ヘルプ トピックへのアクセス方法を説明する解説が含まれています。

たとえば、次のコマンドは、コマンドレットの基本的なヘルプを Get-Culture 取得します。 出力には、コンピューターに Get-Help ヘルプ ファイルがない場合の表示が表示されます。

Get-Help Get-Culture

NAME
    Get-Culture

SYNTAX
    Get-Culture [<CommonParameters>]

ALIASES
    None

REMARKS
    To get the latest Help content including descriptions and examples
    type: Update-Help.

モジュールのヘルプ ファイル

更新可能なヘルプの最小単位は、モジュールのヘルプです。 モジュール ヘルプには、モジュール内のすべてのコマンドレット、関数、ワークフロー、プロバイダー、スクリプト、および概念に関するヘルプが含まれています。 現在のセッションにインポートされていない場合でも、コンピューターにインストールされているすべてのモジュールのヘルプを更新できます。

モジュール全体のヘルプを更新できますが、個々のコマンドレットのヘルプを更新することはできません。

特定のコマンドレットを含むモジュールを検索するには、次のコマンド形式を使用します。

(Get-Command <cmdlet-name>).ModuleName

たとえば、コマンドレットを含むモジュールを検索するには、次のように Set-ExecutionPolicy 入力します。

(Get-Command Set-ExecutionPolicy).ModuleName

特定のモジュールのヘルプを更新するには、次のように入力します。

Update-Help -Module <ModuleName>

たとえば、Set-ExecutionPolicy コマンドレットを含むモジュールのヘルプを更新するには、次のように入力します。

Update-Help -Module Microsoft.PowerShell.Security

更新可能なヘルプのアクセス許可

ディレクトリ$pshome/Modules内のモジュールのヘルプを更新するには、コンピューター上の 管理istrators グループのメンバーである必要があります。

管理istrators グループのメンバーでない場合は、これらのモジュールのヘルプを更新できません。ただし、インターネットにアクセスできる場合は、オンラインでヘルプを表示できます。

ディレクトリ内のモジュールまたはディレクトリ $HOME/Documents/PowerShell/Modules の他のサブディレクトリにあるモジュールのヘルプを $HOME 更新する場合、特別なアクセス許可は必要ありません。

Update-HelpおよびSave-Helpコマンドレットには、現在のユーザーの明示的な資格情報を提供する UseDefaultCredentials パラメーターがあります。 このパラメーターは、セキュリティで保護されたインターネットの場所にアクセスするために設計されています。

またUpdate-Help、コマンドレットにはSave-Help、リモート コンピューターでコマンドを実行し、3 番目のコンピューター上のファイル共有にアクセスできる Credential パラメーターもあります。 Credential パラメーターは、SourcePath パラメーターまたは LiteralPath パラメーターと DestinationPath パラメーターまたは LiteralPath パラメーター Update-HelpSave-Helpを使用する場合にのみ有効です。

ヘルプ ファイルをインストールして更新する方法

ヘルプ ファイルを初めてダウンロードしてインストールしたり、コンピューター上のヘルプ ファイルを更新したりするには、コマンドレットを Update-Help 使用します。

コマンドレットは Update-Help 、次のタスクを含め、すべての作業を行います。

  • 更新可能なヘルプをサポートするモジュールを決定します。
  • 各モジュールが更新可能なヘルプ ファイルを格納するインターネット上の場所を検索します。
  • コンピューター上の各モジュールのヘルプ ファイルと、各モジュールで使用できる最新のヘルプ ファイルを比較します。
  • インターネットから新しいファイルをダウンロードします。
  • ヘルプ ファイル パッケージのラップを解除します。
  • ファイルが有効なヘルプ ファイルであることを確認します。
  • モジュール ディレクトリの言語固有のサブディレクトリにヘルプ ファイルをインストールします。

新しいヘルプ トピックにアクセスするには、コマンドレットを Get-Help 使用します。 PowerShell を再起動する必要はありません。

更新可能なヘルプをサポートするコンピューター上のすべてのモジュールのヘルプをインストールまたは更新するには、次のように入力します。

Update-Help

特定のモジュールのヘルプを更新するには、Module パラメーターUpdate-Helpを追加します。 モジュール名には、ワイルドカード文字を使用できます。

たとえば、ServerManager モジュールのヘルプを更新するには、次のように入力します。

Update-Help -Module ServerManager

パラメーターを指定しない場合、 Update-Help 更新プログラムはセッション内のすべてのモジュールと、更新可能なヘルプをサポートするすべてのインストール済みモジュールに対してヘルプを提供します。 モジュールを含めるためには、PSModulePath 環境変数の値にリストされているディレクトリにモジュールをインストールする必要があります。 これらは、コマンドによって Get-Module -ListAvailable 返されるモジュールでもあります。

Module パラメーターの値が (すべて) のUpdate-Help場合は*、更新可能なヘルプをサポートしていないモジュールを含め、インストールされているすべてのモジュールのヘルプの更新を試みます。 このコマンドは、通常、コマンドレットが更新可能なヘルプをサポートしていないモジュールを検出すると、多くのエラーを生成します。

ファイル共有からヘルプを更新する方法

インターネットに接続されていないコンピューターをサポートしたり、企業でのヘルプの更新を制御または合理化したりするには、コマンドレットを Save-Help 使用します。 このコマンドレットは Save-Help 、インターネットからヘルプ ファイルをダウンロードし、指定したファイル システム ディレクトリに保存します。

Save-Help は、指定されたディレクトリ内のヘルプ ファイルを、各モジュールで使用できる最新のヘルプ ファイルと比較します。 ディレクトリにヘルプ ファイルがない場合、またはモジュールで使用できる新しいヘルプ ファイルがある場合、 Save-Help コマンドレットは新しいファイルをインターネットからダウンロードします。 ただし、ヘルプ ファイルのラップを解除したり、インストールしたりすることはありません。

ファイル システム ディレクトリに保存されたヘルプ ファイルからコンピューターにヘルプ ファイルをインストールまたは更新するには、コマンドレットの SourcePath パラメーターを Update-Help 使用します。 このコマンドレットは Update-Help 、最新のヘルプ ファイルを識別し、ラップを解除して検証し、モジュール ディレクトリの言語固有のサブディレクトリにインストールします。

たとえば、インストールされているすべてのモジュールのヘルプをディレクトリに保存するには、次のように \\Server\Share 入力します。

Save-Help -DestinationPath \\Server\Share

次に、ディレクトリからヘルプを更新するには、次のように \\Server\Share 入力します。

Update-Help -SourcePath \\Server\Share

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

オプション 1: Invoke-Command リモート モジュールの PSModuleInfo オブジェクトを取得し、変数に保存し、$mモジュール名として変数$mを指定して PSModuleInfo オブジェクトで実行Save-Helpします。

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

オプション 2: DHCP サーバー モジュールを実行しているコンピューターを対象とする PSSession を開き、モジュールの PSModuleInfo オブジェクトを取得し、変数に保存して、変数$mに保存されているオブジェクトで$m実行Save-Helpします。

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

オプション 3: DHCP サーバー モジュールを実行しているコンピューターを対象とする CIM セッションを開き、モジュールの PSModuleInfo オブジェクトを取得し、変数に保存してから、変数$mに保存されているオブジェクトで$m実行Save-Helpします。

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

次の例では、管理者は、ネットワーク アクセス権のないコンピューターに DHCP サーバー モジュールのヘルプをインストールします。

まず、PSModuleInfo オブジェクトを共有フォルダーまたはリムーバブル メディアにエクスポートするために実行Export-Clixmlします。

$m = Get-Module -Name DhcpServer -ListAvailable
Export-Clixml -Path E:\UsbDrive\DhcpModule.xml -InputObject $m

次に、リムーバブル メディアをインターネットにアクセスできるコンピューターに転送し、PSModuleInfo オブジェクトImport-Clixmlをインポートします。 インポートされた DhcpServer モジュール PSModuleInfo オブジェクトのヘルプを保存するために実行Save-Helpします。

$deserialized_m = Import-Clixml E:\UsbDrive\DhcpModule.xml
Save-Help -Module $deserialized_m -DestinationPath E:\UsbDrive\SavedHelp

最後に、ネットワーク アクセス権のないコンピューターにリムーバブル メディアを転送し、次に実行 Update-Helpしてヘルプをインストールします。

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

パラメーターを指定しない場合は、 Save-Help セッション内のすべてのモジュールと、更新可能なヘルプをサポートするすべてのインストール済みモジュールのヘルプをダウンロードします。 モジュールを含めるためには、環境変数の値 $env:PSModulePath に一覧表示されているディレクトリ、ローカル コンピューター、またはヘルプを保存するリモート コンピューターにモジュールをインストールする必要があります。 これらは、コマンドを実行 Get-Help -ListAvailable して返されるモジュールでもあります。

さまざまな言語でヘルプ ファイルを更新する方法

既定では、コマンドレットとSave-HelpコマンドレットはUpdate-Help、ローカル コンピューター上の Windows 用に設定されている UI カルチャと言語でヘルプをダウンロードします。 指定したモジュールのヘルプ ファイルがローカル UI カルチャで使用できない場合は、 Update-HelpSave-Help Windows 言語フォールバック ルールを使用して、サポートされている最適な言語を見つけます。

ただし、UICulture パラメーターとSave-HelpコマンドレットをUpdate-Help使用して、ヘルプ ファイルを使用できる任意の UI カルチャにヘルプ ファイルをダウンロードしてインストールできます。

たとえば、セッション上のすべてのモジュールの最新のヘルプ ファイルを日本語 (ja-Jp) とフランス語 (fr-FR) で保存するには、次のように入力します。

Save-Help -Path \Server\Share -UICulture ja-jp, fr-fr

指定した言語でモジュールのヘルプ ファイルを使用できない場合、 Update-Help 各 Save-Help モジュールのヘルプが使用可能な言語を示すエラー メッセージが返されるので、ニーズに最適な代替手段を選択できます。

Note

現在、更新可能なヘルプ コンテンツは英語 (en-US) でのみ公開されています。

オンライン ヘルプの使用方法

ローカル コンピューター上のヘルプ ファイルを更新できない場合、または更新しない場合でも、最新のヘルプ ファイルをオンラインで入手できます。

コマンドレットまたは関数のオンライン ヘルプ トピックを開くには、コマンドレットの Online パラメーターを Get-Help 使用します。

たとえば、次のコマンドは、既定のインターネット ブラウザーでコマンドレットの Get-Job オンライン ヘルプ トピックを開きます。

Get-Help Get-Job -Online

スクリプトのオンライン ヘルプを取得するには、Online パラメーターとスクリプトの完全なパスを使用します。

Online パラメーターは About トピックでは機能しません。 PowerShell 言語に関するヘルプ トピックなど、PowerShell のトピックについては、「PowerShell のトピックについて」を参照してください。

インターネットのダウンロードを最小限に抑える方法または防止する方法

インターネットのダウンロードを最小限に抑え、インターネットに接続していないユーザーに更新可能なヘルプを提供するには、コマンドレットを Save-Help 使用します。 インターネットからヘルプをダウンロードし、ネットワーク共有に保存します。 次に、すべてのコンピューターでコマンドを実行 Update-Help するグループ ポリシー設定またはスケジュールされたジョブを作成します。 コマンドレットの SourcePath パラメーターの値をUpdate-Helpネットワーク共有に設定します。

インターネットにアクセスできるユーザーがインターネットから更新可能なヘルプをダウンロードできないようにするには、[Update-Help グループ ポリシーの既定のソース パスを設定する] 設定を使用します。

このグループ ポリシー設定は、影響を受けるすべてのコンピューター上のすべてのUpdate-Helpコマンドに、指定したファイル システムの場所を持つ SourcePath パラメーターを暗黙的に追加します。 ユーザーは SourcePath パラメーターを明示的に使用して別のファイル システムの場所を指定できますが、SourcePath パラメーターを除外してインターネットからヘルプをダウンロードすることはできません。

Note

[Update-Help グループ ポリシーの既定のソース パスを設定する] ポリシー設定は、[コンピューターの構成] と [ユーザーの構成] の下に表示されます。 ただし、[コンピューターの構成] の下のポリシー設定のみが有効です。 [ユーザー構成] のポリシー設定は無視されます。

詳細については、「about_Group_Policy_Settings」をご覧ください。

標準以外のモジュールのヘルプを更新する方法

コマンドレットの ListAvailable パラメーターによって返されないモジュールのヘルプを更新または保存するには、またはSave-Helpコマンドを実行する前に、モジュールをUpdate-Help現在のセッションにインポートGet-Moduleします。 リモート コンピューターで、コマンドを実行する Save-Help 前に、リモート コンピューターに接続されている現在のセッションまたは Invoke-Command スクリプト ブロックにモジュールをインポートします。

モジュールが現在のセッションにある場合は、パラメーターを指定せずにコマンドレットをUpdate-HelpSave-Help実行するか、Module パラメーターを使用してモジュール名を指定します。

およびコマンドレットの Update-HelpSave-Help Module パラメーターは、モジュール名のみを受け入れます。 モジュール ファイルへのパスは受け入れられません。

この手法を使用して、コマンドレットの ListAvailable パラメーターGet-Moduleによって返されないモジュール (環境変数にリスト$env:PSModulePathされていない場所にインストールされているモジュール、適切な形式ではないモジュールなど) のヘルプを更新または保存します (モジュール ディレクトリには、基本名がディレクトリ名と同じファイルが少なくとも 1 つ含まれていません)。

更新可能なヘルプをサポートする方法

モジュールを作成する場合は、モジュールのオンライン ヘルプと更新可能なヘルプをサポートできます。 詳細については、「更新可能なヘルプのサポートとオンライン ヘルプのサポート」を参照してください。

更新可能なヘルプは、PowerShell スナップインまたはコメント ベースのヘルプでは使用できません。

解説

Windows プレインストール環境 (Windows PE) では、コマンドレットとSave-HelpコマンドレットはUpdate-Helpサポートされていません。

関連項目