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

Add-VBRScaleOutBackupRepository

Short Description

Adds scale-out backup repositories to Veeam Backup & Replication.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

Syntax

Add-VBRScaleOutBackupRepository -PolicyType <VBRScaleOutBackupRepositoryPolicyType> {DataLocality | Performance} -Extent <CBackupRepository[]> [-Name <string>] [-Description <string>] [-UsePerVMBackupFiles] [-PerformFullWhenExtentOffline]  [<CommonParameters>]

Detailed Description

This cmdlet creates a scale-out backup repository.

You can create a repository with a selected policy:

  • With the DataLocality policy, the dependent backups are placed to the same extent (for example, restore points of one VM).
  • With the Performance policy, Veeam distributes backups in order to provide better performance. With this policy, you can additionally configure extents to store only full backups, only incremental backups or full and incremental backups (default). Run Set-VBRRepositoryExtent to set the backup placement mode.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the name of the scale-out repository.

False

Named

True (ValueFromPipeline
ByPropertyName)

False

Description

Specifies the description of the scale-out repository.

False

Named

True (ValueFromPipeline
ByPropertyName)

False

Policy
Type

Specifies the policy for the scale-out repository:

  • DataLocality
  • Performance.

True

Named

True (ValueFromPipeline
ByPropertyName)

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.

True

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

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 (ValueFromPipeline
ByPropertyName)

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 (ValueFromPipeline
ByPropertyName)

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

This command creates a performance scale-out repository.

PS C:\PS> Add-VBRScaleOutBackupRepository -Name "Veeam Performance Scale-Out Repository" –PolicyType Performance –Extent “Backup Repository 1”, “Backup Repository 2”

Related Commands

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