Set-VBRTapeLibrary

In this article

    Short Description

    Modifies 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

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    TapeLibrary

    Specifies the tape library you want  to modify.

    Accepts VBRTapeLibrary type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Name

    Specifies the new name you want to assign to the library.

    False

    Named

    False

    False

    PassThru

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

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    VBRTapeLibrary

    Example 1

    This command modifies the name of the tape library named 'HP MSL G3 Series 3.00' to 'New York Remote Tape'. The library object is obtained with Get-VBRTapeLibrary and piped down. The PassThru parameter is set to get the output and view the details.

    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

    Example 2

    This command modifies the name of the tape library represented by the $tapelibrary variable. The tape library object is obtained by running Get-VBRTapeLibrary and assigned to the variable beforehand.

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

    Related Commands

    Get-VBRTapeLibrary

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.