Start-VBRCloudTapeRestore

In this article

    Short Description

    Starts a restore session of the tenant data from tape.

    Applies to

    Product Edition: Enterprise

    Requires Cloud Connect license

    Syntax

    This cmdlet provides the following parameter sets:

    • For restoring to original location

    Start-VBRCloudTapeRestore [-BackupObject] <VBRCloudTapeBackupObject[]> -PointInTime <datetime> [-Overwrite] [-RunAsync]  [<CommonParameters>]

    • For restoring to another cloud repository

    Start-VBRCloudTapeRestore [-BackupObject] <VBRCloudTapeBackupObject[]> -MappingTarget <VBRCloudTenantResource[]> -PointInTime <datetime> [-Overwrite] [-RunAsync]  [<CommonParameters>]

    • For exporting backup files to disk

    Start-VBRCloudTapeRestore [-BackupObject] <VBRCloudTapeBackupObject[]> -Server <CHost> -Path <string> -Credentials <CCredentials> -PointInTime <datetime> [-RunAsync]  [<CommonParameters>]

    Detailed Description

    Starts a restore session of the tenant data from tape.

    Run Stop-VBRCloudTapeRestore to stop the restore session.

    Start-VBRCloudTapeRestore Important!

    Mind the following:

    • Veeam Backup & Replication disables the tenant until the restore operation completes.
    • For the restore to another cloud repository scenario you must create a new cloud tenant resource beforehand. Run New-VBRCloudTenantResource to create the cloud tenant resource.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    BackupObject

    Specifies the tenant object that you want to restore. You can restore the following tenant objects:

    • Tenants
    • Tenants quotas
    • Tenants jobs

    Accepts the VBRCloudTapeBackupObject type.

    True

    0

    True (ByValue)

    False

    Credentials

    For export backup files to disk.

    Specifies credentials that Veeam Backup & Replication will use to connect to a server added to Veeam Backup & Replication infrastructure. Veeam Backup & Replication will restore tenant backups to the folder on this server.

    Accepts the CCredentials type.

    True

    Named

    False

    False

    MappingTarget

    For restore to another cloud repository.

    Specifies the target repository. The cmdlet will restore the backup to the specified location.

    Accepts the VBRCloudTenantResource type.

    True

    Named

    False

    False

    Path

    For exporting backup files to disk.

    Specifies the path to the folder.

    Veeam Backup & Replication will restore the files to the folder specified in the path.

    True

    Named

    False

    False

    PointInTime

    Specifies the point in time. The cmdlet will select the restore point that is the closest to the selected point in time.

    For example, if you specify Thursday, October 25, 2018 3:25:45 PM as the point in time, the cmdlet will select the closest restore point to this point in time.

    NOTE: The date format depends on the date format of the OS where you run the script.

    Accepts the DateTime type.

    True

    Named

    False

    False

    Server

    For exporting backup files to disk.

    Specifies a server in the Veeam Backup & Replication infrastructure. Veeam Backup & Replication will restore tenant backups to the folder on this server.

    True

    Named

    False

    False

    Overwrite

    For the following types of restore:

    • To original location
    • To another cloud repository

    Indicates that the cmdlet will overwrite the existing backup file.

    False

    Named

    False

    False

    RunAsync

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

    False

    Named

    False

    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 restore the tenant data from tape to original location. Veeam Backup & Replication will select the restore point that is the closest to Thursday, October 25, 2018 3:25:45 PM.

    1. Run Get-VBRCloudTapeBackupTenantRepository to get the tenant cloud repository. Save the result to the $repository variable.
    2. Run New-Object to specify the date and time for the restore point. Save the result to the $date variable
    3. Run Start-VBRCloudTapeRestore with the $repository and $date variables.

    $repository = Get-VBRCloudTapeBackupTenantRepository -Name “Silver Cloud Repository”

    $date = New-Object 2018, 10, 25, 15, 25, 45

    Start-VBRCloudTapeRestore -BackupObject $repository -PointInTime $date

    Example 2

    This example shows how to restore a tenant backup job from tape to another cloud repository. Veeam Backup & Replication will select the restore point that is the closest to Thursday, November 15, 2018 1:00:31 PM.

    1. Run Get-VBRCloudTapeBackupTenantJob to get the tenant backup job. Save the result to the $backupjob variable.
    2. Run Get-VBRBackupRepository to get the cloud repository that you want to use as the target for restore. Save the result to the $repo variable.
    3. Run New-VBRCloudTenantResource with the $repo variable to create new cloud tenant resource settings. Save the result to the $newtenant variable.
    4. Run New-Object to specify the date and time for the restore point. Save the result to the $date variable
    5. Run Start-VBRCloudTapeRestore with the $backupjob, $newtenant and $date variables.

    $backupjob = Get-VBRCloudTapeBackupTenantJob -Name "Exchange Backup Job"

    $repo = Get-VBRBackupRepository -Name "NewCloudRepository"

    PS C:\PS  $newtenant = New-VBRCloudTenantResource -Repository $repo -RepositoryFriendlyName "Silver Cloud Repository" -Quota 100

    $date = New-Object DateTime 2018, 11, 15, 13, 00, 31

    Start-VBRCloudTapeRestore -BackupObject $backupjob -MappingTarget $newtenant -PointInTime $date

    Example 3

    This example shows how to restore the selected tenant to a folder on a target server from your Veeam Backup & Replication infrastructure.  Veeam Backup & Replication will select the restore point that is closest to Thursday, October 18, 2018 1:58:31 PM.

    1. Run Get-VBRCredentials to get the credentials of the target server. Save the result to the $creds variable.
    2. Run Get-VBRCloudTapeBackupTenant to get the tenant. Save the result to the $tenant variable.
    3. Run Get-VBRServer to get the server to which you want to restore the files. Save the result to the $targetserver variable.
    4. Run Start-VBRCloudTapeRestore with the $tenant and $targetserver variables. Use the PointInTime parameter to specify the restore period and the Path parameter to specify the path to the folder.

    $creds = Get-VBRCredentials -Name "Fileserver"

    $tenant = Get-VBRCloudTapeBackupTenant -Name "New tenant"

    $targetserver = Get-VBRServer -Name "New server"

    $date = New-Object DateTime 2018, 10, 18, 13, 58, 31

    Start-VBRCloudTapeRestore -BackupObject $tenant -Server $server -Path "D:\Backups" -Credentials $creds -PointInTime "11/16/18"

    Related Commands

    Get-VBRCloudTapeBackupTenantRepository

    Get-VBRCloudTapeBackupTenant

    Get-VBRCloudTapeBackupTenantJob

    New-VBRCloudTenantResource

    Get-VBRCredentials

    Get-VBRServer

    Get-VBRBackupRepository

    New-VBRCloudTenantResource