This is an archive version of the document. To get the most up-to-date information, see the current version.Enable-VBRArchiveExtentMaintenanceMode
Short Description
Enables the maintenance mode for the archive extent.
Product Edition: Enterprise Plus, Veeam Universal License
Syntax
Enable-VBRArchiveExtentMaintenanceMode -ArchiveExtent <VBRArchiveExtent[]> [-RunAsync] [<CommonParameters>] |
Detailed Description
This cmdlet enables the maintenance mode for the archive extent of the scale-out backup repository.
Run the Disable-VBRArchiveExtentMaintenanceMode cmdlet to disable the maintenance mode.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
ArchiveExtent | Specifies the archive extent. The cmdlet will set this extent to the maintenance mode. | Accepts the VBRArchiveExtent object. To get this object, run the Get-VBRArchiveExtent cmdlet. | True | Named | True (ByValue, |
RunAsync | Indicates 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 the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VBRArchiveExtentMaintenanceMode object that defines Azure AD application settings.
Examples
Enabling Maintenance Mode for Archive Extent
This example shows how to set the maintenance mode for the archive extent.
$scaleoutrepository = Get-VBRBackupRepository -ScaleOut -Name "Amazon S3" $extent = Get-VBRArchiveExtent -Repository $scaleoutrepository Enable-VBRArchiveExtentMaintenanceMode -ArchiveExtent $extent |
Perform the following actions:
- Run the Get-VBRBackupRepository cmdlet. Provide the ScaleOut parameter. Specify the Name parameter value. Save the result to the $scaleoutrepository variable.
- Run the Get-VBRArchiveExtent cmdlet. Specify the Repository parameter value. Save the result to the $extent variable.
- Run the Enable-VBRArchiveExtentMaintenanceMode cmdlet. Set the $extent variable as the ArchiveExtent parameter value.
Related Commands
