This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRScaleOutBackupRepository
Short Description
Modifies a selected scale-out backup repository.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRScaleOutBackupRepository -Repository <VBRScaleOutBackupRepository> [-Name <string>] [-Description <string>] [-PolicyType <VBRScaleOutBackupRepositoryPolicyType> {DataLocality | Performance}] [-Extent <CBackupRepository[]>] [-UsePerVMBackupFiles] [-PerformFullWhenExtentOffline] [-PassThru] [<CommonParameters>] |
Related Commands
Get-VBRBackupRepository (with ScaleOut parameter)
Return Type
Detailed Description
This cmdlet modifies settings of an existing scale-out backup repository. To modify settings, you need to enter the corresponding 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 m odify. Accepts VBRScaleOutBackupRepository object, GUID or string (repository name). | True | Named | True (by Value | False |
Name | Specifies the name of the scale-out repository. If not set, Veeam Backup & Replication will assign a default scale-out repository name. | False | Named | True (ValueFromPipeline | False |
Description | Specifies the description of the scale-out repository. If not set, Veeam Backup & Replication will enter date and time of creation by default. | False | Named | True (ValueFromPipeline | False |
Policy | Specifies the policy for the scale-out repository: DataLocality/Performance. | True | Named | True (ValueFromPipeline | False |
Extent | Specifies the backup repository.The cmdlet will add this repository as an extent to the scale-out repository. Accepts the CBackup object, GUID or string (repository name). NOTE: If you use this parameter, the cmdlet will apply the extents listed here as the array of extents of the scale-out repository. To add an extent, specify all extents that form the scale-out repository currently plus a new one. To remove an extent, specify the list of currently existing extents except for the one you want to remove. You can add multiple repositories to this object. | True | Named | True (by Value | False |
UsePerVM | If indicated, the job will store each VM's data to a separate backup file. Otherwise, each restore point will contain all VMs in job. Default: True. | False | Named | True (ValueFromPipeline | False |
PerformFull | If indicated, the job will create an active full backup if the extent with previous backup file is offline. Otherwise, the job will fail to create an increment. Default: False. | False | Named | True (ValueFromPipeline | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
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 |