Start-VBRArchiveTierSync
Short Description
Starts the archiving job.
Applies to
Product Edition: Enterprise Plus, Veeam Universal License
Syntax
Start-VBRArchiveTierSync -Repository <VBRScaleOutBackupRepository> [-RunAsync] [<CommonParameters>] |
Detailed Description
This cmdlet starts the archiving job that moves data from the capacity tier to the archive tier.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Repository | Specifies a scale-out backup repository. The cmdlet will return the performance extents added to this repository. | Accepts the VBRScaleOutBackupRepository object. To create this object, run the Get-VBRBackupRepository cmdlet. | True | Named | True (ByValue, |
RunAsync | Defines 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 Microsoft Docs.
Output Object
The cmdlet returns the VBRArchiveTierSync object that contains details on the archiving job.
Examples
Starting Archiving Job
This example shows how to start an archiving job.
$repository = Get-VBRBackupRepository -ScaleOut Start-VBRArchiveTierSync -Repository $repository |
Perform the following steps:
- Run the Get-VBRBackupRepository cmdlet. Provide the ScaleOut parameter. Save the result to the $repository variable.
- Run the Start-VBRArchiveTierSync cmdlet. Set the $repository variable as the Repository parameter value.
Related Commands