Start-VBRCapacityTierSync

In this article

    Short Description

    Starts to synchronize data stored on the performance tier with the data on capacity tier.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Start-VBRCapacityTierSync -Repository <VBRScaleOutBackupRepository> [-ApproximateOffloadSizeGB <Int64>] [-RunAsync <SwitchParameter>] [<CommonParameters>]

    Detailed Description

    This cmdlet starts to sync data stored on the performance tier with the data on capacity tier.

    Start-VBRCapacityTierSync Important!

    Mind the following:

    • You cannot sync data with capacity tier if the performance extents are set to the maintenance mode.
    • Run Disable-VBRCapacityExtentMaintenanceMode to disable the maintenance mode for the necessary performance extent.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Repository

    Specifies a scale-out backup repository. The cmdlet will return the performance extents added to this repository.

    Accepts the VBRScaleOutBackupRepository type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    ApproximateOffloadSizeGB

    Specifies an approximate size of data that you want to sync with the capacity tier.

    False

    Named

    True (ByPropertyName)

    False

    RunAsync

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

    False

    Named

    False

    False

    <CommonParameters>

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

    Example

    This example shows how to start data sync data on capacity tier.

    1. Run Get-VBRBackupRepository with the ScaleOut parameter to get the scale-out repository with the capacity tier option enabled. Save the result to the $repository variable.
    2. Run Start-VBRCapacityTierSync with the $repository variable.

    $repository = Get-VBRBackupRepository -ScaleOut

    Start-VBRCapacityTierSync -Repository $repository

    Related Commands

    Get-VBRBackupRepository