Suspend-Job

Temporarily stops workflow jobs.
Suspend-Job [-Id*] <Int32[]> [-Force] [-Wait] [-Confirm] [-WhatIf] [<CommonParameters>]
Suspend-Job [-Filter*] <Hashtable> [-Force] [-Wait] [-Confirm] [-WhatIf] [<CommonParameters>]
Suspend-Job [-State*] {NotStarted | Running | Completed | Failed | Stopped | Blocked | Suspended | Disconnected |Suspending | Stopping | AtBreakpoint} [-Force] [-Wait] [-Confirm] [-WhatIf] [<CommonParameters>]
Suspend-Job [-InstanceId*] <Guid[]> [-Force] [-Wait] [-Confirm] [-WhatIf] [<CommonParameters>]
Suspend-Job [-Job*] <Job[]> [-Force] [-Wait] [-Confirm] [-WhatIf] [<CommonParameters>]
Suspend-Job [-Name*] <String[]> [-Force] [-Wait] [-Confirm] [-WhatIf] [<CommonParameters>]

The Suspend-Job cmdlet suspends workflow jobs. Suspend means to temporarily interrupt or pause a workflow job. This cmdlet allows users who are running workflows to suspend the workflow. It complements the Suspend-Workflow activity, which is a command in the workflow that suspends the workflow.

The Suspend-Job cmdlet works only on workflow jobs. It does not work on standard background jobs, such as those that are started by using the Start-Job cmdlet.

To identify a workflow job, look for a value of PSWorkflowJob in the PSJobTypeName property of the job. To determine whether a particular custom job type supports the Suspend-Job cmdlet, see the help topics for the custom job type.

When you suspend a workflow job, the workflow job runs to the next checkpoint, suspends, and immediately returns a workflow job object. To wait for the suspension to complete before getting the job, use the Wait parameter of Suspend-Job or the Wait-Job cmdlet. When the workflow job is suspended, the value of the State property of the job is Suspended.

Suspending correctly relies on checkpoints. The current job state, metadata, and output are saved in the checkpoint so the workflow job can be resumed without loss of state or data. If the workflow job does not have checkpoints, it cannot be suspended correctly. To add checkpoints to a workflow that you are running, use the PSPersist workflow common parameter. You can use the Force parameter to suspend any workflow job immediately and to suspend a workflow job that does not have checkpoints, but the action could cause loss of state and data.

Before you use a Job cmdlet on a custom job type, such as a workflow job (PSWorkflowJob) import the module that supports the custom job type, either by using the Import-Module cmdlet or using or using a cmdlet in the module.

This cmdlet was introduced in Windows PowerShell 3.0.

Parameters
-Filter <Hashtable>

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

Specifies a hash table of conditions. This cmdlet suspends jobs that satisfy all of the conditions. Enter a hash table where the keys are job properties and the values are job property values.

-Force [<SwitchParameter>]

Suspends the workflow job immediately. This action could cause a loss of state and data.

By default, Suspend-Job lets the workflow job run until the next checkpoint and then suspends it. You can also use this parameter to suspend workflow jobs that do not have checkpoints.

-Id <Int32[]>

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

Specifies the IDs of jobs that this cmdlet suspends.

The ID is an integer that uniquely identifies the job in the current session. It is easier to remember and to type than the instance ID, but it is unique only in the current session. You can type one or more IDs, separated by commas. To find the ID of a job, use the Get-Job cmdlet.

-InstanceId <Guid[]>

Specifies the instance IDs of jobs that this cmdlet suspends. The default is all jobs.

An instance ID is a GUID that uniquely identifies the job on the computer. To find the instance ID of a job, use Get-Job.

-Job <Job[]>

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

Specifies the workflow jobs that this cmdlet stops. Enter a variable that contains the workflow jobs or a command that gets the workflow jobs. You can also pipe workflow jobs to the Suspend-Job cmdlet.

-Name <String[]>

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

Specifies friendly names of jobs that this cmdlet suspends. Enter one or more workflow job names. Wildcard characters are supported.

-State <JobState>

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

Specifies a job state. This cmdlet stops only jobs in the specified state. The acceptable values for this parameter are:

— NotStarted — Running — Completed — Failed — Stopped — Blocked — Suspended — Disconnected — Suspending — Stopping

Suspend-Job suspends only workflow jobs in the Running state.

-Wait [<SwitchParameter>]

Indicates that this cmdlet suppresses the command prompt until the workflow job is in the suspended state. By default, Suspend-Job returns immediately, even if the workflow job is not yet in the suspended state.

The Wait parameter is equivalent to piping a Suspend-Job command to the Wait-Job cmdlet.

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

You can pipe all types of jobs to this cmdlet. However, if Suspend-Job gets a job of an unsupported type, it returns a terminating error.

Outputs

System.Management.Automation.Job

This cmdlet returns the jobs that it suspended.

