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

Start-VBRTapeCatalog

In this article

    Short Description

    Starts tape catalog process.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus

    Syntax

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

    -OR-

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

    Related Commands

    Get-VBRTapeLibrary

    Get-VBRTapeMedium

    Return Type

    VBRBackupSession

    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 tape library which you want to catalog.

    Accepts VBRTapeLibrary object, GUID or string type.

    You can assign multiple libraries to this object.

    True

    Named

    True (by Value
    FromPipeline,
    ValueFromPipeline
    ByPropertyName)

    False

    Medium

    Specifies the tape(s) you want to catalog.

    Accepts VBRTapeMedium object, GUID or string type.

    You can assign multiple tapes to this object.

    True

    Named

    True (by Value
    FromPipeline,
    ValueFromPipeline
    ByPropertyName)

    False

    Wait

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

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Example 1

    This example shows how to catalog a selected library.

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

    PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | Start-VBRTapeCatalog

    Example 2

    This example shows how to catalog selected tapes.

    1. Run Get-VBRTapeMedium to get the tapes and save them to the $tape variable.
    2. Run Start-VBRTapeCatalog with the $tape variable.

    PS C:\PS> $tape = Get-VBRTapeMedium -Name "00140009","00140010"

    PS C:\PS> Start-VBRTapeCatalog -Medium $tape