Set-VBRTapeServer

Short Description

Modifies tape servers.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Set-VBRTapeServer -TapeServer <VBRTapeServer> [-Description <string>] [-PassThru]  [<CommonParameters>]

Detailed Description

This cmdlet modifies tape server that was created before.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameters values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

TapeServer

Specifies the tape server you want to modify.

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

True

Named

True (ByValue,
ByProperty
Name)

Description

Specifies the new description you want to apply to the tape server.

String

False

Named

False

PassThru

Defines that the command returns the output object to the Windows PowerShell console.

SwitchParameter

False

Named

False

<CommonParameters>

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

Output Object

VBRTapeServer

Examples

Set-VBRTapeServerExample 1. Modifying Description of Tape Server [Using Variable]

This example shows how to modify the description of the Sydney_Tape_Server tape server.

$tapeserver = Get-VBRTapeServer -Name "Sydney_Tape_Server"

Set-VBRTapeServer -TapeServer $tapeserver -Description "Sydney_Remote_Tape_Server"

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $tapeserver variable.
  2. Run the Set-VBRTapeServer cmdlet. Set the $tapeserver variable as the TapeServer parameter value. Specify the Description parameter value.

Set-VBRTapeServerExample 2. Modifying Description of Tape Server [Using Pipeline]

This example shows how to modify the description of the Sydney_Tape_Server tape server.

Get-VBRTapeServer -Name "Sydney_Tape_Server" | Set-VBRTapeServer -Description "Sydney_Remote_Tape_Server" -PassThru

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Set-VBRTapeServer cmdlet. Specify the Description parameter value. Provide the PassThru parameter.

Related Commands

Get-VBRTapeServer