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	Type	Required	Position	Accept Pipeline Input
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 the ID, the String (name of the backup repository that is used as extent), or the VBRRepositoryExtent [] object. To get the performance extent, run the Get-VBRRepositoryExtent cmdlet. To get the capacity extent, run the Get-VBRCapacityExtent cmdlet. To get the archive extent, run the Get-VBRArchiveExtent cmdlet.	True	Named	True (ByValue, ByProperty Name)
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

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 the ID, the String (name of the backup repository that is used as extent), or the VBRRepositoryExtent [] object.

To get the performance extent, run the Get-VBRRepositoryExtent cmdlet.

To get the capacity extent, run the Get-VBRCapacityExtent cmdlet.

To get the archive extent, run the Get-VBRArchiveExtent cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

RunAsync

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

SwitchParameter

False

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRSession

Examples

Enabling Maintenance Mode for Performance Extents

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

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

$extent = Get-VBRRepositoryExtent -Repository $scaleoutrepository

Enable-VBRRepositoryExtentMaintenanceMode -Extent $extent[2]

Perform the following steps:

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

The Get-VBRRepositoryExtent cmdlet will return an array of extents. Mind the ordinal number of the necessary extent (in our example, it is the third extent in the array).

Run the Enable-VBRRepositoryExtentMaintenanceMode cmdlet. Set the $extent variable as the Extent parameter value.

Related Commands