Remove-VBRTapeMediaPool

Short Description

Removes a media pool.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRTapeMediaPool -MediaPool <VBRTapeMediaPool[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes a selected media pool from Veeam Backup & Replication.

Remove-VBRTapeMediaPool Important!

Removing media pools has the following restrictions:

You can only delete custom media pools; predefined media pools cannot be deleted.
You cannot delete a media pool that contains tapes. To be able to delete such a pool, first move tapes from this pool to other media pools.
You cannot delete media pools used by an existing backup/files to tape copy job. In case you definitely have to disable this pool, you should first modify the corresponding job to target another media pool.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
MediaPool	Specifies the array of media pools. The cmdlet will remove these media pools.	Accepts the VBRTapeMediaPool object, GUID or string. To get this object, run the Get-VBRTapeMediaPool 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

MediaPool

Specifies the array of media pools. The cmdlet will remove these media pools.

Accepts the VBRTapeMediaPool object, GUID or string. To get this object, run the Get-VBRTapeMediaPool 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-VBRTapeMediaPool Example 1. Removing Media Pool [Using Pipeline]

This example shows how to remove the media pool named Winserver MediaPool.

Get-VBRTapeMediaPool -Name "Winserver MediaPool" | Remove-VBRTapeMediaPool

Perform the following steps:

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

Remove-VBRTapeMediaPool Example 2. Removing Media Pool [Using Variable]

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

$pool = Get-VBRTapeMediaPool -Name "Winserver MediaPool"

Remove-VBRTapeMediaPool -MediaPool $pool

Perform the following steps:

Run the Get-VBRTapeMediaPool cmdlet. Specify the Name parameter value. Save the result to the $pool variable.
Run the Remove-VBRTapeMediaPool cmdlet. Set the $pool variable as the MediaPool parameter value.

Related Commands

Get-VBRTapeMediaPool