Start-DscConfiguration
構文
ComputerNameAndPathSet (既定)
Start-DscConfiguration
[[-Path] <String>]
[[-ComputerName] <String[]>]
[-Wait]
[-Force]
[-Credential <PSCredential>]
[-ThrottleLimit <Int32>]
[-JobName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CimSessionAndPathSet
Start-DscConfiguration
[[-Path] <String>]
-CimSession <CimSession[]>
[-Wait]
[-Force]
[-ThrottleLimit <Int32>]
[-JobName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ComputerNameAndUseExistingSet
Start-DscConfiguration
[[-ComputerName] <String[]>]
[-Wait]
[-Force]
[-Credential <PSCredential>]
[-ThrottleLimit <Int32>]
[-UseExisting]
[-JobName <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CimSessionAndUseExistingSet
Start-DscConfiguration
-CimSession <CimSession[]>
[-Wait]
[-Force]
[-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\ の構成設定を、そのフォルダー内の設定を持つすべてのコンピューターに適用します。 このコマンドは、デプロイ先の各ターゲット ノードのジョブ オブジェクト 返します。
例 2: 構成設定を適用し、構成が完了するまで待機する
Start-DscConfiguration -Path "C:\DSC\Configurations\" -Wait -Verbose
このコマンドは、C:\DSC\Configurations\ からローカル コンピューターに構成を適用します。 このコマンドは、デプロイ先の各ターゲット ノード (この場合はローカル コンピューターのみ) の ジョブ オブジェクトを返します。 この例では、Verbose パラメーターを指定します。 したがって、このコマンドは、メッセージの進行に合ってコンソールに送信します。 このコマンドには、Wait パラメーターが含まれています。 したがって、コマンドがすべての構成タスクを完了するまで、コンソールを使用することはできません。
例 3: CIM セッションを使用して構成設定を適用する
$Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
Start-DscConfiguration -Path "C:\DSC\Configurations\" -CimSession $Session
次の使用例は、指定したコンピューターに構成設定を適用します。 この例では、コマンドレットで使用する Server01 という名前のコンピューターの CIM セッションを作成します。 または、CIM セッションの配列を作成して、指定された複数のコンピューターにコマンドレットを適用します。
最初のコマンドは、New-CimSession コマンドレットを使用して CIM セッションを作成し、CimSession オブジェクトを $Session 変数に格納します。 コマンドによってパスワードの入力が求められます。 詳細については、「Get-Help NewCimSession」と入力します。
2 番目のコマンドは、C:\DSC\Configurations 変数に格納されている CimSession オブジェクトによって識別されるコンピューターに、$Session からの構成設定を適用します。 この例では、$Session 変数には、Server01 という名前のコンピューターに対してのみ CIM セッションが含まれています。 このコマンドは、構成を適用します。 このコマンドは、構成 コンピューターごとにジョブ オブジェクトを作成します。
パラメーター
-CimSession
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。
New-CimSession の出力や Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクト 入力します。 既定値は、ローカル コンピューター上の現在のセッションです。
パラメーターのプロパティ
| 型: | CimSession[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CimSessionAndPathSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CimSessionAndUseExistingSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ComputerName
コンピューター名の配列を指定します。 このパラメーターは、Path パラメーターに構成ドキュメントがあるコンピューターを配列で指定されたコンピューターに制限します。
パラメーターのプロパティ
| 型: | String[]
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | CN, サーバー名 |
パラメーター セット
ComputerNameAndPathSet
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ComputerNameAndUseExistingSet
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Credential
ターゲット コンピューターの PSCredential オブジェクト として、ユーザー名とパスワードを指定します。
PSCredential オブジェクトを取得するには、Get-Credential コマンドレットを使用します。
詳細については、「Get-Help Get-Credential」と入力します。
パラメーターのプロパティ
パラメーター セット
ComputerNameAndPathSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
ComputerNameAndUseExistingSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
ターゲット コンピューターで現在実行されている構成操作を停止し、新しい Start-Configuration 操作を開始します。 ローカル構成マネージャーの RefreshMode プロパティがプル に設定されている場合、このパラメーターを指定すると、プッシュに変更されます。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-JobName
ジョブのフレンドリ名を指定します。 このパラメーターを指定すると、コマンドレットはジョブとして実行され、Job オブジェクトが返されます。
既定では、Windows PowerShell によって JobN という名前が割り当てられます。N は整数です。
Wait パラメーターを指定する場合は、このパラメーターを指定しないでください。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Path
構成設定ファイルを含むフォルダーのファイル パスを指定します。 このコマンドレットは、これらの構成設定を発行し、指定されたパスに設定ファイルがあるコンピューターに適用します。 各ターゲット ノードには、次の形式の設定ファイルが必要です: <NetBIOS Name>.mof。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ComputerNameAndPathSet
| 配置: | 0 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CimSessionAndPathSet
| 配置: | 0 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ThrottleLimit
コマンドレットを実行するために確立できる同時実行操作の最大数を指定します。 このパラメーターを省略するか、0 の値を入力すると、Windows PowerShell は、コンピューターで実行されている CIM コマンドレットの数に基づいて、コマンドレットの最適なスロットル制限を計算します。 スロットル制限は、セッションまたはコンピューターではなく、現在のコマンドレットにのみ適用されます。
パラメーターのプロパティ
| 型: | Int32
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UseExisting
このコマンドレットが既存の構成を適用することを示します。 構成は、Start-DscConfiguration を使用して適用するか、Publish-DscConfiguration コマンドレットを使用してパブリケーションすることによって、ターゲット コンピューターに存在できます。
このコマンドレットにこのパラメーターを指定する前に、「Windows PowerShell 5.0 の新機能」の情報を確認してください。
パラメーターのプロパティ
パラメーター セット
ComputerNameAndUseExistingSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CimSessionAndUseExistingSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Wait
コマンドレットがすべての構成タスクを完了するまでコンソールをブロックすることを示します。
このパラメーターを指定する場合は、JobName パラメーターを指定しないでください。
パラメーターのプロパティ
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter
|
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
