Get-VBRTapeLibrary

Short Description

Returns tape libraries.

Applies to

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get all tape libraries connected to a tape server.

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

  • Get a tape library by ID.

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

  • Get a tape library by name.

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

Tape libraries are added to Veeam Backup & Replication automatically when you add a tape server with connected library. Run the Add-VBRTapeServer cmdlet to add a tape server.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

TapeServer

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

Accepts the VBRTapeServer[] object, GUID or string type. To get this object, run the Get-VBRTapeServer cmdlet.

False

Named

True (ByValue,
ByProperty
Name)

Name

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

String

False

Named

False

Id

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

Accepts GUID or string.

False

Named

False

<CommonParameters>

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

Output Object

VBRTapeLibrary[]

Examples

Get-VBRTapeLibraryExample 1. Getting All Tape Libraries

This command gets a list of all tape libraries connected to Veeam Backup & Replication.

Get-VBRTapeLibrary

Get-VBRTapeLibraryExample 2. Getting All Tape Libraries Connected to Tape Server [Using Pipeline]

This command looks for all tape libraries connected to the tape server named Sydney_Tape_Server.

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

Perform the following steps:

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

Related Commands

Get-VBRTapeServer

Page updated 4/10/2024

Page content applies to build 12.2.0.334