Loading...

Kill-CVJob

The Kill-CVJob cmdlet kills a running job in your CommCell environment.

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

Syntax

Kill-CVJob
   [-JobId] <String>
   [<CommonParameters>]

Required Parameters

-JobId

The job ID of the job you want to use for the cmdlet.

  • Type: String
  • Aliases: None
  • Default value: None
  • Accepts pipeline input: True (ByValue)
  • Accepts wildcard characters: False
  • Position: 1

Optional Parameters

<CommonParameters>

A collection of parameters that you can use with any cmdlet.

The following Microsoft PowerShell common parameters are supported:

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • PipelineVariable
  • OutVariable

For more information, see About CommonParameters in the Microsoft PowerShell documentation.

Inputs

None

This cmdlet does not support any inputs.

Outputs

None

This cmdlet does not return any outputs.

Examples

Example 2: Kill a Running Job

The following example kills a running job in your CommCell environment.

Kill-CVJob -JobId 1234

Last modified: 10/17/2019 3:51:07 PM