Short Description
Modifies a selected scale-out backup repository.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Set-VBRScaleOutBackupRepository -Repository <VBRScaleOutBackupRepository> [-Name <string>] [-Description <string>] [-PolicyType <VBRScaleOutBackupRepositoryPolicyType> {DataLocality | Performance}] [-Extent <CBackupRepository[]>] [-UsePerVMBackupFiles] [-PerformFullWhenExtentOffline] [-PassThru] [<CommonParameters>] |
Detailed Description
This cmdlet modifies settings of an existing scale-out backup repository. To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Repository | Specifies the scale-out repository that you want to modify. Accepts VBRScaleOutBackupRepository, GUID or string (repository name) types. | True | Named | True (ByValue, | False |
Name | Specifies the name of the scale-out repository. | False | Named | True (ByProperty | False |
Description | Specifies the description of the scale-out repository. | False | Named | True (ByProperty | False |
Policy | Specifies the policy for the scale-out repository:
| True | Named | True (ByProperty | False |
Extent | Specifies the array of backup repositories. The cmdlet will add these repositories as extents to the scale-out repository. Accepts CBackup, GUID or string (repository name) types. IMPORTANT! The cmdlet will replace the extents currently added to the scale-out backup repository with this array. To add an extent, specify all currently added extents plus the new one. To remove an extent, specify the currently existing extents except for the one you want to remove. | True | Named | True (ByProperty | False |
UsePerVM | If set to True, the repository will store each VM in job as a separate backup file. If set to False, each restore point will contain all VMs in job. | False | Named | True (ByProperty | False |
PerformFull | If set to True, the job will create an active full backup if the extent with previous backup file is offline. If set to False, the job will fail to create an increment. | False | Named | True (ByProperty | False |
PassThru | Indicates that the command returns the output object to the Windows PowerShell console. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Return Type
Example 1
This command adds a new extent to the scale-out repository.
- Run Get-VBRBackupRepository to get the repository. Use the ScaleOut parameter. Save it to the $scaleoutrepository variable.
- Run Set-VBRScaleOutBackupRepository with this variable. List the existing extents and the new repository.
PS C:\PS> $scaleoutrepository = Get-VBRBackupRepository -Name "Veeam Scale-Out Repository" -ScaleOut PS C:\PS> Set-VBRScaleOutBackupRepository –Repository $scaleoutrepository –Extent “Backup Repository 1”, “Backup Repository 2”, “Backup Repository 3” |
Example 2
This command changes the scale-out repository policy.
- Run Get-VBRBackupRepository to get the repository. Use the ScaleOut parameter. Save it to the $scaleoutrepository variable.
- Run Set-VBRScaleOutBackupRepository with this variable. List the existing extents and the new repository.
PS C:\PS> $scaleoutrepository = Get-VBRBackupRepository -Name "Veeam Scale-Out Repository" -ScaleOut PS C:\PS> Set-VBRScaleOutBackupRepository –Repository $scaleoutrepository –PolicyType DataLocality |
Related Commands
Get-VBRBackupRepository (with ScaleOut parameter)
