Loading...

Suspend-CVJob

The Suspend-CVJob cmdlet suspends a running workflow job.

Before you can use this cmdlet, you must log on to your CommCell environment using the Connect-CVServer cmdlet. For more information, see Connecting to a CommCell Environment with PowerShell.

Syntax

Suspend-CVJob [-JobId] <Int32> [<CommonParameters>]

Required Parameters

Parameter

Description

Data type

Values

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

-JobId

The ID of the job.

Int32

The default value is 0.

No

No

Positional: 1

Optional Parameters

Microsoft PowerShell Parameters

You can use the following Microsoft PowerShell parameters:

  • Debug
  • ErrorAction
  • ErrorVariable
  • OutBuffer
  • OutVariable
  • PipelineVariable
  • Verbose
  • WarningAction
  • WarningVariable
  • Force
  • Confirm
  • WhatIf

Note: Only a few cmdlets support Force, Confirm, and WhatIf parameters.

For more information, see "About Common Parameters" in the Microsoft PowerShell documentation.

Input

This cmdlet does not support input.

Output

A PSCustomObject that indicates whether the job suspension was successful.

Example

The following example suspends job 100.

Suspend-CVJob -JobId 100

Last modified: 3/18/2020 8:33:44 AM