Remove-VBRTapeVault

Short Description

Removes a specified tape vault from the backup infrastructure.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Remove-VBRTapeVault -Vault <VBRTapeVault[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes a specified tape vault from the backup infrastructure.

When you remove a vault, you do not remove the tapes stored in it.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Vault	Specifies the array of vaults. The cmdlet will remove these vaults.	Accepts the VBRTapeVault[] object. To get this object, run the Get-VBRTapeVault cmdlet.	True	Named	True (ByValue, ByProperty Name)
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 you want to continue running the command. 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

Vault

Specifies the array of vaults. The cmdlet will remove these vaults.

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

True

Named

True (ByValue,
ByProperty
Name)

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 you want to continue running the command.

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-VBRTapeVault Example 1. Removing Tape Vault [Using Pipeline]

This command removes a tape vault named Sydney Remote Storage.

Get-VBRTapeVault -Name "Sydney Remote Storage" | Remove-VBRTapeVault

Perform the following steps:

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

Remove-VBRTapeVault Example 2. Removing Tape Vaults [Using Variable]

This example shows how to remove tape vaults Sydney Remote Storage and New York Remote Storage.

$SydneyRemoteStorage = Get-VBRTapeVault -Name "Sydney Remote Storage"

$NewYorkRemoteStorage = Get-VBRTapeVault -Name "New York Remote Storage"

Remove-VBRTapeVault -Vault $SydneyRemoteStorage, $NewYorkRemoteStorage

Perform the following steps:

Run the Get-VBRTapeVault cmdlet. Specify the Name parameter value. Save the result to the $SydneyRemoteStorage variable.
Run the Get-VBRTapeVault cmdlet. Specify the Name parameter value. Save the result to the $NewYorkRemoteStorage variable.
Run the Remove-VBRTapeMediaPool cmdlet. Set the $SydneyRemoteStorage and $NewYorkRemoteStorage variables as the Vault parameter values.

Related Commands

Get-VBRTapeVault