This is the built-in help made by Microsoft for the command 'Start-DscConfiguration', in PowerShell version 4 - as retrieved from
Windows version 'Microsoft Windows 8.1 Enterprise' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Applies configuration to nodes.
Start-DscConfiguration [-Force] [-JobName [<System.String>]] [-ThrottleLimit [<System.Int32>]] [-Wait] -CimSession <Microsoft.Management.Infrastructure.CimSession[]>
-UseExisting [-Confirm] [-WhatIf] [<CommonParameters>]
Start-DscConfiguration [-Path] <System.String> [-Force] [-JobName [<System.String>]] [-ThrottleLimit [<System.Int32>]] [-Wait] -CimSession <Microsoft.Management.Infra
structure.CimSession[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-DscConfiguration [-Path] <System.String> [[-ComputerName] [<System.String[]>]] [-Credential [<System.Management.Automation.PSCredential>]] [-Force] [-JobName [<
System.String>]] [-ThrottleLimit [<System.Int32>]] [-Wait] [-Confirm] [-WhatIf] [<CommonParameters>]
Start-DscConfiguration [[-ComputerName] [<System.String[]>]] [-Credential [<System.Management.Automation.PSCredential>]] [-Force] [-JobName [<System.String>]] [-Throt
tleLimit [<System.Int32>]] [-Wait] -UseExisting [-Confirm] [-WhatIf] [<CommonParameters>]
The Start-DscConfiguration cmdlet applies configuration to nodes. Specify which computers you want to apply configuration to by specifying computer names or by using
Common Information Model (CIM) sessions.
By default, this cmdlet creates a job and returns a Job object. For more information about background jobs, type Get-Help about_Jobs. To use this cmdlet interactively
, specify the Wait parameter.
Specify the Verbose parameter to see details of what the cmdlet does when it applies configuration settings.
<
Online Version: http://go.microsoft.com/fwlink/?LinkID=294367
Windows PowerShell Desired State Configuration Overview
Get-DscConfiguration
Restore-DscConfiguration
Stop-DscConfiguration
Test-DscConfiguration
Update-DscConfiguration
<
Example 1: Apply configuration settings
PS C:\> Start-DscConfiguration -Path "C:\DSC\Configurations\"
This command applies the configuration settings from C:\DSC\Configurations\ to the every computer that has settings in that folder. The command returns Job objects fo
r each target node deployed to.
Example 2: Apply configuration settings and wait for configuration to complete
PS C:\> Start-DscConfiguration -Path "C:\DSC\Configurations\" -Wait -Verbose
This command applies the configuration from C:\DSC\Configurations\ to the local computer. The command returns Job objects for each target node deployed to, in this ca
se, just the local computer. This example specifies the Verbose parameter, so the command sends messages to the console as it proceeds. The command includes the Wait
parameter, so you cannot use the console until the command completes all configuration tasks.
Example 3: Apply configuration settings by using a CIM session
PS C:\> $Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTS\PattiFuller
PS C:\> Start-DscConfiguration -Path "C:\DSC\Configurations\" -CimSession $Session
This example applies configuration settings to a specified computer. The example creates a CIM session for a computer named Server01 for use with the cmdlet. Alternat
ively, create an array of CIM sessions to apply the cmdlet to multiple specified computers.
The first command creates a CIM session by using the New-CimSession cmdlet, and then stores the CimSession object in the $Session variable. The command prompts you fo
r a password. For more information, type Get-Help NewCimSession.
The second command applies the configuration settins from C:\DSC\Configurations\ to the computers identified by the CimSession objects stored in the $Session variable
. In this example, the $Session variable contains a CIM session only for the computer named Server01. The command applies the configuration. The command creates Job o
bjects for each configured computer.