Enable-VBRRepositoryExtentMaintenanceMode

Short Description

Enables Maintenance mode for a performance extent or capacity extent of a scale-out backup repository.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Enable-VBRRepositoryExtentMaintenanceMode -Extent <VBRRepositoryExtent[]> [-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet enables Maintenance mode for a selected performance extent or extents of scale-out backup repositories.

With one command, you can switch to Maintenance mode multiple performance extents: the extents can be of mixed policies and belong to several scale-out repositories.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Extent	Specifies the array of scale-out repository extents. The cmdlet will enable the Maintenance mode for these extents. Accepts extents with different policies and of different scale-out repositories. Accepts VBRRepositoryExtent, ID or string (name of the backup repository that is used as extent) types.	True	Named	True (ByValue, ByProperty Name)	True (for string)
RunAsync	Indicates that the command returns immediately without waiting for the task to complete.	False	Named	False	False

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Extent

Specifies the array of scale-out repository extents. The cmdlet will enable the Maintenance mode for these extents.

Accepts extents with different policies and of different scale-out repositories.

Accepts VBRRepositoryExtent, ID or string (name of the backup repository that is used as extent) types.

True

Named

True (ByValue,
ByProperty
Name)

True (for string)

RunAsync

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

False

Named

False

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

Return Type

VBRSession

Enabling Maintenance Mode for Performance Extents

This example shows how to enable the Maintenance mode for the performance extents.

Run Get-VBRBackupRepository to get the scale-out repository. Save the result to the $scaleoutrepository variable.
Run Get-VBRRepositoryExtent to get the performance extents that you want to set to the Maintenance mode. Save the result to the $extent variable.
Run Enable-VBRRepositoryExtentMaintenanceMode with the $extent variable.

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

$extent = Get-VBRCapacityExtent -Repository $scaleoutrepository

Enable-VBRRepositoryExtentMaintenanceMode -Extent $extent[2]

Related Commands

Get-VBRRepositoryExtent