Set-VBRScaleOutBackupRepository

In this article

    Short Description

    Modifies scale-out backup repositories.

    Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Set-VBRScaleOutBackupRepository -Repository <VBRScaleOutBackupRepository> [-Name <string>] [-Description <string>] [-PolicyType {DataLocality | Performance}] [-Extent <CBackupRepository[]>] [-UsePerVMBackupFiles] [-PerformFullWhenExtentOffline] [-EnableCapacityTier] [-OperationalRestorePeriod <int>] [-EnableOverridePolicy] [-OverrideSpaceThreshold <int>] [-OffloadWindowOptions <VBRBackupWindowOptions>] [-ObjectStorageRepository <VBRObjectStorageRepository>] [-EnableEncryption] [-EncryptionKey <VBREncryptionKey>] [-PassThru] [-Force] [-EnableCapacityTierMovePolicy] [-EnableCapacityTierCopyPolicy] [-EnableArchiveTier] [-ArchiveObjectStorageRepository <VBRArchiveObjectStorageRepository>] [-ArchivePeriod <int>] [-EnableCostOptimizedArchive] [-EnableFullBackupArchiveMode] [-EnablePluginBackupOffload] [-EnableCopyAllPluginBackups] [-EnableCopyAllMachineBackups]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies settings of scale-out backup repositories. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept
    Pipeline
    Input

    Repository

    Specifies a scale-out repository that you want to modify.

    Accepts the VBRScaleOutBackupRepository object. To create this object, run the Add-VBRScaleOutBackupRepository cmdlet.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    Name

    Specifies a name of a scale-out repository.

    String

    False

    Named

    True (ByProperty
    Name)

    Description

    Specifies a description of a scale-out repository.

    String

    False

    Named

    True (ByProperty
    Name)

    PolicyType

    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.

    VBRScaleOutBackupRepositoryPolicyType

    True

    Named

    True (ByProperty
    Name)

    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.

    CBackupRepository

    True

    Named

    True (ByProperty
    Name)

    UsePerVMBackupFiles

    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.

    SwitchParameter

    False

    Named

    True (ByProperty
    Name)

    PerformFullWhenExtentOffline

    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.

    SwitchParameter

    False

    Named

    True (ByProperty
    Name)

    EnableCapacityTier

    Indicates that the capacity tier option is enabled. Veeam Backup & Replication will move backup files to the object storage.

    SwitchParameter

    False

    Named

    True (ByProperty
    Name)

    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.

    Int

    False

    Named

    True (ByProperty
    Name)

    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.

    OverrideSpaceThreshold

    False

    Named

    True (ByProperty
    Name)

    OverrideSpaceThreshold

    For the override option.

    Specifies the capacity value in percent for the override option. Once the value reaches the limit, Veeam Backup & Replication will move the data from the local repository to an object storage.

    Int32

    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 object. To create this object, run the New-VBRBackupWindowOptions cmdlet.

    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 object. To create this object, run the Get-VBRObjectStorageRepository cmdlet.

    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.

    SwitchParameter

    False

    Named

    False

    EncryptionKey

    For the encryption option.

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

    Accepts the VBREncryptionKey object. To get this object, run the Add-VBREncryptionKey cmdlet.

    False

    Named

    False

    Force

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

    SwitchParameter

    False

    Named

    False

    PassThru

    Indicates that the command returns the output object to the Windows PowerShell console.

    SwitchParameter

    False

    Named

    False

    EnableCapacityTierMovePolicy

    Defines that the cmdlet wiil move inactive backup chains to object storage.

    SwitchParameter

    False

    Named

    False

    EnableCapacityTierCopyPolicy

    Defines that the cmdlet wiil copy new backup files to object storage as soon as they are created.

    SwitchParameter

    False

    Named

    False

    EnableArchiveTier

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

    SwitchParameter

    False

    Named

    True (ByPropertyName)

    ArchiveObjectStorageRepository

    Specifies an archive storage. Veeam Backup & Replication will move the backup files to this archive storage.

     

    Accepts the VBRArchiveObjectStorageRepository object. To create this object, run the Get-VBRArchiveObjectStorageRepository cmdlet.

    False

    Named

    True (ByPropertyName)

    ArchivePeriod

    For retention policy.

    Specifies the number of days to keep backup files on the archive extent. When the number of days is passed, Veeam Backup & Replication will delete outdated backup files.

    Int.

    False

    Named

    False

    EnableCostOptimizedArchive

    Enables the option to archive backup files only if the remaining retention time is above minimal storage period.

    SwitchParameter

    False

    Named

    False

    EnableArchiveFullBackupMode

    Enables the option to store archived backups as standalone fulls, without any dependencies on the previous backup files.

    SwitchParameter

    False

    Named

    False

    EnablePluginBackupOffload

    Enables offloading of the backup files created with plugin backup jobs to the capacity tier.

    Default:

    • For scale-out backup repositories created with Veeam Backup & Replication versions 10 and earlier: False
    • For scale-out backup repositories created with Veeam Backup & Replication versions 11 and later: True

    SwitchParameter

    False

    Named

    False

    EnableCopyAllPluginBackups

    For backup files created with Veeam Plug-in for SAP HANA, Veeam Plug-in for Oracle RMAN.

    Enables copying of all backup files from the performance extents to the capacity extent. If you do not provide this parameter, the cmdlet will disable copying of such backup files to the capacity extent.

    Note that you must provide the EnableCapacityTierCopyPolicy parameter to activate the copy policy.

    SwitchParameter

    False

    Named

    False

    EnableCopyAllMachineBackups

    For backup files created with Veeam Agent backup jobs and Veeam Backup jobs for VMs.

    Enables copying of all backup files from the performance extents to the capacity extent. If you do not provide this parameter, the cmdlet will copy only the latest backup files.

    Note that you must provide the EnableCapacityTierCopyPolicy parameter to activate the copy policy.

    SwitchParameter

    False

    Named

    False

    <CommonParameters>

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

    Output Object

    The cmdlet returns the VBRScaleOutBackupRepository object.

    Examples

    Adding New Extent to Scale-Out Repository

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

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

    Modifying Scale-Out Repository Policy

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

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