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

Add-VSBJob

Short Description

Creates a VMware SureBackup job.

Applies to

Platform: VMware

For Hyper-V, run Add-VSBHvJob.

Product Edition: Enterprise, Enterprise Plus

Syntax

Add-VSBJob [[-Name] <String>] -VirtualLab <CViSbVirtualLab> [-AppGroup <CSbAppGroup>] [-LinkedJob <CBackupJob[]>] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet creates a new VMware SureBackup job.

To add VMs that you want to verify to the SureBackup job, you can use an application group containing the list of VMs, or link a backup job which will act as a VM container.

Note that if you link a backup job, the SureBackup job will verify all VMs added to the linked job.

When you create a SureBackup job, you need to run it manually unless you enable a job schedule.

Run Start-VSBJob to start the created SureBackup job.

Run Set-VSBJobScheduleOptions to set schedule for the SureBackup job.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the name you want to assign to the SureBackup job.

False

Named

False

False

VirtualLab

Specifies the virtual lab you want to use for verification.

True

Named

True (ByValue,
ByProperty
Name)

False

AppGroup

Specifies the application group you want to use to provide the copy of the production environment of the verified VM.

If you do not use an application group, make sure that the -LinkedJob parameter is set.

False

Named

True (ByValue,
ByProperty
Name)

False

LinkedJob

Specifies the array of backup, replication or copy jobs containing VM you want to verify.

If you do not use a linked backup job, make sure that the -AppGroup parameter is set.

False

Named

True (ByValue,
ByProperty
Name)

False

Description

Specifies the description of the new SureBackup 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 1

This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab, an application group and a linked job. The VM to verify is obtained by searching for the backup job named "Exchange Backup Job" with Get-VBRJob, and piped down. The virtual lab and the application group objects are obtained with Get-VSBVirtualLab and Get-VSBApplicationGroup and assigned to $VLab01 and $"Exchange Appgroup" variables accordingly beforehand.

PS C:\PS> Get-VBRJob -Name "Exchange Backup Job" | Add-VSBJob -Name "Exchange SureJob" -VirtualLab $VLab01 -AppGroup $"Exchange Appgroup"

Example 2

This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab, an application group and a linked job. The virtual lab and application group objects are obtained with Get-VSBVirtualLab and Get-VSBApplicationGroup and assigned to $VLab01 and $"Exchange Appgroup" variables accordingly beforehand.

PS C:\PS> Add-VSBJob -Name "Exchange SureJob" -VirtualLab $VLab01 -AppGroup $"Exchange Appgroup"

Example 3

This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab and an application group. The virtual lab object is obtained with Get-VSBVirtualLab and piped down. The VM to verify is included into the application group, the application group object is obtained with Get-VSBApplicationGroup and assigned to the $"Exchange Appgroup" variable beforehand.

PS C:\PS> Get-VSBVirtualLab -Name "Exchange VLab 01" | Add-VSBJob -Name "Exchange SureJob" -AppGroup $"Exchange Appgroup"

Example 4

This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab and a linked job. The virtual lab object is obtained with Get-VSBVirtualLab and assigned to $VLab01 variable beforehand. The VM to verify is obtained with Get-VBRJob and assigned to the $"Exchange Backup" variable beforehand.

PS C:\PS> Add-VSBJob -Name "Exchange SureJob" -VirtualLab $VLab01 -LinkedJob $"Exchange Backup"

Related Commands

Get-VSBVirtualLab

Get-VSBApplicationGroup

Get-VBRJob

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