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

Add-VBRViBackupJob

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 [-Name <String>] [-BackupRepository <CBackupRepository>] -Entity <IViItem[]> [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet creates a new 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 to start the created job.

Run Set-VBRJobSchedule to set schedule for the job.

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

<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-VBRViEntity and piped down. The backup repository is obtained with Get-VBRBackupRepository and assigned to the $Repository variable beforehand. The description is "VMware Exchange Backup".

PS C:\PS> Find-VBRViEntity -Name Exchange* | Add-VBRViBackupJob -Name "Exchange Backup" -BackupRepository $Repository -Description "VMware Exchange Backup"

Related Commands

Get-VBRBackupRepository

Find-VBRViEntity

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect 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