Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

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 -Entity <IHvItem[]> [-Name <string>] [-BackupRepository <CBackupRepository>] [-Description <string>] [-Force]  [<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.

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.

Add-VBRHvBackupJob 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

Backup
Repository

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

<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:

  1. Run Find-VBRHvEntity to get all VMs which start with "Exchange". Save the result to the $exchvms variable.
  2. Run Get-VBRBackupRepository to get the backup repository named "Backup Repository". Save the result to the $repository variable.
  3. Run Add-VBRHvBackupJob with the $exchvms and $repository variables. Use the Description parameter to add the description of the backup job.

PS C:\PS> $exchvms = Find-VBRHvEntity -Name Exchange*

PS C:\PS> $repository = Get-VBRBackupRepository -Name "Backup Repository"

PS C:\PS> Add-VBRHvBackupJob -Entity $exchvms -Name "Exchange Backup" -BackupRepository $repository -Description "VMware Exchange Backup"

Related Commands

Get-VBRBackupRepository

Find-VBRHvEntity

Get-VBRLocation

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation