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

Start-VBROffloadBackupFile

Short Description

Moves backup files to object storage.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides the following parameter sets:

  • To move full backup files

Start-VBROffloadBackupFile -BackupFile <CStorage[]> [-ThisBackup] [-RunAsync]  [<CommonParameters>]

  • To move the specified backup files with all backup files related to it

Start-VBROffloadBackupFile -BackupFile <CStorage[]> [-ThisBackupAndIncrements] [-RunAsync]  [<CommonParameters>]

Detailed Description

This cmdlet starts to move backup files to object storage. You can use the following scenarios for moving the backup files:

  • Move full backup files only
  • Move full backup files with all increments
  • Move increment backup files with all other increments related to it and a 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 move to an object storage.

Accepts the CStorage type.

True

Named

True (ByValue)

 

ThisBackup

Indicates that the cmdlet will move only full backup files to an object storage.

False

Named

False

 

ThisBackupAndIncrements

Indicates that the cmdlet will move full backup files and all backup files that are related to it to an object storage.

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.

Return Type

Example 1

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

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

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

$full = Get-VBRBackupFile -Backup $backup

Start-VBROffloadBackupFile -BackupFile $files -ThisBackup

Example 2

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

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

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

$files = Get-VBRBackupFile -Backup $backup

Start-VBROffloadBackupFile -BackupFile $files -ThisBackupAndIncrements

Example 3

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

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

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

$files = Get-VBRBackupFile -Backup $backup

Start-VBROffloadBackupFile -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 Reference

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

Quick Start Guide for VMware vSphere

Quick Start Guide for Microsoft Hyper-V