Start-DscConfiguration

Applies configuration to nodes.
Start-DscConfiguration [-Force] [-JobName [<String>]] [-ThrottleLimit [<Int32>]] [-Wait] -CimSession*<CimSession[]> -UseExisting* [-Confirm] [-WhatIf] [<CommonParameters>]
Start-DscConfiguration [[-Path] [<String>]] [-Force] [-JobName [<String>]] [-ThrottleLimit [<Int32>]] [-Wait]-CimSession* <CimSession[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Start-DscConfiguration [[-Path] [<String>]] [[-ComputerName] [<String[]>]] [-Credential [<PSCredential>]] [-Force][-JobName [<String>]] [-ThrottleLimit [<Int32>]] [-Wait] [-Confirm] [-WhatIf] [<CommonParameters>]
Start-DscConfiguration [[-ComputerName] [<String[]>]] [-Credential [<PSCredential>]] [-Force] [-JobName[<String>]] [-ThrottleLimit [<Int32>]] [-Wait] -UseExisting* [-Confirm] [-WhatIf] [<CommonParameters>]

The Start-DscConfiguration cmdlet applies configuration to nodes. When used with the UseExisting parameter, the existing configuration on the target computer is applied. Specify which computers that 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.

Parameters
-CimSession <CimSession[]>

  • This value is required
  • Accepts pipeline input ByValue

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

-ComputerName [<String[]>]

Specifies an array of computer names. This parameter restricts the computers that have configuration documents in the Path parameter to those specified in the array.

-Credential [<PSCredential>]

Specifies a user name and password, as a PSCredential object, for the target computer. To obtain a PSCredential object, use the Get-Credential cmdlet.

-Force [<SwitchParameter>]

Indicates that the cmdlet pushes configuration to computers. Some computers pull configuration data. If you do not specify this parameter and if the computer pulls its configuration, the configuration fails.

-JobName [<String>]

Specifies a friendly name for a job. If you specify this parameter, the cmdlet runs as a job, and it returns a Job object.

By default, Windows PowerShell assigns the name JobN where N is an integer.

If you specify the Wait parameter, do not specify this parameter.

-Path [<String>]

Specifies a file path of a folder that contains configuration settings files. This cmdlet publishes and applies these configuration settings to computers that have settings files in the specified path. Each target node must have a settings file of the following format: NetBIOS Name.mof.

-ThrottleLimit [<Int32>]

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShellr calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

-UseExisting <SwitchParameter>

  • This value is required

Indicates that this cmdlet applies the existing configuration. The configuration can exist on the target computer by enactment using Start-DscConfiguration or by publication using the Publish-DscConfiguration cmdlet.

Before you specify this parameter for this cmdlet, review the information in What’s New in Windows PowerShell (http://technet.microsoft.com/library/hh857339.aspx) in the TechNet library.

-Wait [<SwitchParameter>]

Indicates that the cmdlet blocks the console until it finishes all configuration tasks.

If you specify this parameter, do not specify the JobName parameter.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Examples
  1. Apply configuration settings:
    PS C:>  Start-DscConfiguration -Path "C:DSCConfigurations"
    

    This command applies the configuration settings from C:DSCConfigurations to the every computer that has settings in that folder. The command returns Job objects for each target node deployed to.

  2. Apply configuration settings and wait for configuration to complete:
    PS C:>  Start-DscConfiguration -Path "C:DSCConfigurations" -Wait -Verbose
    

    This command applies the configuration from C:DSCConfigurations to the local computer. The command returns Job objects for each target node deployed to, in this case, just the local computer. This example specifies the Verbose parameter. Therefore, the command sends messages to the console as it proceeds. The command includes the Wait parameter. Therefore, you cannot use the console until the command finishes all configuration tasks.

  3. Apply configuration settings by using a CIM session:
    PS C:>  $Session = New-CimSession -ComputerName "Server01" -Credential ACCOUNTSPattiFuller
    PS C:>  Start-DscConfiguration -Path "C:DSCConfigurations" -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. Alternatively, 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 for a password. For more information, type Get-Help NewCimSession.

    The second command applies the configuration settings from C:DSCConfigurations 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 objects for each configured computer.

Related Links

Get-DscConfiguration
Get-DscConfigurationStatus
Restore-DscConfiguration
Stop-DscConfiguration
Test-DscConfiguration
Update-DscConfiguration