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

Set-VBRBackupRepository

Short Description

Modifies a backup repository.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRBackupRepository -Repository <CBackupRepository> [-Name <string>] [-Description <string>] [-MountServer <CHost>] [-Server <CHost>] [-RotatedDrive] [-EnableVPowerNFS] [-VPowerNFSFolder <string>] [-DDServerName <string>] [-RequireAccessCreds] [-Credentials <CCredentials>] [-LimitConcurrentJobs] [-MaxConcurrentJobs <int>] [-LimitDatarate] [-DataRateLimit <int>] [-AlignDataBlocks] [-DecompressDataBlocks] [-UsePerVMFile] [-DDBoostEncryptionType <VBRDDBoostEncryptionType> {None | Medium | High}] [-AffinityMode <VBRProxyAffinityMode> {Auto | Manual}] [-AffinityProxy <CViProxy[]>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies a selected backup repository. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

To modify scale-out backup repository, run Set-VBRScaleOutBackupRepository.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Repository

Specifies the backup repository you want to modify.

True

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

Name

Specifies the name you want to assign to the backup repository.

False

Named

False

False

Description

Specifies the description of the backup repository.

False

Named

False

False

Server

Specifies the host where the backup repository you want to add is located.

Use this parameter to explicitly set the host for the following repository types:

For the WinLocal type: indicate the Windows based server  where you want to create the backup repository or to which you want to connect the rotated drives.

For the LinuxLocal type: indicate the Linux based server  where you want to create the backup repository or to which you want to connect the rotated drives.

For the CifsShare, DataDomain or HPStoreOnce types: indicate a Windows based server that to which the storage appliance is connected and which will be used as a gateway server.

Default: This server.

False

Named

False

False

Mount
Server

Specifies the mount server associated with the backup repository. You can assign the mount server role to the backup repository itself or to a server that resides close to the backup repository.

False

Named

False

False

Rotated
Drive

Indicates that the repository you want to add is a rotated drive (removable media).

False

Named

False

False

Enable
VPowerNFS

Indicates that the repository is accessible by the vPower NFS service.

False

Named

False

False

VPower
NFSFolder

Specifies the path to the vPower NFS root folder.

False

Named

False

False

DDServer
Name

Specifies the Data Domain server name. Enter the name in the following formats depending on the connection mode:

— If Dell EMC Data Domain works over TCP, enter a full DNS name or IP address of the Dell EMC Data Domain server.

— If Dell EMC Data Domain works over Fibre Channel, enter a name of the Data Domain server starting with a 'DFC-' prefix, for example, "DFC-DataDomain690".

False

Named

False

False

Require
Access
Creds

Indicates that the administrator credentials are needed to access the shared folder. Use the Credentials parameter to specify the credentials.

False

Named

False

False

Credentials

Specifies credentials you want to use for authenticating with the backup repository host.

False

Named

False

False

Limit
Concurrent
Jobs

Indicates that the number of concurrent jobs using this repository must be limited. Use the MaxConcurrentJobs parameter to set the maximum value.

False

Named

False

False

Max
Concurrent
Jobs

Used for setting maximum value for the LimitConcurrentJobs parameter.

Specifies the maximum allowed number of concurrent tasks for the backup repository.

Permitted values: 1 to 99.

False

Named

False

False

Limit
Datarate

Indicates that the total speed of writing data to the backup repository disk must be restricted. Use the DataRateLimit parameter to set the maximum value.

False

Named

False

False

Data
Rate
Limit

Used for setting combined data ingestion rate for the LimitDatarate parameter.

Specifies the combined data ingestion rate for the repository.

Permitted value: 1 to 1024 (MByte/s).

False

Named

False

False

Align
Data
Blocks

Indicates that the backup blocks size will be aligned by a 4Kb block boundary. Data alignment provides better deduplication on storage systems with fixed block size.

False

Named

False

False

Decompress
DataBlocks

Indicates that the backup data blocks must be decompressed before storing to the repository.

False

Named

False

False

UsePerVM
File

Indicates that the backup repository must create per-VM backup files.

False

Named

False

False

DDBoost
Encryption
Type

Specifies the native Dell EMC Data Domain encryption level:

  • High
  • Medium
  • None

False

Named

False

False

AffinityMode

Specifies what proxy affinity rules are set up for the backup repository:

  • Auto — all backup proxies in the backup infrastructure can work with the backup repository
  • Manual — backup proxies from the AffinityProxy list can work with the backup repository

To configure proxy affinity settings, you must install Veeam Backup & Replication Enterprise or higher license on the backup server.

Default: Auto.

False

Named

False

False

AffinityProxy

Specifies the list of backup proxies that can work with the backup repository. Entries in the proxy affinity list are separated with a comma.

To configure proxy affinity settings, you must install Veeam Backup & Replication Enterprise or higher license on the backup server.

False

Named

True (by Value
FromPipeline, 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 example shows how to configure proxy affinity settings for a backup repository named "Backup Volume 01".

  1. Run Get-VBRBackupRepository to get the backup repository and save it to the $repository variable.
  2. Run Get-VBRViProxy twice to get backup proxies and save them to $proxy01 and $proxy02 variables.
  3. Run Set-VBRBackupRepository with $repository, $proxy01 and proxy02 variables.

PS C:\PS> $repository = Get-VBRBackupRepository -Name "Backup Volume 01"

PS C:\PS> $proxy01 = Get-VBRViProxy -Name 172.17.53.5

PS C:\PS> $proxy02 = Get-VBRViProxy -Name 172.17.53.33

PS C:\PS> Set-VBRBackupRepository -Repository $repository -AffinityMode manual -AffinityProxy $proxy01, $proxy02

Related Commands

Get-VBRBackupRepository

Get-VBRServer

Get-VBRCredentials

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