Set-VBRTapeLibrary

Short Description

Modifies a tape library.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Set-VBRTapeLibrary -TapeLibrary <VBRTapeLibrary> -Name <string> [-PassThru] [<CommonParameters>]

Detailed Description

This cmdlet modifies the name of the selected tape library.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
TapeLibrary	Specifies the tape library you want to modify.	Accepts the VBRTapeLibrary object. To get this object, run the Get-VBRTapeLibrary cmdlet.	True	Named	True (ByValue, ByProperty Name)
Name	Specifies the new name you want to assign to the library.	String	False	Named	False
PassThru	Defines that the command returns the output object to the Windows PowerShell console.	SwitchParameter	False	Named	False

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

Output Object

VBRTapeLibrary

Examples

Set-VBRTapeLibrary Example 1. Modifying Tape Library Name [Using Pipeline]

This example shows how to modify the name of the tape library named HP MSL G3 Series 3.00 to New York Remote Tape.

Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | Set-VBRTapeLibrary -Name "New York Remote Tape" -PassThru

Drives : {Tape0, Tape1}
Enabled : True
Model : MSL G3 Series
Slots : 24
TapeServerId : 00000000-0000-0000-0000-000000000000
Type : Automated
State : Online
Id : 2f1fdc3c-8a97-4fa0-b631-74a039e64d5c
Name : New York Remote Tape
Description : New York office Tape Library

Perform the following steps:

Run the Get-VBRTapeLibrary cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Set-VBRTapeLibrary cmdlet. Specify the Name parameter value. Provide the PassThru parameter.

Set-VBRTapeLibrary Example 2. Modifying Tape Library Name [Using Variable]

This example shows how to modify the name of the US Remote Tape tape library.

$tapelibrary = Get-VBRTapeLibrary -Name "US Remote Tape"

Set-VBRTapeLibrary -TapeLibrary $tapelibrary -Name "New York Remote Tape"

Perform the following steps:

Run the Get-VBRTapeLibrary cmdlet. Specify the Name parameter value. Save the result to the $tapelibrary variable.
Run the Set-VBRTapeLibrary cmdlet. Set the $tapelibrary variable as the TapeLibrary parameter values. Specify the Name parameter value.

Related Commands

Get-VBRTapeLibrary