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] [-VPowerNFSPort <int>] [-MountPort <int>] [-MountFolder <string>] [-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[]>] [-EnableXFSFastClone][<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 | Accept |
Repository | Specifies the backup repository you want to modify. | True | Named | True (ByValue, | 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 is located. The cmdlet will set this host as a backup repository. Default: This server. Note: You can not set a new backup repository for the following types of hosts that have been added as backup repositories:
| False | Named | False | False |
MountFolder | Specifies the path to the mount folder. Veeam Backup & Replication will use this folder to mount VM disks and to keep write cache data. | False | Named | False | False |
Mount | 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 | Indicates that the repository you want to add is a rotated drive (removable media). | False | Named | False | False |
Enable | Indicates that the repository is accessible by the vPower NFS service. | False | Named | False | False |
VPower | This parameter is deprecated and replaced with the MountFolder parameter. Note: The vPower NFS folder is currently located under the following path: \Program Data\Veeam\Backup\IRCache\. | False | Named | False | False |
VPowerNFSPort | Specifies the port number of the vPower NFS Service. Veeam Backup & Replication will set up a direct connection between the backup repository and ESXi to which the vPower NFS datastore is mounted. Default: 2049. | False | Named | False | False |
MountPort | Specifies the port number of the mount server. Default: 1058. | False | Named | False | False |
Require | 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 | 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 | 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 | 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 | 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 | 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 | Indicates that the backup data blocks must be decompressed before storing to the repository. | False | Named | False | False |
UsePerVM | Indicates that the backup repository must create per-VM backup files. | False | Named | False | False |
DDBoost | Specifies the native Dell EMC Data Domain encryption level:
| False | Named | False | False |
AffinityMode | Specifies what proxy affinity rules are set up for 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 (ByValue, | False |
EnableXFSFastClone | Defines that the Fast Clone technology will be enabled for the backup repository. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Example
This example shows how to configure proxy affinity settings for a backup repository named "Backup Volume 01".
- Run Get-VBRBackupRepository to get the backup repository and save it to the $repository variable.
- Run Get-VBRViProxy twice to get backup proxies and save them to $proxy01 and $proxy02 variables.
- Run Set-VBRBackupRepository with the $repository, $proxy01 and proxy02 variables.
$repository = Get-VBRBackupRepository -Name "Backup Volume 01" $proxy01 = Get-VBRViProxy -Name 172.17.53.5 $proxy02 = Get-VBRViProxy -Name 172.17.53.33 Set-VBRBackupRepository -Repository $repository -AffinityMode manual -AffinityProxy $proxy01, $proxy02 |
Related Commands