Stop-VBRComputerBackupJob

Short Description

Stops Veeam Agent backup jobs and Veeam Agent backup policies.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Stop-VBRComputerBackupJob [-Job] <VBRComputerBackupJob[]> [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet stops Veeam Agent backup jobs and Veeam Agent backup policies.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies a Veeam Agent backup job or a Veeam Agent backup policy that you want to stop.

Accepts the VBRComputerBackupJob[] object. To get this object, run the Get-VBRComputerBackupJob cmdlet.

True

0

True (ByValue, ByPropertyName)

RunAsync

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

SwitchParameter

False

Named

False

WhatIf

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

SwitchParameter

False

Named

False

Confirm

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

SwitchParameter

False

Named

False

<CommonParameters>

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

Examples

Stopping Veeam Agent Backup Jobs

This example shows how to stop the Veeam Agent backup job.

$job = Get-VBRComputerBackupJob -Name "WinSrv2049"

Stop-VBRComputerBackupJob -Job $job

Perform the following steps:

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

Related Commands

Get-VBRComputerBackupJob

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.