Start-VBRCapacityTierSync

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.

Important

Consider 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

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

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

Examples

Start-VBRCapacityTierSync Example 1. Syncing Data Stored on Performance Tier With Data on Capacity Tier

This example shows how to start to sync data stored on the performance tier with the data on capacity tier.
We recommend to use this script if you have several scale-out repositories and would like to synchronize data on a specific repository. To specify the necessary repository, provide the ordinal number of the repository from the array.

$repository = Get-VBRBackupRepository -ScaleOut

Start-VBRCapacityTierSync -Repository $repository[1]

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the ScaleOut parameter. Save the result to the $repository variable.

Note: The Get-VBRBackupRepository cmdlet will return an array of scale-out repositories. Mind the ordinal number of the necessary repository (in our example, it is the second scale-out repository in the array).

Run the Start-VBRCapacityTierSync cmdlet. Set the Monthly option for the Type parameter value. Set the $repository variable as the Repository parameter value.

Start-VBRCapacityTierSync Example 2. Syncing Data Stored on Performance Tier With Data on Capacity Tier [Using Pipeline]

This example shows how to to sync data stored on the performance tier with the data on capacity tier. We recommend to use this script if you do not want to specify an ordinal number of a scale-out repository.

Get-VBRBackupRepository -ScaleOut | ForEach-Object {Start-VBRCapacityTierSync -Repository $_ -RunAsync}

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the ScaleOut parameter.
Pipe the cmdlet output to the ForEach-Object cmdlet. Set the $ value for the Repository. Provide the RunAsync parameter.

Related Commands