Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Set-VBRScaleOutBackupRepository

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, 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 the 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 the name of the scale-out repository.

False

Named

True (ByProperty
Name)

False

Description

Specifies the description of the scale-out repository.

False

Named

True (ByProperty
Name)

False

Policy
Type

Specifies the policy for the scale-out repository:

  • DataLocality
  • Performance.

True

Named

True (ByProperty
Name)

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
Name)

False

UsePerVM
BackupFiles

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
Name)

False

PerformFull
WhenExtent
Offline

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
Name)

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

VBRScaleOutBackupRepository

Example 1

This command adds a new extent to the scale-out repository.

  1. Run Get-VBRBackupRepository to get the repository. Use the ScaleOut parameter. Save it to the $scaleoutrepository variable.
  2. 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.

  1. Run Get-VBRBackupRepository to get the repository. Use the ScaleOut parameter. Save it to the $scaleoutrepository variable.
  2. 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)

Get-VBRRepositoryExtent

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation