Remove-VBRBackupRepository

Short Description

Removes a backup repository from the backup infrastructure.

Note

If the four-eyes authorization is enabled, you cannot run this cmdlet. For more information, see the Four-Eyes Authorization section in the User Guide for VMware vSphere.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRBackupRepository -Repository <CBackupRepository[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet allows you to remove a backup repository from the backup infrastructure.

When you remove a backup repository, Veeam Backup & Replication unassigns the repository role from the server, so it is no longer used as a backup destination. The actual server remains added to the backup infrastructure.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Repository	Specifies an array of backup repositories you want to remove.	Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.	True	Named	True (ByValue, ByProperty Name)
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. 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

Repository

Specifies an array of backup repositories you want to remove.

Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

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.

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

None.

Examples

Remove-VBRBackupRepository Example 1. Removing Backup Repository [Using Variable]

This example shows how to remove the backup repository named Local Repository 01.

$repository = Get-VBRBackupRepository -Name "Local Repository 01"

Remove-VBRBackupRepository -Repository $repository

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the Remove-VBRBackupRepository cmdlet. Set the $repository variable as the Repository parameter value.

Remove-VBRBackupRepository Example 2. Removing Backup Repository [Using Pipeline]

This example shows how to remove the backup repository named Local Repository 01.

Get-VBRBackupRepository -Name "Local Repository 01" | Remove-VBRBackupRepository

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Remove-VBRBackupRepository cmdlet.

Related Commands

Get-VBRBackupRepository