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 running backup jobs.

Syntax

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

Detailed Description

This cmdlet stops a running backup job.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Job	Specifies a backup job you want to stop.	Accepts the VBOJob object. To get this object, run the Get-VBOJob cmdlet.	True	Named	True (ByValue)	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	SwitchParameter	False	Named	False	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Job

Specifies a backup job you want to stop.

Accepts the VBOJob object.

To get this object, run the Get-VBOJob cmdlet.

True

Named

True (ByValue)

False

RunAsync

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

SwitchParameter

False

Named

False

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

Examples

Example 1. Stopping Backup Job

This example shows how to stop the backup job.

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

Stop-VBOJob -Job $job

Perform the following steps:

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

Related Commands

Get-VBOJob