Get-VBRArchiveExtent

In this article

    Short Description

    Returns the archive extent.

    Product Edition: Enterprise Plus, Veeam Universal License

    Syntax

    Get-VBRArchiveExtent -Repository <VBRScaleOutBackupRepository[]> [<CommonParameters>]

    Detailed Description

    This cmdlet returns the archive extent of scale-out backup repositories. The archive extent is an archive object storage repository that is added to the scale-out backup repository.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Repository

    Specifies an array of scale-out backup repositories. The cmdlet will return the archive extent added to this repository.

    Accepts the VBRScaleOutBackupRepository object. To get this object, run the Add-VBRScaleOutBackupRepository cmdlet.

    True

    Named

    True

    <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 VBRScaleOutBackupRepository object that defines the archive extent settings.

    Examples

    Getting Archive Extent

    This example shows how to get the archive extents added to the scale-out backup repository.

    $repository = Get-VBRBackupRepository -ScaleOut

    Get-VBRArchiveExtent -Repository $repository

    Perform the following actions:

    1. Run the Get-VBRBackupRepository cmdlet. Provide the ScaleOut parameter. Save the result to the $repository variable.
    2. Run the Get-VBRCArchiveExtent cmdlet. Set the $repository variable as the Repository parameter value.

    Related Commands

    Get-VBRBackupRepository