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, Veeam Universal License

Syntax

Add-VBRHvBackupJob -Entity <IHvItem[]> [-Name <string>] [-BackupRepository <CBackupRepository>] [-Description <string>] [-Force] [-HighPriority] [<CommonParameters>]

Detailed Description

This cmdlet creates a 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 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.

Note

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 Pipeline Input	Accept Wildcard Characters
Name	Specifies the name you want to assign to the backup job.	False	Named	False	False
BackupRepository	Specifies the backup repository where the created backup will be stored. Default: default backup repository.	False	Named	False	False
Entity	Specifies the array of Hyper-V VMs you want to add to the job.	True	Named	True (ByValue, ByProperty Name)	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
HighPriority	Note: This parameter is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261). Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it in the first place.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

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".

Find-VBRHvEntity -Name Exchange* | Add-VBRHvBackupJob -Name "Exchange Backup" -BackupRepository $Repository -Description "Hyper-V Exchange Backup"

Related Commands

Get-VBRBackupRepository

Find-VBRHvEntity

Get-VBRLocation