フィードバック

about_Updatable_Help

  • [アーティクル]

簡単な説明

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

長い説明

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

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

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

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

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

PowerShell 3.0 にはヘルプファイルが付属していません。 更新可能なヘルプ機能を使用して、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 内のモジュールのヘルプを更新するには、コンピューターの Administrators グループのメンバーである必要があります。

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

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

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

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

ヘルプファイルをインストールおよび更新する方法

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

コマンドレットは Update-Help 、次のタスクを含む、すべてのハード機能を実行します。

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

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

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

Update-Help

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

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

Update-Help -Module ServerManager

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

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

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

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

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

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

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

Save-Help -DestinationPath \\Server\Share

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

Update-Help -SourcePath \\Server\Share

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

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

$m = Invoke-Command -ComputerName RemoteServer -ScriptBlock
{ Get-Module -Name DhcpServer -ListAvailable }
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 サーバーモジュールのヘルプをインストールします。

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

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

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

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

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

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

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

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

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

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

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

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

指定した言語でモジュールのヘルプファイルを使用できない場合、コマンドレットと Save-Help コマンドレットは Update-Help 、各モジュールのヘルプが使用可能な言語を示すエラーメッセージを返します。これにより、ニーズに最も合った代替手段を選択できます。

注意

現在、更新可能なヘルプコンテンツは英語 (en-us) でのみ公開されています。 一部の非 Windows システムでは、 UICulture パラメーターを使用して、 en-US コンテンツを明示的に要求する必要があります。

オンライン ヘルプを使用する方法

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

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

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

Get-Help Get-Job -Online

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

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

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

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

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

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

注意

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

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

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

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

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

コマンドレット と コマンドレット の Module パラメーター Update-Help Save-Help は、モジュール名のみを受け取ります。 モジュール ファイルへのパスを受け入れ "ない"。

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

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

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

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

注釈

および Update-Help コマンドレットSave-Helpは、Pe (Windows Preinstallation Environment) ではWindowsされていません。

関連項目