Set-PSBreakpoint

Sets a breakpoint on a line, command, or variable. PowerShell reference

From the PowerShell reference 7 parameters Alias sbp

What it does

from the PowerShell reference, CC BY 4.0

Sets a breakpoint on a line, command, or variable. The Set-PSBreakpoint cmdlet sets a breakpoint in a script or in any command run in the current session. You can use Set-PSBreakpoint to set a breakpoint before executing a script or running a command, or during debugging, when stopped at another breakpoint. Set-PSBreakpoint cannot set a breakpoint on a remote computer. To debug a script on a remote computer, copy the script to the local computer and then debug it locally. Each Set-PSBreakpoint command creates one of the following three types of breakpoints: - Line breakpoint - Sets breakpoints at particular line and column coordinates. - Command breakpoint - Sets breakpoints on commands and functions. - Variable breakpoint - Sets breakpoints on variables. You can set a breakpoint on multiple lines, commands, or variables in a single Set-PSBreakpoint command, but each Set-PSBreakpoint command sets only one type of breakpoint. At a breakpoint, PowerShell temporarily stops executing and gives control to the debugger. The command prompt changes to DBG>, and a set of debugger commands become available for use. However, you can use the Action parameter to specify an alternate response, such as conditions for the breakpoint or instructions to perform additional tasks such as logging or diagnostics. The Set-PSBreakpoint cmdlet is one of several cmdlets designed for debugging PowerShell scripts. For more information about the PowerShell debugger, see about_Debuggers.

Set-PSBreakpoint [-Action <ScriptBlock>] [[-Column] <Int32>] [-Line] <Int32[]> [-Script] <String[]> [<CommonParameters>]

Set-PSBreakpoint [-Action <ScriptBlock>] -Command <String[]> [[-Script] <String[]>] [<CommonParameters>]

Set-PSBreakpoint [-Action <ScriptBlock>] [[-Script] <String[]>] -Variable <String[]> [-Mode <VariableAccessMode>] [<CommonParameters>]

Set a breakpoint on a line

Set-PSBreakpoint -Script "sample.ps1" -Line 5Identify

Set a breakpoint on a function

Set-PSBreakpoint -Command "Increment" -Script "sample.ps1"Identify

Set a breakpoint on a variable

Set-PSBreakpoint -Script "sample.ps1" -Variable "Server" -Mode ReadWriteIdentify

Set a breakpoint on every command that begins with specified text

Set-PSBreakpoint -Script Sample.ps1 -Command "write*"Identify

Set a breakpoint depending on the value of a variable

Set-PSBreakpoint -Script "test.ps1" -Command "DiskTest" -Action { if ($Disk -gt 2) { break } }Identify

Set a breakpoint on a function

PS> Set-PSBreakpoint -Command "checklog"
Id : 0
Command : checklog
Enabled : True
HitCount : 0
Action :

function CheckLog {
Get-EventLog -Log Application |
Where-Object {($_.Source -like "TestApp") -and ($_.Message -like "failed")}
}
PS> Checklog
DEBUG: Hit breakpoint(s)
DEBUG: Function breakpoint on 'prompt:Checklog'

Identify

Trips 1 Sigma rule: mediumEventLog Query Requests By Builtin Utilities by Ali Alwashali, Nasreddine Bencherchali (Nextron Systems)

Set breakpoints on multiple lines

PS C:> Set-PSBreakpoint -Script "sample.ps1" -Line 1, 14, 19 -Column 2 -Action {&(log.ps1)}Identify

Its page in the reference: Set-PSBreakpoint.

Parameters

7 in the PowerShell reference

-ActionSpecifies commands that run at each breakpoint instead of breaking. Enter a scriptblock that contains the commands. You can use this parameter to set conditional breakpoints or to perform other tasks, such as testing or logging. If this parameter is omitted, or no action is specified, execution stops at the breakpoint, and the debugger starts. When the Action parameter is used, the Action scriptblock runs at each breakpoint. Execution does not stop unless the scriptblock includes the break keyword. If you use the continue keyword in the scriptblock, execution resumes until the next breakpoint. For more information, see about_Script_Blocks, about_Break, and about_Continue.

-ColumnSpecifies the column number of the column in the script file on which execution stops. Enter only one column number. The default is column 1. The Column value is used with the value of the Line parameter to specify the breakpoint. If the Line parameter specifies multiple lines, the Column parameter sets a breakpoint at the specified column on each of the specified lines. PowerShell stops executing before the statement or expression that includes the character at the specified line and column position. Columns are counted from the top left margin beginning with column number 1 (not 0). If you specify a column that does not exist in the script, an error is not declared, but the breakpoint is never executed.

-CommandSets a command breakpoint. Enter cmdlet names, such as Get-Process, or function names. Wildcards are permitted. Execution stops just before each instance of each command is executed. If the command is a function, execution stops each time the function is called and at each begin, process, and end block.

-LineSets a line breakpoint in a script. Enter one or more line numbers, separated by commas. PowerShell stops immediately before executing the statement that begins on each of the specified lines. Lines are counted from the top left margin of the script file beginning with line number 1 (not 0). If you specify a blank line, execution stops before the next non-blank line. If the line is out of range, the breakpoint is never hit.

-ModeSpecifies the mode of access that triggers variable breakpoints. The default is Write. This parameter is valid only when the Variable parameter is used in the command. The mode applies to all breakpoints set in the command. The acceptable values for this parameter are: - Write - Stops execution immediately before a new value is written to the variable. - Read - Stops execution when the variable is read, that is, when its value is accessed, either to be assigned, displayed, or used. In read mode, execution does not stop when the value of the variable changes. - ReadWrite - Stops execution when the variable is read or written.

-ScriptSpecifies an array of script files that this cmdlet sets a breakpoint in. Enter the paths and file names of one or more script files. If the files are in the current directory, you can omit the path. Wildcards are permitted. By default, variable breakpoints and command breakpoints are set on any command that runs in the current session. This parameter is required only when setting a line breakpoint.

-VariableSpecifies an array of variables that this cmdlet sets breakpoints on. Enter a comma-separated list of variables without dollar signs ($). Use the Mode parameter to determine the mode of access that triggers the breakpoints. The default mode, Write, stops execution just before a new value is written to the variable.

Set-PSBreakpoint

What it does

Parameters

See also