Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

Start-VBRDownloadBackupFile

Short Description

Downloads backup files from object storage.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

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 object storage to your on-premise source extents. 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

Indicates that the cmdlet will download full backup files only.

False

Named

False

 

ThisBackupAndIncrements

Indicates that the cmdlet will download full backup files and all backup files that are related to it.

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

Example 1

This example shows how to download a full backup file from an object storage.

  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.

PS C:\PS> $backup = Get-VBRBackup -Name "Exchange backups"

PS C:\PS> $files = Get-VBRBackupFile -Backup $backup

PS C:\PS> Start-VBRDownloadBackupFile -BackupFile $files -ThisBackup

Example 2

This example shows how to download a full backup file with all increments related to it from an object storage.

  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 $repository variable.

PS C:\PS> $backup = Get-VBRBackupPS -Name "Exchange backups"

PS C:\PS> $files = Get-VBRBackupFile -Backup $backup

PS C:\PS> Start-VBRDownloadBackupFile -BackupFile $files -ThisBackupAndIncrements

Example 3

This example shows how to download incremental backup files with all backup files related to it from an object storage.

  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.

PS C:\PS> $backup = Get-VBRBackupPS -Name "Exchange backups"

PS C:\PS> $files = Get-VBRBackupFile -Backup $backup

PS C:\PS> Start-VBRDownloadBackupFile -BackupFile $files -ThisBackupAndIncrements

Related Commands

Get-VBRBackup

Get-VBRBackupFile

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation