Test-DscConfiguration

  • リファレンス
モジュール:
PSDesiredStateConfiguration

ノード上の実際の構成が必要な構成と一致するかどうかをテストします。

構文

Test-DscConfiguration
    [[-ComputerName] <String[]>]
    [-Credential <PSCredential>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-Detailed]
    [<CommonParameters>]
Test-DscConfiguration
    [[-ComputerName] <String[]>]
    [-Credential <PSCredential>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-Path] <String>
    [<CommonParameters>]
Test-DscConfiguration
    [[-ComputerName] <String[]>]
    [-Credential <PSCredential>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    -ReferenceConfiguration <String>
    [<CommonParameters>]
Test-DscConfiguration
    [-ThrottleLimit <Int32>]
    -CimSession <CimSession[]>
    [-AsJob]
    [-Path] <String>
    [<CommonParameters>]
Test-DscConfiguration
    [-ThrottleLimit <Int32>]
    -CimSession <CimSession[]>
    [-AsJob]
    -ReferenceConfiguration <String>
    [<CommonParameters>]
Test-DscConfiguration
    [-ThrottleLimit <Int32>]
    -CimSession <CimSession[]>
    [-AsJob]
    [-Detailed]
    [<CommonParameters>]

説明

コマンドレットは Test-DscConfiguration 、ノード上の実際の構成が目的の構成と一致するかどうかをテストします。 コンピューター名または共通情報モデル (CIM) セッションを使用して、構成をテストするコンピューターを指定します。 ターゲット コンピューターを指定しない場合、コマンドレットではローカル コンピューターの構成をテストします。

必要な構成と実際の構成が一致する場合、コマンドレットは文字列値 'True' を返します。 それ以外の場合は、文字列値 'False' を返します。

例

例 1: ローカル コンピューターの構成をテストする

Test-DscConfiguration

以下のコマンドは、ローカル コンピューターの構成をテストします。

例 2: 指定したコンピューターの構成をテストする

$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Test-DscConfiguration -CimSession $Session

この例では、CIM セッションによって指定されたコンピューターからの構成をテストします。 例では、コマンドレットで使用するために、Server01 という名前のコンピューター用に CIM セッションを作成します。 または、CIM セッションの配列を作成して、指定した複数のコンピューターにコマンドレットを適用します。

最初のコマンドは、 コマンドレットを使用して CIM セッションを New-CimSession 作成し、 CimSession オブジェクトを $Session 変数に格納します。 コマンドはパスワードの入力をユーザーに求めます。 詳細を表示するには「Get-Help New-CimSession」を入力します。

2 番目のコマンドは、変数に格納されている CimSession オブジェクトによって $Session 識別されるコンピューター (この場合は Server01 という名前のコンピューター) の構成をテストします。

例 3: 詳細な結果を含む構成をテストする

Test-DscConfiguration -ComputerName "Server01", "Server02", "Server03" -Detailed

このコマンドは、 ComputerName パラメーターで指定された一連のコンピューターの構成をテストし、全体的な状態、目的の状態にあるリソース、目的の状態ではないリソース、およびコンピューター名を含む詳細情報を返します。

例 4: フォルダーに指定された構成をテストする

Test-DscConfiguration -Path "C:\Dsc\Configurations"

このコマンドは、 Path パラメーターで指定されたフォルダーで定義されている構成をテストします。 構成は一連のコンピューターに対してテストされ、それぞれ構成ファイルのファイル名で識別されます。

例 5: ファイルで指定された構成をテストする

Test-DscConfiguration -ReferenceConfiguration "C:\Dsc\Configurations\WebServer.mof" -ComputerName "Server01", "Server02", "Server03"

このコマンドは、 ComputerName パラメーターで指定された一連のコンピューターに対して、ファイルで定義された構成をテストします。

パラメーター

-AsJob

このコマンドレットがバックグラウンド ジョブとしてコマンドを実行することを示します。

AsJob パラメーターを指定した場合、コマンドはジョブを表す オブジェクトを返し、コマンド プロンプトを表示します。 ジョブが完了するまで、セッションで作業を続けることができます。 ジョブは、ローカル コンピューターで作成され、リモート コンピューターでの結果は自動的にローカル コンピューターに返されます。 ジョブを管理するには、Job コマンドレットを使用します。 ジョブの結果を取得するには、Receive-Job コマンドレットを使用します。

このパラメーターを使用するには、リモート処理用にローカル コンピューターとリモート コンピューターを構成する必要があります。Windows Vista 以降のバージョンの Windows オペレーティング システムでは、[管理者として実行] オプションを使用してWindows PowerShellを開く必要があります。 詳細については、「about_Remote_Requirements」を参照してください。

Windows PowerShellバックグラウンド ジョブの詳細については、「about_Jobsとabout_Remote_Jobs」を参照してください。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。 コンピューター名またはセッション オブジェクト ( New-CimSession または Get-CimSession コマンドレットの出力など) を入力します。 既定値は、ローカル コンピューターで実行中の現在のセッションです。

Type:CimSession[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ComputerName

このコマンドレットが構成をテストするコンピューター名の配列を指定します。 コマンドレットは、 Path パラメーターで指定された場所にある構成ドキュメントを、これらのコンピューターに対してテストします。

Type:String[]
Aliases:CN, ServerName
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Credential

ターゲット コンピューターに対して、ユーザー名とパスワードを、PSCredential オブジェクトとして指定します。 PSCredential オブジェクトを取得するには、 コマンドレットを使用しますGet-Credential。 詳細を表示するには「Get-Help Get-Credential」を入力します。

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Detailed

このコマンドレットは、構成ドキュメントとノードの目的の状態を比較した詳細な結果を返します。 結果には、全体的な状態、目的の状態にあるリソース、目的の状態ではないリソース、コンピューター名などの情報が含まれます。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

構成ドキュメント ファイルを含むフォルダーのパスを指定します。 コマンドレットは、 ComputerName または CimSession パラメーターで指定されたコンピューターの目的の状態に対して構成をテストします。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ReferenceConfiguration

構成ドキュメント ファイルのパスを指定します。 このコマンドレットは、 ComputerName パラメーターまたは CimSession パラメーターで指定されたコンピューターの実際の状態に対して構成をテストします。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

コマンドレットを実行するために確立できる最大並行処理数を指定します。 このパラメーターを省略するか、 の0値を入力した場合、Windows PowerShellは、コンピューターで実行されている CIM コマンドレットの数に基づいて、コマンドレットの最適なスロットル制限を計算します。 調整限度は、現在のコマンドレットのみに適用されます。セッションやコンピューターには適用されません。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False