Short Description
Creates VMware backup jobs.
Applies to
Platform: VMware
For Hyper-V, run Add-VBRHvBackupJob.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRViBackupJob -Entity <IViItem[]> [-Name <string>] [-BackupRepository <CBackupRepository>] [-Description <string>] [-Force] [<CommonParameters>] |
Detailed Description
This cmdlet creates a VMware backup job.
Note that when you create a backup job, you need to run it manually unless you enable a job schedule.
- Run Start-VBRJob cmdlet to run the job manually.
- Run Set-VBRJobSchedule to set schedule for the job.
Starting from Veeam Backup & Replication version 9.5 Update 3, the cmdlet checks if the data of the VMs added to the job changes its geographical location.
|
The cmdlet will not run if the geographical location of the VMs added to the job and the job target repository location do not match. If you still want to run the cmdlet, use the Force parameter. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Name | Specifies the name you want to assign to the backup job. | False | Named | False | False |
Backup | Specifies the backup repository where the created backup will be stored. Default: default backup repository. | False | Named | False | False |
Entity | Specifies the array of VMware VMs you want to add to the job. | True | Named | True (ByValue, | False |
Description | Specifies the description of the backup job. | False | Named | False | False |
Force | Indicates that the cmdlet will create a backup job even if the geographical location of the VMs added to the job and the target backup repository location do not match. | 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
This example shows how to create a backup job named "Exchange Backup".
You will need to perform the following steps:
- Run Find-VBRViEntity to get all VMs which start with "Exchange". Save the result to the $exchvms variable.
- Run Get-VBRBackupRepository to get the backup repository named "Backup Repository". Save the result to the $repository variable.
- Run Add-VBRViBackupJob with the $exchvms and $repository variables. Use the Description parameter to add the description of the backup job.
PS C:\PS> $exchvms = Find-VBRViEntity -Name Exchange* PS C:\PS> $repository = Get-VBRBackupRepository -Name "Backup Repository" PS C:\PS> Add-VBRViBackupJob -Entity $exchvms -Name "Exchange Backup" -BackupRepository $repository -Description "VMware Exchange Backup" |
Related Commands
