次の方法で共有

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 セッションの配列を作成して、指定された複数のコンピューターにコマンドレットを適用します。

最初のコマンドは、New-CimSession コマンドレットを使用して CIM セッションを作成し、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」を参照してください。

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

-CimSession

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

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

-ComputerName

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

型:String[]
Aliases:CN, ServerName
配置:1
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Credential

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

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

-Detailed

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

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

-Path

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

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

-ReferenceConfiguration

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

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

-ThrottleLimit

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

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