Debug-Job

Debugs a running background, remote, or Windows PowerShell Workflow job.
Debug-Job [-Job*] <Job> [-Confirm] [-WhatIf] [<CommonParameters>]
Debug-Job [-Id*] <Int32> [-Confirm] [-WhatIf] [<CommonParameters>]
Debug-Job [-InstanceId*] <Guid> [-Confirm] [-WhatIf] [<CommonParameters>]
Debug-Job [-Name*] <String> [-Confirm] [-WhatIf] [<CommonParameters>]

The Debug-Job cmdlet lets you debug scripts that are running within jobs. The cmdlet is designed to debug Windows PowerShell Workflow jobs, background jobs, and jobs running in remote sessions. Debug-Job accepts a running job object, name, ID, or instance ID as input, and starts a debugging session on the script it is running. The debugger quit command stops the job and running script. Starting in Windows PowerShell 5.0, the exit command detaches the debugger, and allows the job to continue to run.

Parameters
-Id <Int32>

  • This value is required

Specifies the ID number of a running job. To get the ID number of a job, run the Get-Job cmdlet.

-InstanceId <Guid>

  • This value is required

Specifies the instance ID GUID of a running job. To get the InstanceId of a job, run the Get-Job cmdlet, piping the results into a Format-* cmdlet, as shown in the following example:

Get-Job | Format-List -Property Id,Name,InstanceId,State

-Job <Job>

  • This value is required
  • Accepts pipeline input ByValue

Specifies a running job object. The simplest way to use this parameter is to save the results of a Get-Job command that returns the running job that you want to debug in a variable, and then specify the variable as the value of this parameter.

-Name <String>

  • This value is required

Specifies a job by the friendly name of the job. When you start a job, you can specify a job name by adding the JobName parameter, in cmdlets such as Invoke-Command and Start-Job.

-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.Management.Automation.RemotingJob

Examples
  1. Debug a job by job ID:
    PS C:> Debug-Job -ID 3
    
       Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
       --     ----            -------------   -----         -----------     --------             -------
       3      Job3            RemoteJob       Running       True            PowerShellIx         TestWFDemo1.ps1
                 Entering debug mode. Use h or ? for help.
                 Hit Line breakpoint on 'C:TestWFDemo1.ps1:8'
                 At C:TestWFDemo1.ps1:8 char:5
                 +     Write-Output -InputObject "Now writing output:" 
                 +     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                 [DBG:PowerShellIx]: PS C:>> list
                     3: 
                     4:  workflow SampleWorkflowTest
                     5:  {
                     6:      param ($MyOutput) 
                     7: 
                     8:*     Write-Output -InputObject "Now writing output:" 
                     9:      Write-Output -Input $MyOutput
                    10: 
                    11:      Write-Output -InputObject "Get PowerShell process:" 
                    12:      Get-Process -Name powershell
                    13: 
                    14:      Write-Output -InputObject "Workflow function complete." 
                    15:  }
                    16: 
                    17:  # Call workflow function
                    18:  SampleWorkflowTest -MyOutput "Hello"

    This command breaks into a running job with an ID of 3.

Related Links

Get-Job
Receive-Job
Remove-Job
Resume-Job
Start-Job
Stop-Job
Suspend-Job
Wait-Job