Stop-VBOCopyJob

Short Description

Stops running backup copy jobs.

Syntax

Stop-VBOCopyJob -Job <VBOCopyJob> [-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet stops a running backup copy job.

Parameters

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

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies a backup copy job that you want to stop.

Accepts the VBOCopyJob object.

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

True

Named

True (ByValue)

RunAsync

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

Default: False

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.

Example

Stopping Backup Copy Job

This example shows how to stop the backup copy job.

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

$copyjob = Get-VBOCopyJob -BackupJob $job

Stop-VBOCopyJob -Job $copyjob

Perform the following steps:

Run the Get-VBOJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Get-VBOCopyJob cmdlet. Set the $job variable as the BackupJob parameter value. Save the result to the $copyjob variable.
Run the Stop-VBOCopyJob cmdlet. Set the $copyjob variable as the Job parameter value.

Related Commands