Sync-VBRUnstructuredBackupMetadata
Short Description
Downloads metadata of backup files from the long-term backup repository.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
|
Sync-VBRUnstructuredBackupMetadata [-Force] [-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>] [-RunAsync] -SourceBackup <VBRUnstructuredBackup> -TargetRepository <CBackupRepository> [<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.
|
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 |
|---|---|---|---|---|---|
|
SourceBackup |
Specifies a backup file. The cmdlet will download metadata of this backup file from the long-term repository. |
Accepts the VBRUnstructuredBackup object. To get this object, run the Get-VBRUnstructuredBackup cmdlet. |
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 |
Defines that the command returns immediately without waiting for the task to complete. |
SwitchParameter |
False |
Named |
False |
|
RetrievalSettings |
Specifies the retrieval policy settings. The cmdlet will use these settings to retrieve data from archive repositories. Note: If you do not provide this parameter, the cmdlet will prompt you to use the default retrieval policy settings. |
Accepts the VBRUnstructuredBackupColdStorageRetrievalSettings object. To create this object, run the New-VBRUnstructuredBackupColdStorageRetrievalSettings cmdlet. |
False |
Named |
False |
|
Force |
Defines that the cmdlet will download metadata of backup files from the long-term backup repository without showing warnings in the PowerShell console. |
SwitchParameter |
False |
Named |
False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
None.
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-VBRUnstructuredBackup $repository = Get-VBRBackupRepository Sync-VBRUnstructuredBackupMetadata -SourceBackup $backup -TargetRepository $repository |
Perform the following steps:
- Run the Get-VBRUnstructuredBackup cmdlet. Save the result to the $backup variable.
- Run the Get-VBRBackupRepository cmdlet. Save the result to the $repository variable.
- Run the Sync-VBRUnstructuredBackupMetadata cmdlet. Set the $backup variable as the SourceBackup parameter value. Set the $repository as the TargetRepository parameter value.
Related Commands