Loading...

Stop-CVJob

This cmdlet stops a job identified by a job ID.

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

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

Required Parameters

-JobId

The job id for the job you want to use.

  • Type: Int32
  • Required: True
  • Aliases: None
  • Default value: 0
  • Accepts pipeline input: False
  • Accepts wildcard characters: False
  • Position: 1

Optional 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 message that indicates whether the job stop was successful.

Example

The following example stops job 78.

Stop-CVJob -JobId 78

Last modified: 3/6/2020 9:32:33 PM