Remove-VBRExternalRepository

Short Description

Removes external repositories 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.

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRExternalRepository -ExternalRepository <VBRExternalRepository>

[-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes external repositories from the backup infrastructure. You can remove the following types of external repositories:

Amazon S3 object storage.
Microsoft Azure object storage.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ExternalRepository	Specifies the external repository that you want to remove. Accepts the `VBRExternalRepository` object. To get this object, run the `Get-VBRExternalRepository` cmdlet.	`VBRExternalRepository`	True	Named	True (ByValue)
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
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

<CommonParameters>

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

Examples

Removing External Repository

This example shows how to remove an external repository named External Repository from the backup infrastructure.

$repository = Get-VBRExternalRepository -Name "External repository"

Remove-VBRExternalRepository -ExternalRepository $repository

Perform the following steps:

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

Get-VBRExternalRepository