Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Debug-Process

Updated: August 9, 2015

Debug-Process

Debugs one or more processes running on the local computer.

Syntax

Parameter Set: Name
Debug-Process [-Name] <String[]> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Id
Debug-Process [-Id] <Int32[]> [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject
Debug-Process -InputObject <Process[]> [-Confirm] [-WhatIf] [ <CommonParameters>]




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

Parameters

-Id<Int32[]>

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.


Aliases

PID,ProcessId

Required?

true

Position?

1

Default Value

None

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<Process[]>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name<String[]>

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.


Aliases

ProcessName

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


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.


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

The input type is the type of the objects that you can pipe to the cmdlet.

  • 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

The output type is the type of the objects that the cmdlet emits.

  • 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 at http://go.microsoft.com/fwlink/?LinkId=143640.

Examples

Example 1: Attach a debugger to a process on the computer

This command attaches a debugger to the Windows PowerShell process on the computer.


PS C:\> Debug-Process -Name "Windows Powershell"

Example 2: Attach a debugger to all processes that begin with the specified string

This command attaches a debugger to all processes that have names that begin with SQL.


PS C:\> Debug-Process -Name "SQL*"

Example 3: Attach a debugger to multiple processes

This command attaches a debugger to the Winlogon, Explorer, and Outlook processes.


PS C:\> Debug-Process "Winlogon", "Explorer", "Outlook"

Example 4: Attach a debugger to multiple process IDs

This command attaches a debugger to the processes that have process IDs 1132 and 2028.


PS C:\> Debug-Process -Id 1132, 2028

Example 5: Use Get-Process to get a process then attach a debugger to it

This command attaches a debugger to the Windows PowerShell processes on the computer. It uses the Get-Process cmdlet to get the Windows 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.


PS C:\> Get-Process "Windows PowerShell" | Debug-Process

Example 6: Attach a debugger to a current process on the local computer

This command attaches a debugger to the current Windows PowerShell processes on the computer.

The command uses the $PID automatic variable, which contains the process ID of the current Windows 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.


PS C:\> $PID | Debug-Process

Example 7: Attach a debugger to the specified process on multiple computers

This command attaches a debugger to the MyApp processes on the Server01 and Server02 computers.

The command uses the Get-Process cmdlet to get the MyApp processes on the Server01 and Server02 computers. It uses a pipeline operator to send the processes to the Debug-Process cmdlet, which attaches the debuggers.


PS C:\> Get-Process -ComputerName "Server01", "Server02" -Name "MyApp" | Debug-Process

Example 8: Attach a debugger to a process that uses the InputObject parameter

This command attaches a debugger to the Windows PowerShell processes on the local computer.

The first command uses the Get-Process cmdlet to get the Windows 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.


PS C:\> $P = Get-Process "Windows PowerShell"
PS C:\>Debug-Process -InputObject $P

Related topics

Community Additions

ADD
Show:
© 2016 Microsoft