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 scale-out backup repositories.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

Syntax

Set-VBRScaleOutBackupRepository -Repository <VBRScaleOutBackupRepository> [-EncryptionKey <VBREncryptionKey [-EnableEncryption [<SwitchParameter>]] [-ObjectStorageRepository <VBRObjectStorageRepository>] [-OffloadWindowOptions <VBRBackupWindowOptions>] [-OverrideSpaceThreshold <Int32>] [-EnableOverridePolicy] [<SwitchParameter>]] [-PassThru [<SwitchParameter>]] [-OperationalRestorePeriod <Int32>] [-PerformFullWhenExtentOffline [<SwitchParameter>]] [-UsePerVMBackupFiles [<SwitchParameter>]] [-Extent<CBackupRepository[]>] [-PolicyType <VBRScaleOutBackupRepositoryPolicyType>] [-Description <String>] [-Name <String>] [-EnableCapacityTier [<SwitchParameter>]] [-Force [<SwitchParameter>]] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of scale-out backup repositories. 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 Pipeline Input	Accept Wildcard Characters
Repository	Specifies a scale-out repository that you want to modify. Accepts VBRScaleOutBackupRepository, GUID or string (repository name) types.	True	Named	True (ByValue, ByProperty Name)	False
Name	Specifies a name of a scale-out repository.	False	Named	True (ByProperty Name)	False
Description	Specifies a description of a scale-out repository.	False	Named	True (ByProperty Name)	False
Policy Type	Specifies the policy for a scale-out repository: DataLocality - use this policy to store backup files that belong to the same backup chain together. Performance - to store full and incremental backup files to different extents of the scale-out backup repository.	True	Named	True (ByProperty Name)	False
Extent	Specifies an array of backup repositories. The cmdlet will add these repositories as extents to a scale-out repository. Accepts the 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 extent that you want to remove.	True	Named	True (ByProperty Name)	False
UsePerVM BackupFiles	If set to True, the repository will store each VM in the job as a separate backup file. If set to False, each restore point will contain all VMs in the job.	False	Named	True (ByProperty Name)	False
PerformFull WhenExtent Offline	If set to True, the job will create an active full backup if the extent with the previous backup file is offline. If set to False, the job will fail to create an increment.	False	Named	True (ByProperty Name)	False
EnableCapacityTier	Indicates that the capacity tier option is enabled. Veeam Backup & Replication will move backup files to the object storage.	False	Named	True (ByProperty Name)	False
OperationalRestorePeriod	For retention policy. Specifies the number of days to keep backup files on the local repository. When the number of days is passed, Veeam Backup & Replication will move backup files to an object storage. NOTE: If you select zero days, Veeam Backup & Replication will move all backup files from the local repository to the object storage immediately.	False	Named	True (ByProperty Name)	False
EnableOverridePolicy	Indicates that Veeam Backup & Replication will move backup files from the local repository to an object storage when the capacity reaches limits. If set, this option overrides the retention policy. Veeam Backup & Replication will move backup files to an object storage even if the retention policy value has not reached limits. Use the OverrideSpaceThreshold parameter to specify the capacity value.	False	Named	True (ByProperty Name)	False
OverrideSpaceThreshold	For the override option. Specifies the capacity value in percent for the override optoin. Once the value reaches the limit, Veeam Backup & Replication will move the data from the local repository to an object storage.	False	Named	True (ByProperty Name)	False
OffloadWindowOptions	Specifies the time interval, when Veeam Backup & Replication is allowed will move the backup files to an object storage. Accepts the VBRBackupWindowOptions type.	False	Named	True (ByProperty Name)	False
ObjectStorageRepository	Specifies an object storage. Veeam Backup & Replication will move the backup files to this object storage. Accepts the VBRObjectStorageRepository type.	False	Named	True (ByProperty Name)	False
EnableEncryption	Indicates that the encryption option is enabled. Veeam Backup & Replication will encrypt backup files before moving them to an object storage. Veeam Backup & Replication will encrypt all backup files from the backup chain, including the metadata. Use the EncryptionKey parameter to specify the encryption key.	False	Named	False	False
EncryptionKey	For the encryption option. Specifies an encryption key. Veeam Backup & Replication will use this key to encrypt the data.	False	Named	False	False
Force	Indicates that the cmdlet will create the scale-out backup repository without showing up the notifications in the PowerShell console.	False	Named	False	False
PassThru	Indicates that the command returns the output object to the Windows PowerShell console.	False	Named	False	False
EnableCapacityTierMovePolicy	Defines that the cmdlet wiil move inactive backup chains to object storage.	False	Named	False	False
EnableCapacityTierCopyPolicy	Defines that the cmdlet wiil copy new backup files to object storage as soon as they are created.	False	Named	False	False

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

Return Type

VBRScaleOutBackupRepository

Example 1

This example shows how to add a new extent to the scale-out repository.

Run Get-VBRBackupRepository to get the repository. Use the ScaleOut parameter. Save it to the $repository variable.
Run Set-VBRScaleOutBackupRepository with the $repository variable. List the existing extents and the new repository.

$repository = Get-VBRBackupRepository -Name "Veeam Scale-Out Repository" -ScaleOut

Set-VBRScaleOutBackupRepository –Repository $repository –Extent “Backup Repository 1”, “Backup Repository 2”, “Backup Repository 3”

Example 2

This example shows how to modify the scale-out repository policy.

Run Get-VBRBackupRepository to get the repository. Use the ScaleOut parameter. Save it to the $repository variable.
Run Set-VBRScaleOutBackupRepository with the $repository variable. List the existing extents and the new repository.

$repository = Get-VBRBackupRepository -Name "Veeam Scale-Out Repository" -ScaleOut

Set-VBRScaleOutBackupRepository –Repository $repository –PolicyType DataLocality

Related Commands

Get-VBRBackupRepository

Get-VBRRepositoryExtent