Debug-Process
SYNOPSIS
Debugs one or more processes running on the local computer.
SYNTAX
Name (Default)
Debug-Process [-Name] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
Id
Debug-Process [-Id] <Int32[]> [-WhatIf] [-Confirm] [<CommonParameters>]
InputObject
Debug-Process -InputObject <Process[]> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
The `Debug-Process` cmdlet attaches a debugger to one or more running processes on a local computer. You can specify the processes by their process name or process ID (PID), or you can pipe process objects to this cmdlet.
This cmdlet attaches the debugger that is currently registered for the process. Before using this cmdlet, verify that a debugger is downloaded and correctly configured.
EXAMPLES
Example 1: Attach a debugger to a process on the computer
PS C:\> Debug-Process -Name "Windows Powershell"
This command attaches a debugger to the PowerShell process on the computer.
Example 2: Attach a debugger to all processes that begin with the specified string
PS C:\> Debug-Process -Name "SQL*"
This command attaches a debugger to all processes that have names that begin with SQL.
Example 3: Attach a debugger to multiple processes
PS C:\> Debug-Process "Winlogon", "Explorer", "Outlook"
This command attaches a debugger to the Winlogon, Explorer, and Outlook processes.
Example 4: Attach a debugger to multiple process IDs
PS C:\> Debug-Process -Id 1132, 2028
This command attaches a debugger to the processes that have process IDs 1132 and 2028.
Example 5: Use Get-Process to get a process then attach a debugger to it
PS C:\> Get-Process "Windows PowerShell" | Debug-Process
This command attaches a debugger to the PowerShell processes on the computer. It uses the `Get-Process` cmdlet to get the PowerShell processes on the computer, and it uses a pipeline operator (`|`) to send the processes to the `Debug-Process` cmdlet.
To specify a particular PowerShell process, use the ID parameter of `Get-Process`.
Example 6: Attach a debugger to a current process on the local computer
PS C:\> $PID | Debug-Process
This command attaches a debugger to the current PowerShell processes on the computer.
The command uses the `$PID` automatic variable, which contains the process ID of the current PowerShell process. Then, it uses a pipeline operator (`|`) to send the process ID to the `Debug-Process` cmdlet.
For more information about the `$PID` automatic variable, see about_Automatic_Variables (../Microsoft.PowerShell.Core/About/about_Automatic_Variables.md).
Example 7: Attach a debugger to a process that uses the InputObject parameter
PS C:\> $P = Get-Process "Windows PowerShell"
PS C:\> Debug-Process -InputObject $P
This command attaches a debugger to the PowerShell processes on the local computer.
The first command uses the `Get-Process` cmdlet to get the PowerShell processes on the computer. It saves the resulting process object in the variable named `$P`.
The second command uses the InputObject parameter of the `Debug-Process` cmdlet to submit the process object in the `$P` variable.
PARAMETERS
-Id
Specifies the process IDs of the processes to be debugged. The Id parameter name is optional.
To find the process ID of a process, type `Get-Process`.
Type: System.Int32[]
Parameter Sets: Id
Aliases: PID, ProcessId
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-InputObject
Specifies the process objects that represent processes to be debugged. Enter a variable that contains the process objects or a command that gets the process objects, such as the `Get-Process` cmdlet. You can also pipe process objects to this cmdlet.
Type: System.Diagnostics.Process[]
Parameter Sets: InputObject
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Name
Specifies the names of the processes to be debugged. If there is more than one process with the same name, this cmdlet attaches a debugger to all processes with that name. The Name parameter is optional.
Type: System.String[]
Parameter Sets: Name
Aliases: ProcessName
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
System.Int32, System.Diagnostics.Process, System.String
You can pipe a process ID (Int32), a process object (System.Diagnostics.Process), or a process name (String) to this cmdlet.
OUTPUTS
None
This cmdlet does not generate any output.
NOTES
This cmdlet uses the AttachDebugger method of the Windows Management Instrumentation (WMI) Win32_Process class. For more information about this method, see AttachDebugger method (https://go.microsoft.com/fwlink/?LinkId=143640)in the MSDN library.