Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers  Aliases  Modules
 

Debug-Job

Debug-Job

Microsoft.PowerShell.Core

Synopsis

Debugs a running background, remote, or Windows PowerShell Workflow job.

Syntax

Debug-Job [-Id] [-Confirm] [-WhatIf] [<CommonParameters>]

Debug-Job [-InstanceId] [-Confirm] [-WhatIf] [<CommonParameters>]

Debug-Job [-Job] [-Confirm] [-WhatIf] [<CommonParameters>]

Debug-Job [-Name] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

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

-Confirm <SwitchParameter>

Aliases

cf

Required?

false

Position

named

Default value

False

Accept pipeline input?

False

Accept wildcard characters?

false

-Id <Int32>

Aliases

none

Required?

true

Position

0

Default value

None

Accept pipeline input?

False

Accept wildcard characters?

false

-InstanceId <Guid>

Aliases

none

Required?

true

Position

0

Default value

None

Accept pipeline input?

False

Accept wildcard characters?

false

-Job <Job>

Aliases

none

Required?

true

Position

0

Default value

None

Accept pipeline input?

True (ByPropertyName, ByValue)

Accept wildcard characters?

false

-Name <String>

Aliases

none

Required?

true

Position

0

Default value

None

Accept pipeline input?

False

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Aliases

wi

Required?

false

Position

named

Default value

False

Accept pipeline input?

False

Accept wildcard characters?

false

Input Type

System.Management.Automation.RemotingJob

Return Type

Notes

Examples

Example 1: Debug a job by job ID

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

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"

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