Start-VBRTapeCatalog

Short Description

Starts tape catalog process.

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

Syntax

This cmdlet provides the following parameter sets:

Library

Start-VBRTapeCatalog -Library <VBRTapeLibrary[]> [-Wait] [<CommonParameters>]
Medium

Start-VBRTapeCatalog -Medium <VBRTapeMedium[]> [-Wait] [<CommonParameters>]

Detailed Description

This cmdlet starts catalog process. Catalog process scans tape contents and registers tapes in the Veeam Backup & Replication database after which Veeam Backup & Replication is able to administrate tape allocation and consumption and track data written to tapes.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Library	Specifies the array of tape libraries. The cmdlet will catalog these tape libraries. Accepts the `VBRTapeLibrary[]` object, GUID or string. To get this object, run the `Get-VBRTapeLibrary` cmdlet.	`VBRTapeLibrary[]`	True	Named	True (ByPropertyName, ByValue)
Medium	Specifies the array of tapes. The cmdlet will catalog these tapes. Accepts the `VBRTapeMedium[]` object, GUID or string. To get this object, run the `Get-VBRTapeMedium` cmdlet.	`VBRTapeMedium[]`	True	Named	True (ByPropertyName, ByValue)
Wait	Defines that the command waits for the process to complete before accepting more input.	`SwitchParameter`	False	Named	False

<CommonParameters>

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

Output Object

VBRBackupSession

Examples

Start-VBRTapeCatalog Example 1. Cataloging Selected Library [Using Pipeline]

This example shows how to catalog a selected library.

Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | Start-VBRTapeCatalog

Perform the following steps:

Run the Get-VBRTapeLibrary cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Start-VBRTapeCatalog cmdlet.

Start-VBRTapeCatalog Example 2. Cataloging Selected Tapes [Using Variable]

This example shows how to catalog selected tapes.

$tape = Get-VBRTapeMedium -Name "00140009","00140010"

Start-VBRTapeCatalog -Medium $tape

Perform the following steps:

Run the Get-VBRTapeMedium cmdlet. Specify the Name parameter value. Save the result to the $tape variable.
Run the Start-VBRTapeCatalog cmdlet. Set the $tape variable as the Medium parameter value.