Examples
  1. Suspend a workflow job by name:
    1. The first command creates the Get-SystemLog workflow:
      PS C:> Get-SystemLog -AsJob -JobName "Get-SystemLogJob"
      

      The workflow uses the CheckPoint-Workflow activity to define a checkpoint in the workflow. #Sample WorkflowWorkflow Get-SystemLog { $Events = Get-WinEvent -LogName System CheckPoint-Workflow InlineScript {\Server01ScriptsAnalyze-SystemEvents.ps1 -Events $Events} }

      The second command uses the AsJob parameter that is common to all workflows to run the Get-SystemLog workflow as a background job. The command uses the JobName workflow common parameter to specify a friendly name for the workflow job.

    2. The third command uses the Get-Job cmdlet to get the Get-SystemLogJob workflow job:
      PS C:> Get-Job -Name Get-SystemLogJob
      
         Id     Name              PSJobTypeName   State       HasMoreData     Location   Command
         --     ----              -------------   -----       -----------     --------   -------
         4      Get-SystemLogJob  PSWorkflowJob   Running     True            localhost   Get-SystemLog

      The output shows that the value of the PSJobTypeName property is PSWorkflowJob.

    3. The fourth command uses the Suspend-Job cmdlet to suspend the Get-SystemLogJob job:
      PS C:> Suspend-Job -Name Get-SystemLogJob
      
         Id     Name              PSJobTypeName   State       HasMoreData     Location   Command
         --     ----              -------------   -----       -----------     --------   -------
         4      Get-SystemLogJob  PSWorkflowJob   Suspended   True            localhost   Get-SystemLog

      The job runs to the checkpoint and then suspends.This example shows how to suspend a workflow job.

  2. Suspend and resume a workflow job:
    1. The first command suspends the LogWorkflowJob job.The command returns immediately:
      PS C:> Suspend-Job -Name LogWorkflowJob
      
         Id     Name          PSJobTypeName      State         HasMoreData     Location             Command
         --     ----          -------------      -----         -----------     --------             -------
         67     LogflowJob    PSWorkflowJob      Running       True            localhost            LogWorkflow

      The output shows that the workflow job is still running, even though it is being suspended.

    2. The second command uses the Get-Job cmdlet to get the LogWorkflowJob job:
      PS C:> Get-Job -Name LogWorkflowJob
      
         Id     Name          PSJobTypeName      State         HasMoreData     Location             Command
         --     ----          -------------      -----         -----------     --------             -------
         67     LogflowJob    PSWorkflowJob      Suspended     True            localhost            LogWorkflow

      The output shows that the workflow job suspended successfully.

    3. The third command uses the Get-Job cmdlet to get the LogWorkflowJob job and the Resume-Job cmdlet to resume it:
      PS C:> Get-Job -Name LogWorkflowJob | Resume-Job
      
         Id     Name          PSJobTypeName      State         HasMoreData     Location             Command
         --     ----          -------------      -----         -----------     --------             -------
         67     LogflowJob    PSWorkflowJob      Running       True            localhost            LogWorkflow

      The output shows that the workflow job resumed successfully and is now running.This example shows how to suspend and resume a workflow job.

  3. Suspend a workflow job on a remote computer:
    PS C:> Invoke-Command -ComputerName Srv01 -Scriptblock {Suspend-Job -Filter @{CustomID="031589"}
    

    This command uses the Invoke-Command cmdlet to suspend a workflow job on the Srv01 remote computer. The value of the Filter parameter is a hash table that specifies a CustomID value. This CustomID is job metadata (PSPrivateMetadata).

  4. Wait for the workflow job to suspend:
    PS C:> Suspend-Job VersionCheck -Wait
    
       Id     Name          PSJobTypeName      State         HasMoreData     Location             Command
       --     ----          -------------      -----         -----------     --------             -------
        5     VersionCheck  PSWorkflowJob      Suspended     True            localhost            LogWorkflow

    This command suspends the VersionCheck workflow job. The command uses the Wait parameter to wait until the workflow job is suspended. When the workflow job runs to the next checkpoint and is suspended, the command finishes and returns the job object.

  5. Force a workflow job to suspend:
    PS C:> Suspend-Job Maintenance -Force
    

    This command suspends the Maintenance workflow job forcibly. The Maintenance job does not have checkpoints. It cannot be suspended correctly and might not resume correctly.

Additional Notes
 The mechanism and location for saving a suspended job might vary depending on the job type. For example, 
 suspended workflow jobs are saved in a flat file store by default, but can also be saved in a database.
 If you submit a workflow job that is not in the Running state, Suspend-Job displays a warning message. To 
 suppress the warning, use the WarningAction common parameter with a value of SilentlyContinue.

 If a job is not of a type that supports suspending, Suspend-Job returns a terminating error.
 To find the workflow jobs that are suspended, including those that were suspended by this cmdlet, use the 
 State parameter of the Get-Job cmdlet to get workflow jobs in the Suspended state.
 Some job types have options or properties that prevent Windows PowerShell from suspending the job. If attempts 
 to suspend the job fail, verify that the job options and properties allow for suspending.
Related Links

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