Get-VBRTapeLibrary

In this article

    Short Description

    Returns tape libraries.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Get-VBRTapeLibrary [-TapeServer <VBRTapeServer[]>] [<CommonParameters>]

    -OR-

    Get-VBRTapeLibrary [-TapeServer <VBRTapeServer[]>] [-Id <guid[]>] [<CommonParameters>]

    -OR-

    Get-VBRTapeLibrary [-TapeServer <VBRTapeServer[]>] [-Name <string[]>] [<CommonParameters>]

    Detailed Description

    This cmdlet returns tape libraries connected to Veeam Backup & Replication.

    You can get the list of all tape libraries, narrow down your search to particular tape servers or search for instances directly by name or ID.

    Note that tape libraries are added to Veeam Backup & Replication automatically when you add tape server with connected library. Run Add-VBRTapeServer to add tape server.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    TapeServer

    Specifies the array of tape servers. The cmdlet will return tape libraries connected to these tape servers.

    Accepts VBRTapeServer, GUID or string type.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Name

    Specifies the array of tape library names. The cmdlet will return tape libraries with these names.

    False

    Named

    False

    True

    Id

    Specifies the array of tape library IDs. The cmdlet will return tape libraries with these IDs.

    Accepts GUID or string type.

    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 gets a list of all tape libraries connected to Veeam Backup & Replication.

    Get-VBRTapeLibrary

    Example 2

    This command looks for all tape libraries connected to the tape server named 'Sydney_Tape_Server'. The tape server is obtained with Get-VBRTapeServer and piped down.

    Get-VBRTapeServer -Name "Sydney_Tape_Server" | Get-VBRTapeLibrary

    Related Commands

    Get-VBRTapeServer

    I want to report a typo

    There is a misspelling right here:

     

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