This is an archive version of the document. To get the most up-to-date information, see the current version.Add-VBRHvBackupJob
Short Description
Creates a new Hyper-V backup job.
Applies to
Platform: Hyper-V
For VMware, run Add-VBRViBackupJob.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRHvBackupJob [-Name <String>] [-BackupRepository <CBackupRepository>] -Entity <IHvItem[]> [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
Related Commands
Detailed Description
This cmdlet creates a new Hyper-V 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 to start the created job.
Run Set-VBRJobSchedule to set schedule for the job.
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 should be stored. If not set, Veeam Backup & Replication will use the default backup repository. | False | Named | False | False |
Entity | Specifies the VM(s) you want to back up. You can assign multiple VMs to this object. | True | Named | True (ByValue, | False |
Description | Specifies the description of the backup job. If not set, Veeam Backup & Replication will enter date and time of creation by default. | 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 command creates a backup job named "Exchange Backup". The VMs to backup are obtained with Find-VBRHvEntity and piped down. The backup repository is obtained with Get-VBRBackupRepository and assigned to the $Repository variable beforehand. The description is "Hyper-V Exchange Backup".
