This is an archive version of the document. To get the most up-to-date information, see the current version.

Stop-VBOJob

Short Description

Stops a running backup job.

Syntax

Stop-VBOJob -Job <VBOJob> [-RunAsync [<SwitchParameter>]]  [<CommonParameters>]

Detailed Description

This cmdlet stops a running backup job.

Parameters

Parameter

Description

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Job

Specifies the backup job you want to stop.

True

Named

True (ByValue)

False

RunAsync

Indicates that the command returns immediately without waiting for the task to complete.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Example 1

This example shows how to stop the backup job.

  1. Run the Get-VBOJob cmdlet to get the backup job you want to stop. Save the result to the $job variable.
  2. Run the Stop-VBOJob cmdlet with the $job variable.

$job = Get-VBOJob -Name "ABC Backup"

Stop-VBOJob -Job $job

Related Commands

Get-VBOJob