Debug-Process

Debugs one or more processes running on the local computer.
Debug-Process [-Name*] <String[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Debug-Process [-Id*] <Int32[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Debug-Process -InputObject* <Process[]> [-Confirm] [-WhatIf] [<CommonParameters>]

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[]>

  • This value is required
  • Default value is None
  • Accepts pipeline input ByPropertyName

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.

-InputObject <Process[]>

  • This value is required
  • Accepts pipeline input ByValue

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.

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

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

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.

Examples
  1. Attach a debugger to a process on the computer:
    PS C:> Debug-Process -Name "Windows Powershell"
    

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

  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.

  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.

  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.

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

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

  7. Attach a debugger to the specified process on multiple computers:
    PS C:> Get-Process -ComputerName "Server01", "Server02" -Name "MyApp" | Debug-Process
    

    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.

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

Additional 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.
Related Links

Debug-Process
Get-Process
Start-Process
Stop-Process
Wait-Process