Enable-VBRCapacityExtentMaintenanceMode

In this article

    Short Description

    Enables the maintenance mode for the capacity extent.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Enable-VBRCapacityExtentMaintenanceMode -CapacityExtent <VBRCapacityExtent[]> [-RunAsync]  [<CommonParameters>]

    Detailed Description

    This cmdlet enables the maintenance mode for the capacity extent of the scale-out backup repository.

    Run the Disable-VBRCapacityExtentMaintenanceMode cmdlet to disable the maintenance mode.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    CapacityExtent

    Specifies the capacity extent. The cmdlet will set this extent to the maintenance mode.

    True

    Named

    True (ByValue,
    ByPropertyName)

    False

    RunAsync

    Indicates that the command returns immediately without waiting for the task to complete.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    Example

    This example shows how to set the maintenance mode for the capacity extent.

    1. Run Get-VBRBackupRepository to get a scale-out repository. Save the result to the $scaleoutrepository variable.
    2. Run Get-VBRCapacityExtent to get the capacity extents that you want to set to the maintenance mode. Save the result to the $extent variable.
    3. Run Enable-VBRCapacityExtentMaintenanceMode with the $extent variable.

    $scaleoutrepository = Get-VBRBackupRepository -ScaleOut -Name "Amazon S3"

    $extent = Get-VBRCapacityExtent -Repository $scaleoutrepository

    Enable-VBRCapacityExtentMaintenanceMode -CapacityExtent $extent

    Related Commands