Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
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> -Extent <CBackupRepository[]> -Name <String>] [-Description <String>] [-UsePerVMBackupFiles [<SwitchParameter>]] [-PerformFullWhenExtentOffline <SwitchParameter>]] [-EnableCapacityTier [<SwitchParameter>]] [-OperationalRestorePeriod <Int32>][-EnableOverridePolicy [<SwitchParameter>]] [-OverrideSpaceThreshold <Int32>] [-OffloadWindowOptions VBRBackupWindowOptions>] [-ObjectStorageRepository <VBRObjectStorageRepository>] [-EnableEncryption <SwitchParameter>]] [-EncryptionKey <VBREncryptionKey>] [-Force [<SwitchParameter>]] [<CommonParameters>]

Detailed Description

This cmdlet creates scale-out backup repositories. You can create the scale-out backup repositories with the following options:

  • The performance tier option. To implement this option you must add local backup repositories as extents to Veeam Backup & Replication.
  • Performance tier and capacity tier options. To implement this option you must add local backup repositories and object storage repositories to Veeam Backup & Replication.

Run Get-VBRBackupRepository to get backup repositories.

Run Get-VBRObjectStorageRepository to get object storage repositories.

By default, Veeam Backup & Replication only moves backup files that form inactive backup chains. For more information about backup chains, see the Backup Chain Legitimacy section of User Guide for VMware vSphere.

If you want to move a backup file manually, run Start-VBROffloadBackupFile.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Policy
Type

Specifies the policy for the scale-out repository:

  • DataLocality - use this policy to store backup files that belong to the same backup chain.
  • 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 the array of backup repositories. The cmdlet will add these repositories as extents to the scale-out repository.

Accepts the CBackup, 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

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

Enable
Capacity
Tier

Enables the capacity tier option. Veeam Backup & Replication will move backup files to an object storage.

False

Named

True (ByProperty
Name)

 

Operational
Restore
Period

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)

 

Enable
Override
Policy

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)

 

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)

 

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)

 

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)

 

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

 

EncryptionKey

For the encryption option.

Specifies an encryption key. Veeam Backup & Replication will use this key to encrypt the data.

False

Named

False

 

Force

Indicates that the cmdlet will create the scale-out backup repository without showing up warnings in the PowerShell console.

False

Named

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 creates a scale-out repository. This scale-out repository will be created with the Performance Tier option and the performance policy type.

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

Example 2

This example shows how to create a scale-out repository with the capacity tier option.

  1. Run Get-VBRObjectStorageRepository to get the object storage that you want to use for the capacity tier option. Save the result to the $objectstorage variable.
  2. Run Add-VBRScaleOutBackupRepository with the $objectstorage variable. Use the PolicyType parameter to specify the policy type for the scale-out repository.

PS C:\PS> $objectstorage = Get-VBRObjectStorageRepository -Name "Amazon S3"

PS C:\PS> Add-VBRScaleOutBackupRepository -Name "ScaleOutRepository" -Extent "New repository"  -PolicyType Performance -EnableCapacityTier -ObjectStorageRepository $objectstorage

Related Commands

Get-VBRRepositoryExtent

Get-VBRObjectStorageRepository

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation