Remove-VBRTapeServer

Short Description

Removes a specified tape server from the backup infrastructure.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRTapeServer -TapeServer <VBRTapeServer[]> [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet removes a specified tape server from Veeam Backup & Replication.

When you remove a tape server, Veeam Backup & Replication unassigns the tape server role from the server, so it is no longer used as a tape server. The actual server remains connected to Veeam Backup & Replication.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

TapeServer

Specifies the array of tape servers. The cmdlet will remove these tape servers.

Accepts the VBRTapeServer[] object. To get this object, run the Get-VBRTapeServer 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

<CommonParameters>

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

Output Object

None.

Examples

Remove-VBRTapeServerExample 1. Removing Tape Server [Using Pipeline]

This example shows how to remove a tape server named Sydney_Tape_Server.

Get-VBRTapeServer -Name "Sydney_Tape_Server" | Remove-VBRTapeServer

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Remove-VBRTapeServer cmdlet.

Remove-VBRTapeServerExample 2. Removing Tape Server [Using Variable]

This example shows how to remove Sydney_Tape_Server and NewYork_Tape_Server tape servers.

$SydneyTapeServer = Get-VBRTapeServer -Name "Sydney_Tape_Server"

$NewYorkTapeServer = Get-VBRTapeServer -Name "NewYork_Tape_Server"

Remove-VBRTapeServer -TapeServer $SydneyTapeServer, $NewYorkTapeServer

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $SydneyTapeServer variable.
  2. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $NewYorkTapeServer variable.
  3. Run the Remove-VBRTapeServer cmdlet. Set the $SydneyTapeServer and $NewYorkTapeServer variables as the Server parameter values.

Related Commands

Get-VBRTapeServer

Page updated 5/7/2024

Page content applies to build 12.3.0.310