This is an archive version of the document. To get the most up-to-date information, see the current version.

Start-VBRTapeCatalog

Short Description

Starts tape catalog process.

Applies to

Platform: VMware, Hyper-V

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

Syntax

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

-OR-

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.

You can run catalog job for selected libraries or for selected tapes.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Library	Specifies the array of tape libraries. The cmdlet will catalog these tape libraries. Accepts VBRTapeLibrary, GUID or string type.	True	Named	True (ByValue, ByProperty Name)	False
Medium	Specifies the array of tapes. The cmdlet will catalog these tapes. Accepts VBRTapeMedium, GUID or string type.	True	Named	True (ByValue, ByProperty Name)	False
Wait	Indicates that the command waits for the process to complete before accepting more input.	False	Named	False	False

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Library

Specifies the array of tape libraries. The cmdlet will catalog these tape libraries.

Accepts VBRTapeLibrary, GUID or string type.

True

Named

True (ByValue,
ByProperty
Name)

False

Medium

Specifies the array of tapes. The cmdlet will catalog these tapes.

Accepts VBRTapeMedium, GUID or string type.

True

Named

True (ByValue,
ByProperty
Name)

False

Wait

Indicates that the command waits for the process to complete before accepting more input.

False

Named

False

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

Return Type

VBRBackupSession

Example 1

This example shows how to catalog a selected library.

Run Get-VBRTapeLibrary to get the library. Pipe it to Start-VBRTapeCatalog.

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

Example 2

This example shows how to catalog selected tapes.