Start-VBRTapeObjectStorageRestore

Short Description

Starts the restore of objects from tape.

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Restore objects from tape to the original location.

Start-VBRTapeObjectStorageRestore [-CatalogItem <VBRTapeCatalogItem[]>] [-CatalogItemVersion <VBRTapeCatalogItemVersion[]>] [-ItemRestorePolicy {LeaveExisting | OverwriteOlder | AlwaysOverwrite}] [-EnableItemSecurityRestore] [-RunAsync]  [<CommonParameters>]

  • Restore objects from tape to the a new location.

Start-VBRTapeObjectStorageRestore -Server <CHost> -Path <string> [-CatalogItem <VBRTapeCatalogItem[]>] [-CatalogItemVersion <VBRTapeCatalogItemVersion[]>] [-PreserveFolderHierarchy] [-ItemRestorePolicy {LeaveExisting | OverwriteOlder | AlwaysOverwrite}] [-EnableItemSecurityRestore] [-RunAsync]  [<CommonParameters>]

Detailed Description

This cmdlet starts the restore of objects backed-up by tape jobs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

CatalogItem

Specifies an array of objects to restore.

Accepts the VBRTapeCatalogItem[] object. To get this object, run the Find-VBRTapeCatalogItem cmdlet.

False

Named

True (ByPropertyName, ByValue)

CatalogItemVersion

Specifies an array of objects to restore.

If this parameter is not specified, the cmdlet will restore the latest version of objects.

Accepts the VBRTapeCatalogItemVersion[] object. To get this object, run the Find-VBRTapeCatalogItemVersion cmdlet.

False

Named

True (ByPropertyName, ByValue)

Server

Specifies the server to restore data to.

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

True

Named

False

Path

Specifies the path to the folder on the destination server to restore data to.

String

True

Named

False

PreserveFolderHierarchy

If you provide this parameter, the cmdlet will preserve the folder hierarchy of restored data.

Otherwise, objects will be restored to the specified target folder without keeping the folder structure.

SwitchParameter

False

Named

False

ItemRestorePolicy

Specifies overwrite options to use in case the object already exists in the target folder:

  • LeaveExisting: use this option not to overwrite the existing object with the restored one.
  • OverwriteOlder: use this option to overwrite the existing object only if it is older than the restored object.
  • AlwaysOverwrite: use this option to overwrite the existing object with the restored object in all cases.

VBRTapeCatalogItemRestorePolicy

False

Named

False

EnableItemSecurityRestore

Enables the option for the restored objects to keep their original ownership and security permissions. Otherwise, Veeam Backup & Replication will change security settings: the user account under which the Veeam Backup Service runs will be set as the owner of the restored objects, while access permissions will be inherited from the target folder to which the objects are restored.

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-VBRTapeObjectStorageRestoreExample 1. Restoring Objects from Tape to Original Location

Start-VBRTapeObjectStorageRestoreExample 2. Restoring Objects from Tape to Another Location

Start-VBRTapeObjectStorageRestoreExample 3. Restoring Objects from Tape to Another Object Storage Location

Start-VBRTapeObjectStorageRestoreRestoring Objects from Tape to Another Object Storage Location (XML)

Related Commands

Page updated 8/14/2024

Page content applies to build 12.3.1.1139