This is an archive version of the document. To get the most up-to-date information, see the current version.

Enable-VBRCapacityExtentMaintenanceMode

Short Description

Enables the maintenance mode for the capacity extents.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

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

Detailed Description

This cmdlet enables the maintenance mode for the capacity extents.

Run Disable-VBRCapacityExtentMaintenanceMode to disable the maintenance mode.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

CapacityExtent

Specifies an array of the capacity extents. The cmdlet will set these extents 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 extents.

  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

Get-VBRBackupRepository

Get-VBRCapacityExtent