This is an archive version of the document. To get the most up-to-date information, see the current version.Publish-VBRArchiveRestorePoint
Short Description
Retrieves data from archive storage.
Product Edition: Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Retrieve backup files from Amazon S3 Glacier archive storage to the capacity extent.
Publish-VBRArchiveRestorePoint -RestorePoint <COib> -AvailabilityPeriodDays <int> [-AmazonS3GlacierRetrievalPolicy <VBRAmazonS3GlacierRetrievalPolicy>] [-EnableExpirationNotification] [-ExpirationHoursThreshold <int>][-RunAsync] [<CommonParameters>] |
- Retrieve backup files from Azure archive storage to the capacity extent.
Publish-VBRArchiveRestorePoint -RestorePoint <COib> -AvailabilityPeriodDays <int> [-AzureArchiveRetrievalPolicy <VBRAzureArchiveRetrievalPolicy>] [-EnableExpirationNotification] [-ExpirationHoursThreshold <int>][-RunAsync] [<CommonParameters>] |
Detailed Description
This cmdlet retrieves the backup files from the archive storage to the capacity extent of the scale-out backup repository. This is necessary for restore from archived backups.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
RestorePoint | Specifies the restore point for which you want to execute publish | Accepts the COib type. To get this object, run the Get-VBRRestorePoint cmdlet. | True | Named | False |
AvailabilityPeriodDays | Specifies a period (in days) during which the retrieved archive backup files will be available. | Int | 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 methods:
| VBRAmazonS3GlacierRetrievalPolicy | True | Named | False |
AzureArchiveRetrievalPolicy | Defines the method of data retrieval for Azure archive storage. You can retrieve data using one of the following methods:
| VBRAzureArchiveRetrievalPolicy | True | Named | False |
EnableExpirationNotification | Enables sending of notification about upcoming expiration of the retrieved archive backup files availability. | 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 the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VBRPublishedBackupSession object.
Examples
Retrieving Backup Files from Amazon S3 Glacier Archive Extent
This example shows how to retrieve the backup files from Amazon S3 Glacier archive extent of the scale-out backup repository.
$backup = Get-VBRBackup -Name "JOB_2" $rp = Get-VBRRestorePoint -Backup $backup Publish-VBRArchiveRestorePoint -RestorePoint $rp[0] -AvailabilityPeriodDays 3 -AmazonS3GlacierRetrievalPolicy Standard |
Perform the following steps:
- Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
- Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value.
The Get-VBRRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the first restore point in the array).
- Run the Publish-VBRArchiveRestorePoint cmdlet. Specify the following settings:
- Set the $rp variable as the RestorePoint parameter value.
- Specify the AvailabilityPeriodDays parameter value.
- Specify the AmazonS3GlacierRetrievalPolicy parameter value.
Related Commands
