Enable-VBRCapacityExtentMaintenanceMode

Short Description

Enables the Maintenance mode for capacity extents.

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 capacity extents of the scale-out backup repository.

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
CapacityExtent	Specifies the capacity extent. The cmdlet will set this extent to the Maintenance mode. Accepts the `VBRCapacityExtent[]` object. To get this object, run the `Get-VBRCapacityExtent` cmdlet.	`VBRCapacityExtent[]`	True	Named	True (ByPropertyName, ByValue)
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 Microsoft Docs.

Output Object

Examples

Setting Maintenance Mode for Capacity Extent

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

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

$extent = Get-VBRCapacityExtent -Repository $scaleoutrepository

Enable-VBRCapacityExtentMaintenanceMode -CapacityExtent $extent

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value and provide ScaleOut parameter. Save the result to the $scaleoutrepository variable.
Run the Get-VBRCapacityExtent cmdlet. Set the $scaleoutrepository variable as Repository parameter value. Save the result to the $extent variable.
Run the Enable-VBRCapacityExtentMaintenanceMode cmdlet. Set the $extent variable as the CapacityExtent parameter value.