Start-VBRCloudTapeRestore

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 parameter sets that allow you to:

  • Restore to original location.

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

  • Restore to another cloud repository.

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

  • Export 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 the Stop-VBRCloudTapeRestore cmdlet to stop the restore session.

Start-VBRCloudTapeRestore Important!

Consider 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 the New-VBRCloudTenantResource cmdlet to create the cloud tenant resource.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

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[] object. To get this object, run one of the following cmdlets:

True

0

True (ByValue)

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 object. To get this object, run the Get-VBRCredentials cmdlet.

True

Named

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[] object. Run the New-VBRCloudTenantResource cmdlet to create this object.

True

Named

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.

String

True

Named

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, 2023 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 object. To get this object, run the Get-Date cmdlet.

True

Named

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.

Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.

True

Named

False

Overwrite

For the following types of restore:

  • To original location
  • To another cloud repository

Defines that the cmdlet will overwrite the existing backup file.

SwitchParameter

False

Named

False

RunAsync

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

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Examples

Start-VBRCloudTapeRestoreExample 1. Restoring Tenant Data from Tape to Original Location [Using Variable]

Start-VBRCloudTapeRestoreExample 2. Restoring Tenant Data from Tape to Another Cloud Repository [Using Variable]

Start-VBRCloudTapeRestoreExample 3. Restoring Tenant Data from Tape to Target Server [Using Variable]

Related Commands

Page updated 5/17/2024

Page content applies to build 12.3.1.1139