Edit

Share via

Disable-DscDebug

  • Reference
Module:
PSDesiredStateConfiguration

Stops debugging of DSC resources.

Syntax

Disable-DscDebug
       [-CimSession <CimSession[]>]
       [-ThrottleLimit <Int32>]
       [-AsJob]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Disable-DscDebug cmdlet requests that the Windows PowerShell Desired State Configuration (DSC) engine stop debugging of DSC resources. This cmdlet has no effect if the DSC engine is not currently in debugging mode.

Examples

Example 1: Stop resource debugging

Disable-DscDebug

This command indicates to the DSC engine on the Local Configuration Manager (LCM) to stop resource debugging.

Example 2: Check the engine state and stop debugging

if((Get-DscLocalConfigurationManager).DebugMode -like '*Break*'){Disable-DscDebug}

This command checks the DSC engine state, and stops resource debugging only if it is already in debugging mode

Parameters

-AsJob

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False