Start-DscConfiguration
ノードに構成を適用します。
構文
Start-DscConfiguration
[-Wait]
[-Force]
[[-Path] <String>]
[[-ComputerName] <String[]>]
[-Credential <PSCredential>]
[-ThrottleLimit <Int32>]
[-JobName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-DscConfiguration
[-Wait]
[-Force]
[[-Path] <String>]
-CimSession <CimSession[]>
[-ThrottleLimit <Int32>]
[-JobName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-DscConfiguration
[-Wait]
[-Force]
[[-ComputerName] <String[]>]
[-Credential <PSCredential>]
[-ThrottleLimit <Int32>]
[-UseExisting]
[-JobName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Start-DscConfiguration
[-Wait]
[-Force]
-CimSession <CimSession[]>
[-ThrottleLimit <Int32>]
[-UseExisting]
[-JobName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
コマンドレットは Start-DscConfiguration 、ノードに構成を適用します。 UseExisting パラメーターと共に使用すると、ターゲット コンピューター上の既存の構成が適用されます。 コンピューター名を指定するか、共通情報モデル (CIM) セッションを使用して、構成を適用するコンピューターを指定します。
既定では、このコマンドレットは、ジョブを作成し、Job オブジェクトを返します。 バックグラウンド ジョブの詳細については、「」と入力します Get-Help about_Jobs。 このコマンドレットを対話的に使用するには、Wait パラメーターを指定します。
コマンドレットが構成設定を適用するときの動作内容の詳細を確認するには、Verbose パラメーターを指定します。
例
例 1: 構成設定を適用する
Start-DscConfiguration -Path "C:\DSC\Configurations\"このコマンドは、 の C:\DSC\Configurations\ 構成設定を、そのフォルダー内の設定を持つすべてのコンピューターに適用します。 コマンドは、配置されている対象ノードごとに Job オブジェクトを返します。
例 2: 構成設定を適用し、構成が完了するまで待機する
Start-DscConfiguration -Path "C:\DSC\Configurations\" -Wait -Verboseこのコマンドは、 から C:\DSC\Configurations\ ローカル コンピューターに構成を適用します。 コマンドは、配置されている対象ノードごとに Job オブジェクトを返します (この場合はローカル コンピューターのみ)。 この例では、 Verbose パラメーターを指定します。 したがって、コマンドは、処理が進むにつれてコンソールにメッセージを送信します。 コマンドには Wait パラメーターが含まれています。 したがって、コマンドがすべての構成タスクを完了するまで、コンソールを使用することはできません。
例 3: CIM セッションを使用して構成設定を適用する
$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Start-DscConfiguration -Path "C:\DSC\Configurations\" -CimSession $Sessionこの例では、指定したコンピューターに構成設定を適用します。 例では、コマンドレットで使用するために、Server01 という名前のコンピューター用に CIM セッションを作成します。 または、CIM セッションの配列を作成して、指定した複数のコンピューターにコマンドレットを適用します。
最初のコマンドは、 コマンドレットを使用して CIM セッションを New-CimSession 作成し、 CimSession オブジェクトを 変数に $Session 格納します。 コマンドはパスワードの入力をユーザーに求めます。 詳細を表示するには「Get-Help NewCimSession」を入力します。
2 番目のコマンドは、 から C:\DSC\Configurations 構成設定を、 変数に格納されている CimSession オブジェクトによって識別されるコンピューターに $Session 適用します。 この例では、 $Session Server01 という名前のコンピューターに対してのみ CIM セッションが変数に含まれています。 コマンドは設定を適用します。 コマンドは、構成されているコンピューターごとに Job オブジェクトを作成します。
パラメーター
-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 |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
-Force
ターゲット コンピューターで現在実行されている構成操作を停止し、新しい Start-Configuration 操作を開始します。 Local Configuration Managerの RefreshMode プロパティが Pull に設定されている場合、このパラメーターを指定すると Push に変更されます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobName
ジョブのフレンドリ名を指定します。 このパラメーターを指定すると、コマンドレットがジョブとして実行され、Job オブジェクトを返します。
既定では、Windows PowerShellは JobN という名前を割り当てます。ここで、N は整数です。
Wait パラメーターを指定した場合は、このパラメーターを指定しないでください。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
構成設定ファイルを含むフォルダーのファイル パスを指定します。 このコマンドレットは、これらの構成設定を発行し、指定されたパスに設定ファイルがあるコンピューターに適用します。 各ターゲット ノードには、次の形式の設定ファイルが必要です。 <NetBIOS Name>.mof
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| 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 |
-UseExisting
このコマンドレットが既存の構成を適用することを示します。 構成は、 を使用して、または Publish-DscConfiguration コマンドレットを使用 Start-DscConfiguration してパブリケーションを使用して、ターゲット コンピューターに存在できます。
このコマンドレットにこのパラメーターを指定する前に、「Windows PowerShell 5.0 の新機能」の情報を確認してください。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Wait
コマンドレットがすべての構成タスクを完了するまでコンソールをブロックすることを示します。
このパラメーターを指定した場合は、JobName パラメーターを指定しないでください。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
