Remove-VBRNASBackupJob

Short Description

Removes file backup jobs from Veeam Backup & Replication infrastructure.

Applies to

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

Syntax

Remove-VBRNASBackupJob -Job <VBRNASBackupJob[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes file backup jobs from Veeam Backup & Replication infrastructure.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies a file backup job. The cmdlet will remove this job from the Veeam Backup & Replication infrastructure.	Accepts the VBRNASBackupJob[] object. To get this object, run the Get-VBRNASBackupJob cmdlet.	True	Named	True (ByValue, ByPropertyName)
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 he wants 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

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies a file backup job. The cmdlet will remove this job from the Veeam Backup & Replication infrastructure.

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

True

Named

True (ByValue, ByPropertyName)

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 he wants 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

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

Output Object

The cmdlet returns the VBRNASBackupJob object that contains settings of file backup jobs.

Examples

Remove-VBRNASBackupJob) Example 1. Removing All File Backup Jobs

This example shows how to remove all file backup jobs from the Veeam Backup & Replication infrastructure.

$job = Get-VBRNASBackupJob

Remove-VBRNASBackupJob -Job $job

Perform the following steps:

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

Remove-VBRNASBackupJob) Example 2. Removing File Backup Jobs by Name

This example shows how to remove the SMB Job file backup jobs.

$job = Get-VBRNASBackupJob -Name "SMB Job"

Remove-VBRNASBackupJob -Job $job

Perform the following steps:

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

Related Commands

Get-VBRNASBackupJob