Sync-VBRNASBackupMetadata

In this article

    Short Description

    Downloads metadata of backup files from with the long-term backup repository.

    Applies to

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

    Syntax

    Sync-VBRNASBackupMetadata -SourceBackup <VBRNASBackup> -TargetRepository <CBackupRepository> [-RunAsync][<CommonParameters>]

    Detailed Description

    This cmdlet downloads metadata of backup files from the long-term backup repository to the short-term repository. You can use this cmdlet to restore backup files that are located on the long-term repository but are no longer available on the short-term repository.

    Sync-VBRNASBackupMetadata Important!

    Before downloading metadata from the long-term repository, you must run the Sync-VBRBackupRepository cmdlet to rescan this repository.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    SourceBackup

    Specifies a backup file. The cmdlet will download metadata of this backup file from the long-term repository.

    Accepts the VBRN ASBackup object. To get this object, run the Get-VBRNASBackupcmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

     

    TargetRepository

    Specifies the short-term backup repository. The cmdlet will download metadata of backup files to the specified short-term backup repository.

    Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

    True

    Named

    False

     

    RunAsync

    Indicates that the command returns immediately without waiting for the task to complete.

    SwitchParameter

    False

    Named

    False

     

    <CommonParameters>

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

    Example

    Downloading Metadata to Short-term Repository

    This example shows how to download data from the long-term repository to the short-term repository.

    $backup = Get-VBRNASBackup

    $repository = Get-VBRBackupRepository

    Sync-VBRNASBackupMetadata -SourceBackup $backup -TargetRepository $repository

    Perform the following steps:

    1. Run the Get-VBRNASBackup cmdlet. Save the result to the $backup variable.
    2. Run the Get-VBRBackupRepository cmdlet. Save the result to the $repository variable.
    3. Run the Sync-VBRNASBackupMetadata cmdlet. Set the $backup variable as the SourceBackup parameter value. Set the $repository as the TargetRepository parameter value.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

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