Save-Help

モジュール:: Microsoft.PowerShell.Core Module

最新のヘルプファイルをファイルシステムディレクトリにダウンロードして保存します。

構文

Path (既定)

Save-Help
    [-DestinationPath] <String[]>
    [[-Module] <PSModuleInfo[]>]
    [[-UICulture] <CultureInfo[]>]
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [-Scope <UpdateHelpScope>]
    [<CommonParameters>]

LiteralPath

Save-Help
    [[-Module] <PSModuleInfo[]>]
    [[-UICulture] <CultureInfo[]>]
    -LiteralPath <String[]>
    [-FullyQualifiedModule <ModuleSpecification[]>]
    [-Credential <PSCredential>]
    [-UseDefaultCredentials]
    [-Force]
    [-Scope <UpdateHelpScope>]
    [<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 オブジェクトで Save-Help を実行することで、PSModuleInfo オブジェクトをディスクまたはリムーバブルメディアに保存することもできます。保存したヘルプは、USB ドライブなどのリムーバブル記憶媒体を使用して、リモートコンピュータに転送できます。ヘルプは、 Update-Helpを実行することでリモートコンピュータにインストールできます。このプロセスは、ネットワークにアクセスできないコンピューターにヘルプをインストールするために使用できます。

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

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

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

各モジュールの保存されたヘルプは、1 つのヘルプ情報 (HelpInfo XML) ファイルと、各 UI カルチャのヘルプファイル用の 1 つのキャビネット (.cab) ファイルで構成されます。キャビネット・ファイルからヘルプ・ファイルを抽出する必要はありません。 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 モジュールまたは 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"

この例では、例 1 で DhcpServer モジュール用に保存したヘルプを、インターネットにアクセスできないコンピュータにインストールする方法を示します。

例 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 モジュールのモジュールオブジェクトを取得し、モジュールオブジェクトを Invoke-Command コマンドレットにパイプする Save-Help コマンドが含まれます。

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

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

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

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

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

例 7: 1 日に 1 回以上ヘルプを保存する

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

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

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

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

パラメーター

-Credential

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

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

User01 や Domain01\User01などのユーザー名を入力するか、コマンドレットによって生成された Get-Credential オブジェクトを入力します。ユーザー名を入力すると、パスワードの入力を求められます。

資格情報は PSCredential オブジェクトに格納され、パスワードは SecureStringとして格納されます。

注

SecureString データ保護についての詳細は、「SecureString はどのくらい安全ですか？」を参照してください。.

パラメーターのプロパティ

型:	PSCredential
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-DestinationPath

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

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	経路

パラメーターセット

Path

配置:	0
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Force

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

このパラメータを使用しないと、各モジュールに対して 24 時間ごとに 1 つの Save-Help コマンドのみが許可され、ダウンロードはモジュールごとに 1 GB の非圧縮コンテンツに制限され、モジュールのヘルプファイルは、コンピュータ上のファイルよりも新しい場合にのみインストールされます。

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

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	False
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-FullyQualifiedModule

値には、モジュール名、完全なモジュール仕様、またはモジュールファイルへのパスを指定できます。

値がパスの場合、パスは完全修飾または相対パスにすることができます。相対パスは、using ステートメントを含むスクリプトを基準にして解決されます。

値が名前またはモジュールの指定である場合、PowerShell は指定されたモジュールの PSModulePath を検索します。

モジュール仕様は、次のキーを持つハッシュテーブルです。

ModuleName - 必須モジュール名を指定します。
GUID - 省略可能 モジュールの GUID を指定します。
また、以下の 3 つのキーのうち少なくとも 1 つを指定する必要も
。
- ModuleVersion - モジュールの最小許容バージョンを指定します。
- MaximumVersion - モジュールの許容される最大バージョンを指定します。
- RequiredVersion - モジュールの正確で必要なバージョンを指定します。これは、他のバージョンキーでは使用できません。

Module パラメーターと同じコマンドで、FullyQualifiedModule パラメーターを指定することはできません。 2 つのパラメーターは相互に排他的です。

パラメーターのプロパティ

型:	ModuleSpecification[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-LiteralPath

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

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	PSPath, LP

パラメーターセット

LiteralPath

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Module

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

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

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

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

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

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

パラメーターのプロパティ

型:	PSModuleInfo[]
規定値:	None
ワイルドカードのサポート:	True
DontShow:	False
Aliases:	名前

パラメーターセット

(All)

配置:	1
必須:	False
パイプラインからの値:	True
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Scope

このパラメーターは、このコマンドレットでは何も行いません。

パラメーターのプロパティ

型:	UpdateHelpScope
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-UICulture

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

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

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

パラメーターのプロパティ

型:	CultureInfo[]
規定値:	Current UI culture
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	2
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-UseDefaultCredentials

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

このパラメーターは、Web ダウンロードで NTLM、ネゴシエート、または Kerberos ベースの認証を使用する場合にのみ有効です。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	False
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。詳細については、about_CommonParametersを参照してください。

入力

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) ではサポートされていません。

次の方法で共有

Save-Help

構文

Path (既定)

LiteralPath

説明

例

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

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

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

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

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

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

例 7: 1 日に 1 回以上ヘルプを保存する

パラメーター

-Credential

パラメーターのプロパティ

パラメーター セット

-DestinationPath

パラメーターのプロパティ

パラメーター セット

-Force

パラメーターのプロパティ

パラメーター セット

-FullyQualifiedModule

パラメーターのプロパティ

パラメーター セット

-LiteralPath

パラメーターのプロパティ

パラメーター セット

-Module

パラメーターのプロパティ

パラメーター セット

-Scope

パラメーターのプロパティ

パラメーター セット

-UICulture

パラメーターのプロパティ

パラメーター セット

-UseDefaultCredentials

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

PSModuleInfo

出力

None

メモ

関連リンク

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット