Start-VBRDownloadBackupFile

In this article

    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

    This cmdlet provides the following parameter sets.

    • To download full backup files.

    Start-VBRDownloadBackupFile -BackupFile <VBRBackupFile[]> [-ThisBackup [<SwitchParameter>]] [-RunAsync[<SwitchParameter>]] [<CommonParameters>]

    • To download full backup files and increments that are related to these backup files.

    Start-VBRDownloadBackupFile -BackupFile <VBRBackupFile[]> [-ThisBackupAndIncrements [<SwitchParameter>]][-RunAsync [<SwitchParameter>]] [<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

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    BackupFile

    Specifies an array of backup files that you want to download.

    Accepts the CStorage type.

    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.

    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.

    False

    Named

    False

     

    RunAsync

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

    False

    Named

    False

     

    <CommonParameters>

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

    Example 1

    This example shows how to download a full backup file from the capacity tier.

    1. Run Get-VBRBackup to get a backup. Save the result to the $backup variable.
    2. Run Get-VBRBackupFile with the $backup variable to get backup files. Save the result to the $files variable.
    3. Run Start-VBRDownloadBackupFile with the $files variable.

    $backup = Get-VBRBackup -Name "Exchange backups"

    $files = Get-VBRBackupFile -Backup $backup

    Start-VBRDownloadBackupFile -BackupFile $files -ThisBackup

    Example 2

    This example shows how to download a full backup file with all increments related to it from the capacity tier.

    1. Run Get-VBRBackup to get a backup. Save the result to the $backup variable.
    2. Run Get-VBRBackupFile with the $backup variable to get the backup files. Save the result to the $files variable.
    3. Run Start-VBRDownloadBackupFile with the $files variable.

    $backup = Get-VBRBackup -Name "Exchange backups"

    $files = Get-VBRBackupFile -Backup $backup

    Start-VBRDownloadBackupFile -BackupFile $files -ThisBackupAndIncrements

    Related Commands