Publish-VBRCloudArchiveRestorePoint

Short Description

Retrieves tenant data from archive storage.

Applies to

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides parameter sets that allow you to:

  • Retrieve tenant data from Amazon S3 Glacier archive storage.

Publish-VBRCloudArchiveRestorePoint -RestorePoint <CCommonOib> -AvailabilityPeriodDays <uint32> -AmazonS3GlacierRetrievalPolicy {Expedited | Standard | Bulk} [-EnableExpirationNotification] [-ExpirationHoursThreshold <int>] [-RunAsync]  [<CommonParameters>]

  • Retrieve tenant data from Azure Archive storage.

Publish-VBRCloudArchiveRestorePoint -RestorePoint <CCommonOib> -AvailabilityPeriodDays <uint32> -AzureArchiveRetrievalPolicy {StandardPriority | HighPriority} [-EnableExpirationNotification] [-ExpirationHoursThreshold <int>] [-RunAsync]  [<CommonParameters>]

  • Retrieve tenant data from S3 compatible object storage with data archiving.

Publish-VBRCloudArchiveRestorePoint -RestorePoint <CCommonOib> -AvailabilityPeriodDays <UInt32> -S3GlacierCompatibleRetrievalPolicy <VBRS3GlacierCompatibleRetrievalPolicy> [-EnableExpirationNotification] [-ExpirationHoursThreshold <Int32>] [-RunAsync]  [<CommonParameters>]

Detailed Description

This cmdlet retrieves tenant data from archive storage and places them in the capacity tier of scale-out backup repository.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

RestorePoint

Specifies a restore point of tenant backups which you want to retrieve.

Accepts the CCommonOib object. To get this object, run the Get-VBRRestorePoint cmdlet.

True

Named

True (ByValue, ByPropertyName)

AvailabilityPeriodDays

Specifies a period in days during which the retrieved archive backup files will be available.

Uint32

True

Named

False

AmazonS3GlacierRetrievalPolicy

Defines the method of data retrieval for Amazon S3 Glacier object storage. You can retrieve data using one of the following method:

  • Expedited: Use this method to retrieve archived data within 1-5 minutes. Note that this is the most expensive method.
  • Standard: Use this method to retrieve archived data within 3-5 hours.
  • Bulk: Use this method to retrieve archived data within 5-12 hours.

VBRAmazonS3GlacierRetrievalPolicy

True

Named

False

AzureArchiveRetrievalPolicy

Defines the method of data retrieval for Azure Archive storage. You can retrieve data using one of the following method:

  • StandardPriority: Use this method to retrieve archived data within 15 hours.
  • HighPriority: Use this method to retrieve archived data within an hour. Note that this is the most expensive method.

VBRAzureArchiveRestrievalPolicy

True

Named

False

S3GlacierCompatibleRetrievalPolicy

Defines the method of data retrieval for S3 compatible object storage with data archiving. You can retrieve data using one of the following method:

  • Expedited: Use this method to retrieve archived data within 1-5 minutes. Note that this is the most expensive method.
  • Standard: Use this method to retrieve archived data within 3-5 hours.
  • Bulk: Use this method to retrieve archived data within 5-12 hours.

VBRS3GlacierCompatibleRetrievalPolicy

True

 

Named

False

EnableExpirationNotification

Enables sending of notification about upcoming expiration of the retrieved archive backup files availability.

Default: False.

SwitchParameter

False

Named

False

ExpirationHoursThreshold

For the EnableExpirationNotification parameter. Specifies the moment when the user receives the notification about upcoming expiration of the retrieved archive backup files availability.

Int

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

The cmdlet returns the VBRCloudArchiveRestorePoint object that contains information on tenant data retieved from archive storage and places them in the capacity extents of scale-out backup repository.

Examples

Publish-VBRCloudArchiveRestorePointExample 1. Retrieving Tenant Data from Amazon S3 Glacier Archive Storage

Publish-VBRCloudArchiveRestorePointExample 2. Retrieving Tenant Data from Azure Archive Storage

Publish-VBRCloudArchiveRestorePointExample 3. Retrieving Tenant Data from Amazon S3 Glacier Archive Storage for Multiple Restore Points

Related Commands

Page updated 4/19/2024

Page content applies to build 12.3.1.1139