Add-VBRSureBackupJob

Short Description

Creates a SureBackup job.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Add-VBRSureBackupJob -VirtualLab <VBRVirtualLab> [-Name <String>] [-Description <String>] [-ApplicationGroup <VBRApplicationGroup>] [-KeepApplicationGroupRunning] [-LinkedJob <VBRSureBackupLinkedJob[]>] [-MaxConcurrentVMs <Int32>] [-ProcessRandomMachines] [-VerificationOptions <VBRSureBackupJobVerificationOptions>] [-ScheduleOptions <VBRSureBackupJobScheduleOptions>] [-Force] [-RandomMachinesMaxCount <Int32>] [<CommonParameters>]

Detailed Description

This cmdlet creates a SureBackup job.

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

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

Run the New-VBRSureBackupJobScheduleOptions to set schedule for the job.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
VirtualLab	Specifies a virtual lab. The cmdlet will use this virtual lab to verify VMs.	Accepts the VBRVirtualLab object. To create this object, run the Get-VBRVirtualLab cmdlet.	True	Named	False
Name	Specifies a name for a SureBackup job. The cmdlet will create a SureBackup job with this name.	String	False	Named	False
Description	Specifies a description for a SureBackup job. The cmdlet will create a SureBackup job with this description.	String	False	Named	False
ApplicationGroup	Specifies an application group. Veeam Backup & Replication will use this application group to use for recovery verification. Note: You must specify either the ApplicationGroup or the LinkedJob parameter to run the cmdlet.	Accepts the VBRApplicationGroup object. To create this object, run the Get-VBRApplicationGroup cmdlet.	False	Named	False
KeepApplicationGroupRunning	Defines that VMs from an application group will run after the SureBackup job finishes. If you provide this parameter, the application group will not be powered off when the SureBackup job finishes. Otherwise, the application group will be powered off.	SwitchParamter	False	Named	False
LinkedJob	Specifies a backup or replication job. The cmdlet will verify VMs that are added to this job with the SureBackup job. Note: You must specify either the LinkedJob or the ApplicationGroup parameter to run the cmdlet.	Accepts the VBRSureBackupLinkedJob[] object. To create this object, run the New-VBRSureBackupLinkedJob cmdlet.	False	Named	False
MaxConcurrentVMs	Specifies the maximum number of VMs that can be started at the same time.	Int32	False	Named	False
VerificationOptions	Specifies additional settings for the SureBackup job.	Accepts the VBRSureBackupJobVerificationOptions object. To create this object, run the New-VBRSureBackupJobVerificationOptions cmdlet.	False	Named	False
ScheduleOptions	Specifies schedule settings of a SureBackup job. Veeam Backup & Replication will run the job according to these settings.	Accepts the VBRSureBackupJobScheduleOptions object. To create this object, run the New-VBRSureBackupJobScheduleOptions cmdlet.	False	Named	False
RandomMachinesMaxCount	Specifies the number of machines to randomly test during each run. The cmdlet will randomly test the specified number of machines from the linked job.	Int32	False	Named	False
ProcessRandomMachines	Defines that the cmdlet will randomly test the specified number of machines from the linked job. Use the RandomMachinesMaxCount parameter to specify the number of machines to randomly test.	SwitchParamter	False	Named	False
Force	Defines that the cmdlet will not show any warnings.	SwitchParamter	False	Named	False

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

Output Object

The cmdlet returns the VBRSureBackupJob object that defines settings of SureBackup jobs.

Examples

Add-VBRSureBackupJob Example 1. Adding SureBackup Job

This example shows how to create a SureBackup job.

$lab = Get-VBRVirtualLab -Name "Virtual Lab 2"

$group = Get-VBRApplicationGroup -Name "Exchange Application Group"

Add-VBRSureBackupJob -ApplicationGroup $group -VirtualLab $lab -Name "Verification Job01" -Description "SureBackup Job for DNS"

Perform the following steps:

Run the Get-VBRVirtualLab cmdlet. Specify the Name parameter value. Save the result to the $lab variable.
Run the Get-VBRApplicationGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
Run the Add-VBRSureBackupJob cmdlet. Specify the following settings:

Set the $lab variable as the VirtualLab parameter value.
Set the $group variable as the ApplicationGroup parameter value.
Specify the Name parameter value.
Specify the Description parameter value.

Add-VBRSureBackupJob Example 2. Adding SureBackup Job with Application Group

This example shows how to create a SureBackup job that will use the Exchange Group 3 application group for recovery verification. Veeam Backup & Replication will keep VMs from an application group running after the SureBackup job finishes.

$lab = Get-VBRVirtualLab -Name "Virtual Lab 2"

$group = Get-VBRApplicationGroup -Name "Exchange Lab"

Add-VBRSureBackupJob -VirtualLab $lab -ApplicationGroup $group -KeepApplicationGroupRunning

Perform the following steps:

Run the Get-VBRVirtualLab cmdlet. Specify the Name parameter value. Save the result to the $lab variable.
Run the Get-VBRApplicationGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
Run the Add-VBRSureBackupJob cmdlet. Specify the following settings:

Set the $lab variable as the VirtualLab parameter value.
Specify the $group variable as the ApplicationGroup parameter value.
Provide the KeepApplicationGroupRunning parameter.

Add-VBRSureBackupJob Example 3. Adding SureBackup Job with Recovery Verification Options

This example shows how to create a SureBackup job with recovery verification options.

$lab = Get-VBRVirtualLab -Name "Virtual Lab 2"

$options = New-VBRSureBackupJobVerificationOptions

$group = Get-VBRApplicationGroup -Name "Exchange Lab"

Add-VBRSureBackupJob -VirtualLab $lab -VerificationOptions $options -ApplicationGroup $group

Perform the following steps:

Run the Get-VBRVirtualLab cmdlet. Specify the Name parameter value. Save the result to the $lab variable.
Run the New-VBRSureBackupJobVerificationOptions cmdlet. Save the result to the $options variable.
Run the Get-VBRApplicationGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
Run the Add-VBRSureBackupJob cmdlet. Specify the following settings:

Set the $lab variable as the VirtualLab parameter value.
Specify the $options variable as the VerificationOptions parameter value.

Specify the $group variable as the ApplicationGroup parameter value.

Related Commands