Stop-VBRJob

Short Description

Stops a running backup, replication or copy job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Stop-VBRJob -Job <CBackupJob[]> [-Gracefully] [-RunAsync] [-Confirm] [-WhatIf]  [<CommonParameters>]

Detailed Description

This cmdlet stops a running backup or replication job. The job is stopped once, the scheduled job will start the next scheduled time.

Run the Start-VBRJob cmdlet to start the job manually.

Run the Disable-VBRJob cmdlet to temporarily disable a job.

Run the Stop-VSBJob cmdlet to stop a SureBackup job.

Run the Stop-VBRComputerBackupJob cmdlet to stop Veeam Agent backup jobs and Veeam Agent backup policies.

Run the Stop-VBRBackupCopyJob cmdlet to stop a backup copy job.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Job

Specifies the array of jobs you want to stop.

Accepts the CBackupJob object. To create this object, run the Get-VBRJob cmdlet.

True

0

True (ByProperty
Name, ByValue)

RunAsync

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

SwitchParameter

False

Named

False

Gracefully

Defines that the cmdlet will stop a job gracefully.

SwitchParameter

False

Named

False

WhatIf

Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

Confirm

Defines that the cmdlet will display a prompt that asks if the user is sure that they want to continue.

Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Stop-VBRJobExample 1. Stopping Specific Job [Using Pipeline]

This example shows how to stop the SharePoint File Copy Job copy job.

Get-VBRJob -Name "SharePoint File Copy Job" | Stop-VBRJob

Perform the following steps:

  1. Run the Get-VBRJob cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Stop-VBRJob cmdlet.

Stop-VBRJobExample 2. Stopping Specific Job [Using Variable]

This example shows how to stop the copy job represented by the $SharePointFileCopyJob variable.

$SharePointFileCopyJob = Get-VBRJob -Name "SharePoint File Copy Job"

Stop-VBRJob -Job $SharePointFileCopyJob

Perform the following steps:

  1. Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $SharePointFileCopyJob variable.
  2. Run the Stop-VBRJob cmdlet. Set the $SharePointFileCopyJob variable as the Job parameter value.

Related Commands

Get-VBRJob

Page updated 6/11/2024

Page content applies to build 12.2.0.334