Update-Help

構文

Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [[-SourcePath] <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [-LiteralPath <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Update-Help コマンドレットは、PowerShell モジュールの最新のヘルプ ファイルをダウンロードし、コンピューターにインストールします。 変更を有効にするために PowerShell を再起動する必要はありません。 Get-Help コマンドレットを使用すると、新しいヘルプ ファイルをすぐに表示できます。

Update-Help は、コンピューター上のヘルプ ファイルのバージョンを確認します。 モジュールのヘルプ ファイルがない場合、またはヘルプ ファイルが古い場合は、 Update-Help は最新のヘルプ ファイルをダウンロードします。 ヘルプ ファイルは、インターネットまたはファイル共有からダウンロードしてインストールできます。

パラメーターがない場合、 Update-Help 更新可能なヘルプをサポートするモジュールのヘルプ ファイルが更新され、セッションに読み込まれるか、 $env:PSModulePathに含まれる場所にインストールされます。 詳しくは、「about_Updatable_Help」をご覧ください。

Update-Help は、インストールされているヘルプのバージョンを確認します。 モジュール Update-Help 更新されたヘルプ ファイルが見つからない場合は、エラー メッセージが表示されずにサイレント状態で続行されます。 バージョン チェックをスキップするには、 Force パラメーターを使用します。 状態と進行状況の詳細を表示するには、 Verbose パラメーターを使用します。 特定のモジュールのヘルプ ファイルを更新するには、 Module パラメーターを使用します。

オペレーティング システムのカルチャ設定が、更新可能なヘルプに使用できない言語用に構成されている場合、 Update-Help はヘルプをダウンロードせずにサイレントに続行されます。 サポートされている言語でヘルプ ファイルをダウンロードするには、 UICulture パラメーターを使用します。 ヘルプは常に en-US ロケールで使用できます。

インターネットに接続されていないコンピューターで Update-Help を使用することもできます。 まず、 Save-Helpcmdlet を使用して、インターネットからヘルプ ファイルをダウンロードし、インターネットに接続されていないシステムからアクセスできる共有フォルダーに保存します。 次に、Update-Helpの SourcePath パラメーターを使用して、更新されたヘルプ ファイルを共有からダウンロードし、コンピューターにインストールします。

Update-Help コマンドレットは、Windows PowerShell 3.0 で導入されました。

例

例 1: すべてのモジュールのヘルプ ファイルを更新する

Update-Help コマンドレットは、更新可能なヘルプをサポートするインストール済みモジュールのヘルプ ファイルを更新します。 ユーザー インターフェイス (UI) カルチャ言語は、オペレーティング システムで設定されます。

Update-Help

例 2: 指定したモジュールのヘルプ ファイルを更新する

Update-Help コマンドレットは、Microsoft.PowerShell で始まるモジュール名についてのみヘルプ ファイルを更新します。

Update-Help -Module Microsoft.PowerShell*

例 3: en-US ロケールに設定されていないシステムでのヘルプの更新

Update-Help コマンドレットは、複数の言語でヘルプをダウンロードするように設計されています。 ただし、システムで使用する言語にヘルプがない場合は、UICulture パラメーターを使用しない限り、Update-Helpは警告なしに失敗します。

この例では、 Update-Help は、 en-GB ロケールに設定されたシステムで実行されています。

Update-Help Microsoft.PowerShell.Utility -Force
Update-Help Microsoft.PowerShell.Utility -Force -UICulture en-GB

Update-Help : Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility'
with UI culture(s) {en-GB} : The specified culture is not supported: en-GB. Specify a
culture from the following list: {en-US}.
At line:1 char:1
+ Update-Help Microsoft.PowerShell.Utility -Force -UICulture en-GB
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [Update-Help], Exception
    + FullyQualifiedErrorId : HelpCultureNotSupported,Microsoft.PowerShell.Commands
   .UpdateHelpCommand

ヘルプ ファイルは常に、 en-US ロケールに対して発行されます。 英語のヘルプをダウンロードするには、UICulture パラメーターでUpdate-Helpを実行し、en-USロケールを指定します。

例 4: ヘルプ ファイルを自動的に更新する

この例では、毎日午前 3 時に、すべてのモジュールのヘルプを更新するスケジュールされたジョブを作成します。

$jobParams = @{
  Name = 'UpdateHelpJob'
  Credential = 'Domain01\User01'
  ScriptBlock = '{Update-Help}'
  Trigger = (New-JobTrigger -Daily -At "3 AM")
}
Register-ScheduledJob @jobParams

Id         Name            JobTriggers     Command                                  Enabled
--         ----            -----------     -------                                  -------
1          UpdateHelpJob   1               Update-Help                              True

Register-ScheduledJob コマンドレットは、Update-Help コマンドを実行するスケジュールされたジョブを作成します。 このコマンドでは、 Credential パラメーターを使用して、コンピューター上の Administrators グループのメンバーの資格情報を使用して Update-Help を実行します。 Trigger パラメーターの値は、毎日午前 3 時にジョブを開始するジョブ トリガーを作成するNew-JobTrigger コマンドです。

Register-ScheduledJob コマンドを実行するには、管理者として実行 オプションを使用して PowerShell を起動します。 PowerShell では、 Credential パラメーターで指定されたユーザーのパスワードの入力を求められます。 資格情報は、スケジュールされたジョブと共に格納されます。 ジョブの実行時にプロンプトは表示されません。

Get-ScheduledJob コマンドレットを使用して、スケジュールされたジョブを表示し、Set-ScheduledJob コマンドレットを使用して変更し、Unregister-ScheduledJob コマンドレットを使用して削除できます。 次のパスで、タスク スケジューラでスケジュールされたジョブを表示および管理することもできます。

Task Scheduler Library\Microsoft\Windows\PowerShell\ScheduledJobs.

例 5: ファイル共有から複数のコンピューター上のヘルプ ファイルを更新する

この例では、更新されたヘルプ ファイルがインターネットからダウンロードされ、ファイル共有に保存されます。 ファイル共有にアクセスして更新プログラムをインストールするためのアクセス許可を持つユーザー資格情報が必要です。 ファイル共有を使用すると、ファイアウォールの内側にあるコンピューターやインターネットに接続されていないコンピューターを更新できます。

Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
     Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}

Save-Help コマンドは、更新可能なヘルプをサポートするすべてのモジュールの最新のヘルプ ファイルをダウンロードします。 DestinationPath パラメーターは、ファイルを\\Server01\Share\PSHelpファイル共有に保存します。 Credential パラメーターは、ファイル共有にアクセスする権限を持つユーザーを指定します。

Invoke-Command コマンドレットは、複数のコンピューターでリモート Update-Help コマンドを実行します。 ComputerName パラメーターは、Servers.txt ファイルからリモート コンピューターの一覧を取得します。 ScriptBlock パラメーターは、Update-Help コマンドを実行し、SourcePath パラメーターを使用して、更新されたヘルプ ファイルを含むファイル共有を指定します。 Credential パラメーターは、ファイル共有にアクセスしてリモート Update-Help コマンドを実行できるユーザーを指定します。

例 6: 更新されたヘルプ ファイルの一覧を取得する

Update-Help コマンドレットは、指定したモジュールのヘルプを更新します。 コマンドレットは、 Verbose 共通パラメーターを使用して、更新されたヘルプ ファイルの一覧を表示します。 Verbose を使用すると、特定のモジュールのすべてのヘルプ ファイルまたはヘルプ ファイルの出力を表示できます。

Verbose パラメーターがないと、Update-Helpはコマンドの結果を表示しません。 Verbose パラメーターの出力は、ヘルプ ファイルが更新されたか、最新バージョンがインストールされているかどうかを確認するのに役立ちます。

Update-Help -Module Microsoft.PowerShell.Utility -Verbose

例 7: 更新可能なヘルプをサポートするモジュールを検索する

この例では、更新可能なヘルプをサポートするモジュールの一覧を示します。 このコマンドは、モジュールの HelpInfoUri プロパティを使用して、更新可能なヘルプをサポートするモジュールを識別します。 HelpInfoUri プロパティには、Update-Help コマンドレットの実行時にリダイレクトされる URL が含まれています。

Get-Module -ListAvailable | Where-Object -Property HelpInfoUri

Directory: C:\program files\powershell\6\Modules

ModuleType Version    Name                                PSEdition ExportedCommands
---------- -------    ----                                --------- ----------------
Manifest   6.1.0.0    CimCmdlets                          Core      {Get-CimAssociatedInstance... }
Manifest   1.2.2.0    Microsoft.PowerShell.Archive        Desk      {Compress-Archive... }
Manifest   6.1.0.0    Microsoft.PowerShell.Diagnostics    Core      {Get-WinEvent, New-WinEvent}

    Directory: C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules

ModuleType Version    Name                                PSEdition ExportedCommands
---------- -------    ----                                --------- ----------------
Manifest   2.0.1.0    Appx                                Core,Desk {Add-AppxPackage, ... }
Script     1.0.0.0    AssignedAccess                      Core,Desk {Clear-AssignedAccess, ... }
Manifest   1.0.0.0    BitLocker                           Core,Desk {Unlock-BitLocker, ... }

例 8: 更新されたヘルプ ファイルのインベントリ

この例では、スクリプト Get-UpdateHelpVersion.ps1 は、各モジュールとそのバージョン番号の更新可能なヘルプ ファイルのインベントリを作成します。

スクリプトは、モジュールの HelpInfoUri プロパティを使用して、更新可能なヘルプをサポートするモジュールを識別します。 更新可能なヘルプをサポートするモジュールの場合、スクリプトはヘルプ情報ファイル (*helpinfo.xml) を検索して解析し、最新バージョン番号を検索します。

このスクリプトでは、 PSCustomObject クラスとハッシュ テーブルを使用して、カスタム出力オブジェクトを作成します。

# Get-UpdateHelpVersion.ps1
Param(
    [parameter(Mandatory=$False)]
    [String[]]
    $Module
)
$HelpInfoNamespace = @{helpInfo='http://schemas.microsoft.com/powershell/help/2010/05'}

if ($Module) { $Modules = Get-Module $Module -ListAvailable | where {$_.HelpInfoUri} }
else { $Modules = Get-Module -ListAvailable | where {$_.HelpInfoUri} }

foreach ($mModule in $Modules)
{
    $mDir = $mModule.ModuleBase

    if (Test-Path $mdir\*helpinfo.xml)
    {
        $mName=$mModule.Name
        $mNodes = dir $mdir\*helpinfo.xml -ErrorAction SilentlyContinue |
            Select-Xml -Namespace $HelpInfoNamespace -XPath "//helpInfo:UICulture"
        foreach ($mNode in $mNodes)
        {
            $mCulture=$mNode.Node.UICultureName
            $mVer=$mNode.Node.UICultureVersion

            [PSCustomObject]@{"ModuleName"=$mName; "Culture"=$mCulture; "Version"=$mVer}
        }
    }
}

ModuleName                              Culture                                 Version
----------                              -------                                 -------
ActiveDirectory                         en-US                                   3.0.0.0
ADCSAdministration                      en-US                                   3.0.0.0
ADCSDeployment                          en-US                                   3.0.0.0
ADDSDeployment                          en-US                                   3.0.0.0
ADFS                                    en-US                                   3.0.0.0

パラメーター

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

入力

DirectoryInfo

このコマンドレットには、ディレクトリ パス オブジェクトをパイプ処理できます。

PSModuleInfo

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

出力

None

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

メモ

PowerShell でインストールされているコマンド、または $PSHOME\Modules ディレクトリ内の任意のモジュールを含む主要な PowerShell モジュールのヘルプを更新するには、管理者として実行 オプションを使用して PowerShell を起動。

コンピューター上の Administrators グループのメンバーのみが、コア PowerShell モジュール、PowerShell と共にインストールされるコマンド、および $PSHOME\Modules フォルダー内のモジュールのヘルプを更新できます。 ヘルプ ファイルを更新するアクセス許可がない場合は、ヘルプ ファイルをオンラインで読み取ることができます。 たとえば、Get-Help Update-Help -Online のようにします。

モジュールは、更新可能なヘルプの最小単位です。 特定のコマンドレットのヘルプを更新することはできません。 特定のコマンドレットを含むモジュールを検索するには、Get-Command コマンドレットの ModuleName プロパティ (たとえば、(Get-Command Update-Help).ModuleName) を使用します。

ヘルプ ファイルはモジュール ディレクトリにインストールされるため、 Update-Help コマンドレットは、コンピューターにインストールされているモジュールに対してのみ、更新されたヘルプ ファイルをインストールできます。 ただし、 Save-Help コマンドレットは、コンピューターにインストールされていないモジュールのヘルプを保存できます。

Update-Help コマンドレットは、Windows PowerShell 3.0 で導入されました。 以前のバージョンの PowerShell では機能しません。 Windows PowerShell 2.0 と Windows PowerShell 3.0 の両方を持つコンピューターでは、Windows PowerShell 3.0 セッションで Update-Help コマンドレットを使用してヘルプ ファイルをダウンロードおよび更新します。 ヘルプ ファイルは、Windows PowerShell 2.0 と Windows PowerShell 3.0 の両方で使用できます。

Update-HelpコマンドレットとSave-Help コマンドレットは、ヘルプ ファイルをダウンロードするために次のポートを使用します。HTTP の場合はポート 80、HTTPS の場合はポート 443 です。

Update-Help では、すべてのモジュールとコア PowerShell スナップインがサポートされます。他のスナップインはサポートされていません。

$env:PSModulePath環境変数にリストされていない場所にあるモジュールのヘルプを更新するには、モジュールを現在のセッションにインポートしてから、Update-Help コマンドを実行します。 パラメーターを指定せずに Update-Help を実行するか、 Module パラメーターを使用してモジュール名を指定します。 Update-HelpおよびSave-Help コマンドレットの Module パラメーターは、モジュール ファイルまたはモジュール マニフェスト ファイルの完全なパスを受け入れられません。

モジュールはすべて、更新可能なヘルプをサポートできます。 作成するモジュールで更新可能なヘルプをサポートする手順については、「 更新可能なヘルプのサポートを参照してください。

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

関連リンク

• Get-Culture
• Get-Help
• Get-Module
• Get-UICulture
• Start-Job
• Save-Help