Test-PSSessionConfigurationFile

  • リファレンス
モジュール:
Microsoft.PowerShell.Core

セッション構成ファイル内のキーと値を確認します。

構文

Test-PSSessionConfigurationFile
    [-Path] <String>
    [<CommonParameters>]

説明

このコマンドレットは、セッション構成ファイルに有効なキーが含まれており、値が正しい型であることを確認します。 列挙値の場合、コマンドレットは、指定した値が有効であることを検証します。

このコマンドレットは、ファイルがすべてのテストに合格した場合は $True を返し、合格しない場合は $False します。 エラーを見つけるには、 Verbose パラメーターを使用します。

Test-PSSessionConfigurationFile は、セッション構成ファイル ( New-PSSessionConfigurationFile コマンドレットによって作成されたものなど) を検証します。 セッション構成の詳細については、 about_Session_Configurationsを参照してください。 セッション構成ファイルの詳細については、 about_Session_Configuration_Filesを参照してください。

このコマンドレットは、PowerShell 3.0 で導入されました。

例

例 1: セッション構成ファイルをテストする

Test-PSSessionConfigurationFile -Path "FullLanguage.pssc"

True

例 2: セッション構成のセッション構成ファイルをテストする

この例では、 Restricted セッション構成で使用される構成ファイルをテストします。 Path パラメーターの値は、Restricted セッション構成を取得するGet-PSSessionConfiguration コマンドの結果です。 セッション構成ファイルのパスは、セッション構成の ConfigFilePath プロパティの値に格納されます。

Test-PSSessionConfigurationFile -Path (Get-PSSessionConfiguration -Name Restricted).ConfigFilePath

例 3: すべてのセッション構成ファイルをテストする

この例の関数は、ローカル コンピューター上のすべてのセッション構成ファイルをテストします。 この関数では、 Get-PSSessionConfiguration コマンドレットを使用して、すべてのセッション構成を取得します。 ForEach-Object ループ内のコードは、ファイル パスを表示し、各セッション構成をテストします。

function Test-AllConfigFiles
{
    Get-PSSessionConfiguration | ForEach-Object {
        if ($_.ConfigFilePath) {
            $_.ConfigFilePath
            Test-PSSessionConfigurationFile -Verbose -Path $_.ConfigFilePath
        }
    }
}
Test-AllConfigFiles

C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\Empty_6fd77bf6-e084-4372-bd8a-af3e207354d3.pssc
True
C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\Full_1e9cb265-dae0-4bd3-89a9-8338a47698a1.pssc
VERBOSE: The member 'AliasDefinitions' must contain the required key 'Description'. Add the require key
to the fileC:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\Full_1e9cb265-dae0-4bd3-89a9-8338a47698a1.pssc.
False
C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\NoLanguage_0c115179-ff2a-4f66-a5eb-e56e5692ba22.pssc
True
C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\RestrictedLang_b6bd9474-0a6c-4e06-8722-c2c95bb10d3e.pssc
True
C:\WINDOWS\System32\WindowsPowerShell\v1.0\SessionConfig\RRS_3fb29420-2c87-46e5-a402-e21436331efc.pssc
True

セッション構成の ConfigFilePath プロパティには、セッション構成で使用されるセッション構成ファイルのパス (存在する場合) が含まれます。

ConfigFilePath プロパティの値が設定されている場合 (true)、コマンドは ConfigFilePath プロパティ値を取得 (出力) します。 次に、 Test-PSSessionConfigurationFile コマンドレットを使用して、 ConfigFilePath 値内のファイルをテストします。 Verbose パラメーターは、ファイルがテストに失敗したときにファイル エラーを返します。

パラメーター

-Path

セッション構成ファイル (.pssc) のパスとファイル名を指定します。 パスを省略した場合、既定値は現在のフォルダーです。 ワイルドカード文字はサポートされていますが、1 つのファイルに解決する必要があります。 セッション構成ファイルのパスをパイプして Test-PSSessionConfigurationFileすることもできます。

型:String
配置:0
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:True

入力

String

セッション構成ファイルのパスをこのコマンドレットにパイプできます。

出力

Boolean