Add-VSBJob (obsolete)

Short Description

Creates a VMware SureBackup job.

Note

This cmdlet is obsolete. Run the Add-VBRSureBackupJobCreates a SureBackup job. cmdlet instead.

Platform: VMware

For Hyper-V, run the Add-VSBHvJobCreates a Hyper-V SureBackup job. This cmdlet is obsolete. Run the Add-VBRSureBackupJob cmdlet instead. cmdlet.

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Add-VSBJob [[-Name] <String>] [[-VirtualLab] <CViSbVirtualLab>] [-AppGroup <CSbAppGroup>]

[-LinkedJob <CBackupJob[]>] [-Description <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 the Start-VSBJobStarts a created SureBackup job. This cmdlet is obsolete. Run the Start-VBRSureBackupJob cmdlet instead. cmdlet to start the created SureBackup job.

Run the Set-VSBJobScheduleOptionsApplies customized job scheduling options to a selected SureBackup job. This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions. cmdlet to set schedule for the SureBackup job.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

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.

Accepts the CSbAppGroup object. To get this object, run the Get-VSBApplicationGroupReturns application groups. This cmdlet is obsolete. Run the Get-VBRApplicationGroup cmdlet instead. cmdlet.

CSbAppGroup

False

Named

True (ByPropertyName, ByValue)

Description

Specifies the description of the new SureBackup job.

String

False

Named

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.

Accepts the CBackupJob[] object. To get this object, run the Get-VBRJobReturns existing jobs. cmdlet.

CBackupJob[]

False

Named

True (ByPropertyName, ByValue)

Name

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

String

False

0

False

VirtualLab

Specifies the virtual lab you want to use for verification.

Accepts the CViSbVirtualLab object. To get this object, run the Get-VSBVirtualLab cmdlet.

CViSbVirtualLab

False

1

True (ByPropertyName, ByValue)

<CommonParameters>

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

Examples

Add-VSBJob (obsolete)Example 1. Creating SureBackup Job Using Virtual Lab, Application Group and Linked Job [Using Pipeline]

This example shows how to create the Exchange SureJob SureBackup job using a virtual lab, an application group and a linked job.

$ExchangeAppgroup = Get-VSBApplicationGroup -Name "MailServer Appgroup"

$VLab01 = Get-VSBVirtualLab -Name "MailServer VLab 01"

Get-VBRJob -Name "Exchange Backup Job" | Add-VSBJob -Name "Exchange SureJob" -VirtualLab $VLab01 -AppGroup $ExchangeAppgroup

Perform the following steps:

  1. Run the Get-VSBApplicationGroupReturns application groups. This cmdlet is obsolete. Run the Get-VBRApplicationGroup cmdlet instead. cmdlet. Specify the Name parameter value. Save the result to the $ExchangeAppgroup variable.
  2. Run the Get-VSBVirtualLabReturns VMware virtual labs. This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the Get-VBRVirtualLab cmdlet. cmdlet. Specify the Name parameter value. Save the result to the $VLab01 variable.
  3. Run the Get-VBRJobReturns existing jobs. cmdlet. Specify the Name parameter value.
  4. Pipe the cmdlet output to the Add-VSBJob cmdlet. Specify the Name parameter value. Set the $VLab01 variable as the VirtualLab parameter value. Set the $ExchangeAppgroup variable as the AppGroup parameter value.

Add-VSBJob (obsolete)Example 2. Creating SureBackup Job Using Virtual Lab and Application Group [Using Variable]

This example shows how to create the Exchange SureJob SureBackup job using a virtual lab and an application group.

$ExchangeAppgroup = Get-VSBApplicationGroup -Name "MailServer Appgroup"

$VLab01 = Get-VSBVirtualLab -Name "MailServer VLab 01"

Add-VSBJob -Name "Exchange SureJob" -VirtualLab $VLab01 -AppGroup $ExchangeAppgroup

Perform the following steps:

  1. Run the Get-VSBApplicationGroupReturns application groups. This cmdlet is obsolete. Run the Get-VBRApplicationGroup cmdlet instead. cmdlet. Specify the Name parameter value. Save the result to the $ExchangeAppgroup variable.
  2. Run the Get-VSBVirtualLabReturns VMware virtual labs. This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the Get-VBRVirtualLab cmdlet. cmdlet. Specify the Name parameter value. Save the result to the $VLab01 variable.
  3. Run the Add-VSBJob cmdlet. Specify the Name parameter value. Set the $VLab01 variable as the VirtualLab parameter value. Set the $ExchangeAppgroup variable as the AppGroup parameter value.

Add-VSBJob (obsolete)Example 3. Creating SureBackup Job Using Virtual Lab and Application Group [Using Pipeline]

This example shows how to create the Exchange SureJob SureBackup job using a virtual lab and an application group.

$ExchangeAppgroup = Get-VSBApplicationGroup -Name "MailServer Appgroup"

Get-VSBVirtualLab -Name "Exchange VLab 01" | Add-VSBJob -Name "Exchange SureJob" -AppGroup $ExchangeAppgroup

Perform the following steps:

  1. Run the Get-VSBApplicationGroupReturns application groups. This cmdlet is obsolete. Run the Get-VBRApplicationGroup cmdlet instead. cmdlet. Specify the Name parameter value. Save the result to the $ExchangeAppgroup variable.
  2. Run the Get-VSBVirtualLabReturns VMware virtual labs. This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the Get-VBRVirtualLab cmdlet. cmdlet. Specify the Name parameter value.
  3. Pipe the cmdlet output to the Add-VSBJob cmdlet. Specify the Name parameter value. Set the $ExchangeAppgroup variable as the AppGroup parameter value.

Add-VSBJob (obsolete)Example 4. Creating SureBackup Job Using Virtual Lab and Linked Job [Using Variable]

This example shows how to create the Exchange SureJob SureBackup job using a virtual lab and a linked job.

$ExchangeBackup = Get-VBRJob -Name "Exchange Backup Job"

$VLab01 = Get-VSBVirtualLab -Name "MailServer VLab 01"

Add-VSBJob -Name "Exchange SureJob" -VirtualLab $VLab01 -LinkedJob $ExchangeBackup

Perform the following steps:

  1. Run the Get-VSBApplicationGroupReturns application groups. This cmdlet is obsolete. Run the Get-VBRApplicationGroup cmdlet instead. cmdlet. Specify the Name parameter value. Save the result to the $ExchangeAppgroup variable.
  2. Run the Get-VSBVirtualLabReturns VMware virtual labs. This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the Get-VBRVirtualLab cmdlet. cmdlet. Specify the Name parameter value. Save the result to the $VLab01 variable.
  3. Run the Add-VSBJob cmdlet. Specify the Name parameter value. Set the $VLab01 variable as the VirtualLab parameter value. Set the $ExchangeAppgroup variable as the AppGroup parameter value.
  • Get-VSBVirtualLabReturns VMware virtual labs. This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the Get-VBRVirtualLab cmdlet.
  • Get-VSBApplicationGroupReturns application groups. This cmdlet is obsolete. Run the Get-VBRApplicationGroup cmdlet instead.
  • Get-VBRJobReturns existing jobs.

Page updated 2026-08-19

Page content applies to build 13.1.1.18