Enable-DscDebug

Starts debugging of all DSC resources.
Enable-DscDebug [-AsJob] [-BreakAll] [-CimSession <CimSession[]>] [-ThrottleLimit [<Int32>]] [-Confirm] [-WhatIf][<CommonParameters>]

The Enable-DscDebug cmdlet enables Windows PowerShell Desired State Configuration (DSC) resource debugging by the DSC engine, which is also known as the Local Configuration Manager (LCM). By default, all resource instances break into the debugger.

Parameters
-AsJob [<SwitchParameter>]

Indicates that this cmdlet runs the command as a background job.

If you specify the AsJob parameter, the command returns an object that represents the job, and then displays the command prompt. You can continue to work in the session until the job finishes. The job is created on the local computer and the results from remote computers are automatically returned to the local computer. To manage the job, use the Job cmdlets. To get the job results, use the Receive-Job cmdlet.

To use this parameter, the local and remote computers must be configured for remoting, and on Windows Vista and later versions of the Windows operating system, you must open Windows PowerShell with the Run as administrator option.

-BreakAll <SwitchParameter>

Indicates that all resources enter the debugger when a configuration runs.

-CimSession <CimSession[]>

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.

-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.

-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. Start debugging:
    PS C:> Enable-DscDebug -BreakAll
    

    This command indicates to the DSC engine or LCM to start resource debugging. The next time the configuration is run, the process enters the debugger.

  2. Start remote debugging:
    PS C:> Enable-DscDebug -BreakAll -CimSession DeploymentServer
    

    This command indicates to the DSC engine of the remote computer to start resource debugging.

Related Links

Disable-DscDebug
Get-DscConfiguration
Get-DscConfigurationStatus
Restore-DscConfiguration
Start-DscConfiguration
Test-DscConfiguration