Add-VBRHvBackupJob

Short Description

Creates Hyper-V backup jobs.

Applies to

Platform: Hyper-V

For VMware, run the Add-VBRViBackupJob cmdlet.

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

Creates Hyper-V backup jobs.

Note that when you create a backup job, you need to run it manually unless you enable a job schedule.

Run the Start-VBRJob cmdlet to run the job manually.

Run the Set-VBRJobSchedule cmdlet to set schedule for the job.

Note

The cmdlet will not run if the geographic 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	Type	Required	Position	Accept Pipeline Input
Name	Specifies the name you want to assign to the backup job.	String	False	Named	False
BackupRepository	Specifies the backup repository where the created backup will be stored. Default: default backup repository.	Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.	False	Named	False
Entity	Specifies the array of Hyper-V VMs you want to add to the job.	Accepts the IHvItem[] object. To get this object, run the Find-VBRHvEntity cmdlet.	True	Named	True (ByProperty Name, ByValue)
Description	Specifies the description of the backup job.	String	False	Named	False
Force	Defines that the cmdlet will create a backup job even if the geographic location of the VMs added to the job and the target backup repository location do not match.	SwitchParameter	False	Named	False
HighPriority	Defines that Veeam Backup & Replication will prioritize this job higher than other similar jobs and will allocate resources to it in the first place.	SwitchParameter	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Add-VBRHvBackupJob Example 1. Creating Backup Job [Using Pipeline]

This example shows how to create a backup job named Exchange Backup.

$Repository = Get-VBRBackupRepository -Name "Backup Repository"

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

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $Repository variable.
Run the Find-VBRHvEntity cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Add-VBRHvBackupJob cmdlet. Specify the following settings:

Specify the Name parameter value.
Specify the Description parameter value.
Set the $Repository variable as the BackupRepository parameter value.

Add-VBRHvBackupJob Example 2. Creating Backup Job [Using Variable]

This example shows how to create a backup job for the VM represented by the $Vm variable.

$Repository = Get-VBRBackupRepository -Name "Backup Repository"

$Vm = Find-VBRHvEntity -Name "VM01"

Add-VBRHvBackupJob -BackupRepository $Repository -Entity $Vm

Perform the following steps:

Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $Repository variable.
Run the Find-VBRHvEntity cmdlet. Specify the Name parameter value. Save the result to the $Vm variable.
Run the Add-VBRHvBackupJob cmdlet. Set the $Repository variable as the BackupRepository parameter value. Set the $Vm variable as the Entity parameter value.

Related Commands