This is an archive version of the document. To get the most up-to-date information, see the current version.

Add-VBRScaleOutBackupRepository

In this article

    Short Description

    Adds a new scale-out backup repository.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus

    Syntax

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

    Related Commands

    Get-VBRRepositoryExtent

    Return Type

    VBRScaleOutBackupRepository

    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.

    If not set, Veeam Backup & Replication will assign a default scale-out repository name.

    False

    Named

    True (ValueFromPipeline
    ByPropertyName)

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

    False

    Policy
    Type

    Specifies the policy for the scale-out repository: DataLocality/Performance.

    True

    Named

    True (ValueFromPipeline
    ByPropertyName)

    False

    Extent

    Specifies the backup repository or repositories.The cmdlet will add these repositories as extents to the scale-out repository.

    Accepts the CBackup object, GUID or string (repository name).

    You can add multiple repositories to this object.

    True

    Named

    True (by Value
    FromPipeline, ValueFromPipeline
    ByPropertyName)

    False

    UsePerVM
    BackupFiles

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

    False

    PerformFull
    WhenExtent
    Offline

    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
    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.

    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”