Short Description
Adds a new backup repository.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRBackupRepository [-Name <String>] [-Description <String>] [-Server
<CHost>] [-MountServer <CHost>] -Folder <String> -Type
<CBackupRepositoryInfo+EType> ImportIndex] ImportBackup]
[-RotatedDrive] [-VPowerNFSFolder <String>] [-UseFc] [-DDServerName <String>]
LimitConcurrentJobs] MaxConcurrentJobs <Int32>] LimitDatarate] DataRateLimit <Int32>] AlignDataBlocks] DecompressDataBlocks] [-WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
-OR-
Add-VBRBackupRepository [-Name <String>] [-Description <String>] [-Server
<CHost>] [-MountServer <CHost>] -Folder <String> -Type
<CBackupRepositoryInfo+EType> ImportIndex] ImportBackup]
[-RotatedDrive] [-VPowerNFSFolder <String>] [-UseFc] [-DDServerName <String>]
UserName <String>] Password <String>] LimitConcurrentJobs] [-MaxConcurrentJobs <Int32>] [-LimitDatarate] [-DataRateLimit <Int32>]
[AlignDataBlocks] [-DecompressDataBlocks] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
-OR-
Add-VBRBackupRepository [-Name <String>] [-Description <String>] [-Server
<CHost>] [-MountServer <CHost>] -Folder <String> -Type
<CBackupRepositoryInfo+EType> ImportIndex] ImportBackup]
[-RotatedDrive] [-VPowerNFSFolder <String>] [-UseFc] [-DDServerName <String>]
[-Credentials <CCredentials>] [-LimitConcurrentJobs] [-MaxConcurrentJobs
<Int32>] LimitDatarate] DataRateLimit <Int32>] AlignDataBlocks] [-DecompressDataBlocks] [-WarningAction <ActionPreference>] [-WarningVariable
<String>][<CommonParameters>]
Related Commands
Get-VBRServer Get-VBRCredentials
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 source server. This cmdlet provides three scenarios for each case including no authentication.
To add a scale-out backup repository, run Add-VBRScaleOutBackupRepository.
Parameters
Parameter Description Required Position Accept
Pipeline Input
Accept Wildcard Characters 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.
If not set, Veeam Backup & Replication will enter date and time of creation by default.
False Named False False
Type Specifies the type you want to assign to the repository:
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 Used to enable the vPower NFS.
Specifies the host where the NFS service must be installed.
By default, the vPower NFS folder is created on the mounted host. If you want to locate the vPower NFS folder elsewhere, use the VPowerNFSFolder parameter to set the path.
False Named False False
Folder Specifies the full path to the folder where you
want to store the backups. True Named False False
Import
Index If indicated, the guest OS file system index will
be imported automatically. False Named False False
Import
Backup If indicated, the existing backups located on the repository you are adding will be imported automatically. Otherwise, you will need to import the backups manually.
False Named False False
Rotated Drive
Indicates if the repository you want to add is a rotated drive (removable media).
False Named False False
VPower NFSFolder
Specifies the path to the vPower NFS root folder.
To enable the vPower NFS, the MountServer parameter must be set.
False Named False False
DDServer Name
Specifies the Data Domain server name according to the connection mode:
— If EMC Data Domain works over TCP, enter a full DNS name or IP address of the EMC Data Domain server.
— If 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
Limit Concurrent Jobs
Indicates if 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.
Accepts int type.
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.
Accepts int32 type.
Permitted value: 1 to 1024 (MByte/s).
False Named False False
Align Data Blocks
If set, 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
If set, backup data blocks will be decompressed before storing the backup to the repository.
Decompression helps to achieve a better
False Named False False
deduplication ratio.
UserName Specifies the user name you want to use for authenticating with the backup repository host.
If you use the Username/Password scenario, the Credentials parameter must be omitted.
False Named False False
Password Specifies the password you want to use for authenticating with the backup repository host.
If you use the Username/Password scenario, the Credentials parameter must be omitted.
False Named False False
Credentials Specifies credentials you want to use for authenticating with the backup repository host.
If you use the Credentials scenario, the User and Password parameters must be omitted.
False Named False 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 1
This command adds a Windows server as a new backup repository named "Win2012Repo". No authentication is used. All repository settings are used as set default.
• The server to add is obtained with Get-VBRServer and assigned to the $server variable beforehand.
• The folder that is used as the backup repository is located on "C:\Backup Repository".
• The server type is set to "WinLocal".
Add-VBRBackupRepository -Name "Win2012Repo" -Server $server -Folder
"c:\Backup Repository" -Type WinLocal
Example 2
This command adds a Windows server as a new backup repository named "Backups Vol 01". The authentication with the server is provided with the credentials record.
• The server to add is obtained with Get-VBRServer and assigned to the $server variable beforehand.
• The folder that is used as the backup repository is located on "C:\Backup Repository".
• The server type is set to "WinLocal".
• The -ImportBackup parameter is set to adopt the existing backup files.
• The Max concurrent tasks number is set to 6.
• The credentials to authenticate with the source server are obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand.
Add-VBRBackupRepository -Name "Backups Vol 01" -Server $server -Folder
"C:\Backup Repository" Type WinLocal ImportBackup MaxConcurrentJobs 6 -Credentials $Administrator
Example 3
This command adds an EMC DataDomain storage appliance as a backup repository. The DataDomain storage is connected over the TCP. The storage appliance is connected to an explicitly set gateway server.
• The folder path is set to "DataDomain://10.0.0.80:storage/".
• The DataDomain appliance is set with the IP address. The "DFC-" prefix is not set to enable the connection over TCP.
• The server type is set to "DataDomain".
• The host that will be used as the gateway server is obtained with Get-VBRServer and assigned to the $server variable beforehand.
• The Username/Password is used to get access to the appliance.
Add-VBRBackupRepository -Folder DataDomain://10.0.0.80:storage/ -Type DataDomain DDServerName 10.0.0.80 Server $server UserName sysadmin -Password Pa55word
Example 4
This command adds backup repository on a rotated drive connected to a Windows server.
• The server type is set to "WinLocal".
• The "Rotated Drive" switch parameter is used to enable the rotated drive repository technology.
• The host to which the rotated drive is connected is obtained with Get-VBRServer and assigned to the $server variable beforehand.
• The folder path is "F:\Repo".
Add-VBRBackupRepository -Name RDX -Type WinLocal -RotatedDrive -Description
"Rotated drive" -Server $server -Folder F:\Repo