Publish-VBRCloudArchiveRestorePoint

In this article

    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 data from Amazon S3 Glacier archive storage

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

    • Retrieve data from Azure archive storage.

    Publish-VBRCloudArchiveRestorePoint -RestorePoint <CCommonOib> -AvailabilityPeriodDays <uint32> -AzureArchiveRetrievalPolicy {StandardPriority | HighPriority} [-EnableExpirationNotification] [-ExpirationHoursThreshold <int>] [-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 mst expensive method.

     

    VBRAzureArchiveRestrievalPolicy

    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 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

    This example shows how to retrieve the ABC Company tenant data from Amazon S3 Glacier archive storage with the following settings:

    • Data retrieval will take from 3-5 hours.
    • The retrieved archive backup files will be available for 14 days.

    $tenant = Get-VBRCloudTenant -Name "ABC Company"

    $restorepoint = Get-VBRCloudArchiveRestorePoint -Tenant $tenant -Id "3e57a915-2755-4297-be14-deddb8564ca9"

    Publish-VBRCloudArchiveRestorePoint -RestorePoint $restorepoint -AvailabilityPeriodDays 14 -AmazonS3GlacierRetrievalPolicy Standard -RunAsync

    Perform the following steps:

    1. Run the Get-VBRCloudTenant cmdlet. Specify the Name parameter value. Save the result to the $tenant variable.
    1. Run the Get-VBRCloudArchiveRestorePoint cmdlet. Specify the Id and Tenant parameter values. Save the result to the $restorepoint variable.
    2. Run the Publish-VBRCloudArchiveRestorePoint cmdlet. Specify the following settings:
    • Set the $restorepoint variable as the RestorePoint parameter value.
    • Specify the AvailabilityPeriodDays parameter value.
    • Specify the AmazonS3GlacierRetrievalPolicy parameter value.
    • Provide the RunAsync parameter.

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

    This example shows how to retrieve the ABC Company tenant data from Azure archive storage with the following settings:

    • Data retrieval will take about an hour.
    • The retrieved archive backup files will be available for 7 days.

    $tenant = Get-VBRCloudTenant -Name "ABC Company"

    $restorepoint = Get-VBRCloudArchiveRestorePoint -Tenant $tenant -Id "3e57a915-2755-4297-be14-deddb8564ca9"

    Publish-VBRCloudArchiveRestorePoint -RestorePoint $restorepoint -AvailabilityPeriodDays 7 -AzureArchiveRetrievalPolicy StandardPriority -RunAsync

    Perform the following steps:

    1. Run the Get-VBRCloudTenant cmdlet. Specify the Name parameter value. Save the result to the $tenant variable.
    1. Run the Get-VBRCloudArchiveRestorePoint cmdlet. Specify the Id and Tenant parameter values. Save the result to the $restorepoint variable.
    2. Run the Publish-VBRCloudArchiveRestorePoint cmdlet. Specify the following settings:
    • Set the $restorepoint variable as the RestorePoint parameter value.
    • Specify the AvailabilityPeriodDays parameter value.
    • Specify the AzureArchiveRetrievalPolicy parameter value.
    • Provide the RunAsync parameter.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.