Start-VBROffloadBackupFile

In this article

    Short Description

    Moves backup files to the capacity tier.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    This cmdlet provides the following parameter sets:

    • To move full backup files to the capacity tier.

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

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

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

    Detailed Description

    This cmdlet starts to move backup files to the capacity tier. 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 the capacity tier.

    Accepts the CStorage type.

    True

    Named

    True (ByValue)

     

    ThisBackup

    Indicates that the cmdlet will move only full backup files to the capacity tier.

    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

    Indicates that the cmdlet will move full backup files and all backup files that are related to it to the capacity tier.

    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 move a full backup file to the capacity tier.

    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-VBRBackup -Name "Exchange backups"

    $files = 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 the capacity tier.

    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-VBRBackup -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 the capacity tier.

    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-VBRBackup -Name "Exchange backups"

    $files = Get-VBRBackupFile -Backup $backup

    Start-VBROffloadBackupFile -BackupFile $files -ThisBackupAndIncrements

    Related Commands