Start-VBRDownloadBackupFile
Short Description
Downloads backup files from the capacity tier to the performance tier.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Download full backup files.
Start-VBRDownloadBackupFile -BackupFile <VBRBackupFile[]> [-ThisBackup] [-RunAsync] [<CommonParameters>] |
- Download full backup files and increments that are related to these backup files.
Start-VBRDownloadBackupFile -BackupFile <VBRBackupFile[]> [-ThisBackupAndIncrements] [-RunAsync] [<CommonParameters>] |
Detailed Description
This cmdlet starts the rehydration procedure. Veeam Backup & Replication will download the backup files from the capacity tier to the performance tier. You can use the following scenarios for downloading the backup files:
- Download full backup files only.
- Download full backup files with all incremental backup files.
- Download the incremental backup files with all other increments related to it and the full backup file.
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
BackupFile | Specifies an array of backup files that you want to download. | Accepts the VBRBackupFile[] object. To create this object, run the Get-VBRBackupFile cmdlet. | True | Named | True (ByValue) |
ThisBackup | Defines that the cmdlet will download full backup files only. Note: This parameter is not applicable for the backups created with Veeam Plug-in for SAP HANA and Veeam Plug-in for Oracle RMAN. If you provide this parameter, the cmdlet will download full backup files. | SwitchParameter | False | Named | False |
ThisBackupAndIncrements | Defines that the cmdlet will download full backup files and all backup files that are related to it. Note: This parameter is not applicable for the backups created with Veeam Plug-in for SAP HANA and Veeam Plug-in for Oracle RMAN. If you provide this parameter, the cmdlet will download full backup files. | SwitchParameter | False | Named | False |
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
None.
Examples
Example 1. Downloading Full Backup File from Capacity Tier
Example 2. Downloading Full Backup File with all Increments
Related Commands
