Remove-VBRJob

Short Description

Removes a selected backup, replication or backup copy job.

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRJob [-Job] <CBackupJob[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes a selected backup, replication or tape job from Veeam Backup & Replication console and database.

Run the Remove-VBRBackupCopyJob cmdlet to remove backup copy jobs.

Run the Remove-VSBJob cmdlet to remove SureBackup jobs.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies the array of jobs you want to remove. Accepts the `CBackupJob` object. To get this object, run the `Get-VBRJob` or `Get-VBRTapeJob` cmdlet.	`CBackupJob[]`	True	0	True (ByPropertyName, ByValue)
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
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

<CommonParameters>

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

Examples

Remove-VBRJob Example 1. Removing File Copy Jobs [Using Pipeline]

This example shows how to remove the file copy jobs.

Get-VBRJob -Name "File Copy*" | Remove-VBRJob

Perform the following steps:

Remove-VBRJob Example 2. Removing Specific Job [Using Variable]

This example shows how to remove the job represented by the $job variable.

$job = Get-VBRJob -Name "Backup Job"

Remove-VBRJob -Job $job

Perform the following steps:

Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Remove-VBRJob cmdlet. Set the $job variable as the Job parameter value.