Add-VBRBackupRepository
Short Description
Adds backup repositories to Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides parameter sets that allow you to:
- For adding repository without authentication.
Add-VBRBackupRepository -Folder <string> -Type <VBRRepositoryType> {WinLocal | LinuxLocal | CifsShare | ExaGrid | DataDomain | HPStoreOnceIntegration | Quantum} [-Name <string>] [-Description <string>] [-Server <CHost>] [-MountServer <CHost>] [-ImportIndex] [-ImportBackup] [-RotatedDrive] [-MountFolder <string>] [-VPowerNFSFolder <string>] [-VPowerNFSPort <int>] [-MountPort <int>] [-DDServerName <string>] [-StoreOnceServerName <string>] [-StoreOnceWanLink] [-LimitConcurrentJobs] [-MaxConcurrentJobs <int>] [-LimitDatarate] [-DataRateLimit <int>] [-AlignDataBlocks] [-DecompressDataBlocks] [-UsePerVMFile] [-DDBoostEncryptionType <VBRDDBoostEncryptionType> {None | Medium | High}][-EnableXFSFastClone] [<CommonParameters>] |
- For adding repository with username and password.
Add-VBRBackupRepository -Folder <string> -Type <VBRRepositoryType> {WinLocal | LinuxLocal | CifsShare | ExaGrid | DataDomain | HPStoreOnceIntegration | Quantum} [-Name <string>] [-Description <string>] [-Server <CHost>] [-MountServer <CHost>] [-ImportIndex] [-ImportBackup] [-RotatedDrive] [-MountFolder <string>] [-VPowerNFSPort<int>] [-MountPort <int>] [-DDServerName <string>] [-StoreOnceServerName <string>] [-StoreOnceWanLink] [-UserName <string>] [-Password <string>] [-LimitConcurrentJobs] [-MaxConcurrentJobs <int>] [-LimitDatarate] [-DataRateLimit <int>] [-AlignDataBlocks] [-DecompressDataBlocks] [-UsePerVMFile] [-DDBoostEncryptionType <VBRDDBoostEncryptionType> {None | Medium | High}][-EnableXFSFastClone] [<CommonParameters>] |
- For adding repository using credentials.
Add-VBRBackupRepository -Folder <string> -Type <VBRRepositoryType> {WinLocal | LinuxLocal | CifsShare | ExaGrid | DataDomain | HPStoreOnceIntegration | Quantum} [-Name <string>] [-Description <string>] [-Server <CHost>] [-MountServer <CHost>] [-ImportIndex] [-ImportBackup] [-RotatedDrive] [-MountFolder <string>] [-VPowerNFSPort<int>] [-MountPort <int>] [-DDServerName <string>] [-StoreOnceServerName <string>] [-StoreOnceWanLink] [-Credentials <CCredentials>] [-LimitConcurrentJobs] [-MaxConcurrentJobs <int>] [-LimitDatarate] [-DataRateLimit <int>] [-AlignDataBlocks] [-DecompressDataBlocks] [-UsePerVMFile] [-DDBoostEncryptionType <VBRDDBoostEncryptionType> {None | Medium | High}] [-EnableXFSFastClone] [<CommonParameters>] |
Detailed Description
This cmdlet adds a new backup repository to Veeam Backup & Replication.
When adding a backup repository, you may need to provide username/password or credentials to authenticate with the server or appliance that you want to use as the repository. Authenticating is needed for the following sources:
- Shared folders
- Dell EMC Data Domain storage appliances
- ExaGrid storage appliances
- HPE StoreOnce storage appliances
This cmdlet provides three parameter sets for each case including no authentication.
To add a scale-out backup repository, run the Add-VBRScaleOutBackupRepository cmdlet.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Name | Specifies the name you want to assign to the new 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:
Default: This server. | False | Named | False | False |
MountServer | 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 |
Folder | Specifies the full path to the folder where you want to store the backups. | True | Named | False | False |
Type | Specifies the type you want to assign to the repository:
| True | Named | False | False |
ImportIndex | Indicates that the cmdlet will import the guest OS file system index. | False | Named | False | False |
ImportBackup | Indicates that the cmdlet will import backups that are currently located on the server you are adding as repository. | False | Named | False | False |
RotatedDrive | Indicates that the repository you want to add is a rotated drive (removable media). | 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 |
VPowerNFSFolder | 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 |
DDServerName | Specifies the Data Domain server name. Enter the name in the following formats depending on the connection mode:
| False | Named | False | False |
StoreOnceServerName | Specifies the HPE StoreOnce server name. | False | Named | False | False |
StoreOnceWanLink | Indicates that the HPE StoreOnce must use source-side deduplication. | False | Named | False | False |
LimitConcurrentJobs | 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 |
MaxConcurrentJobs | 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 |
LimitDatarate | 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 |
DataRateLimit | 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 |
AlignDataBlocks | 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 |
DecompressDataBlocks | Indicates that the backup data blocks must be decompressed before storing to the repository. | False | Named | False | False |
UsePerVMFile | Indicates that the backup repository must create per-VM backup files. | False | Named | False | False |
DDBoostEncryptionType | Specifies the native Dell EMC Data Domain encryption level:
| False | Named | False | False |
UserName | Specifies the user name you want to use for authenticating with the backup repository host. | False | Named | False | False |
Password | Specifies the password you want to use for authenticating with the backup repository host. | False | Named | False | False |
Credentials | Specifies credentials you want to use for authenticating with the backup repository host. | False | Named | False | 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.
Examples
Example 1. Adding Windows Server as Backup Repository
This example shows how to add the Win2012 Windows server as a new backup repository named "Win2012Repo". The cmdlet will add the backup repository with the following settings:
Perform the following steps:
|
Example 2. Adding Shared Folder as Backup Repository
This example shows how to add a shared folder on a Windows server as the Backups Vol 01 backup repository. The cmdlet will add the backup repository with the following settings:
Perform the following steps:
|
Example 3. Adding Dedupe Storage Aplliance as Backup Repository
This example shows how to add a Dell EMC Data Domain storage appliance as a backup repository. The cmdlet will add the backup repository with the following settings:
Perform the following steps:
|
Example 4. Adding Backup Repository on Rotated Drive
This example shows how to add backup repository on a rotated drive connected to a Windows server. The cmdlet will add the backup repository with the following settings:
Perform the following steps:
|
Example 5. Adding Quantum DXi Storage Appliance as Backup Repository
This example shows how to add a Quantum DXi storage appliance as a backup repository. Veeam Backup & Replication will store backup files in the folder located in the following path: /shares/Quantum-Share-01.
Perform the following steps:
|
Example 6. Adding ExaGrid Share as Backup Repository
The example shows how to add ExaGrid as a backup repository. Veeam Backup & Replication will store backup files in the folder located in the following path: /home/Admin/Share01-07/MyRepo. The pattern of this folder path consists of the following elements:
Perform the following steps:
|
Example 7. Adding HPE StoreOnce as Backup Repository
This example shows how to add HPE StoreOnce as a backup repository. Veeam Backup & Replication will store backup files in the folder located in the following path: storeonce://HPEStoreO01-dl.local:Store-015/. The pattern of this folder path consists of the following elements:
Perform the following steps:
|
Related Commands