Set-VBRViSureBackupJob

Short Description

Modifies settings of SureBackup jobs.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRViSureBackupJob -Job <VBRSureBackupJob> [-Name <string>] [-Description <string>] [-VirtualLab <VBRVirtualLab>] [-ApplicationGroup <VBRApplicationGroup>] [-KeepApplicationGroupRunning] [-LinkedJob <VBRSureBackupLinkedJob[]>] [-EnableLinkJob] [-MaxConcurrentVMs <int>] [-VerificationOptions <VBRSureBackupJobVerificationOptions>] [-ScheduleOptions <VBRSureBackupJobScheduleOptions>] [-EnableSchedule] [-Force]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of SureBackup jobs

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies a SureBackup job. The cmdlet will modify settings of this job.

Accepts the VBRSureBackupJob object. To create this object, run the Get-VBRSureBackupJob cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Name

Specifies a name for a SureBackup job. The cmdlet will replace an existing name of the SureBackup job with this name.

String

False

Named

False

Description

Specifies a description for a SureBackup job. The cmdlet will replace an existing description of the SureBackup job with this description.

String

False

Named

False

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.

False

Named

False

ApplicationGroup

Specifies an application group. Veeam Backup & Replication will use this application group to use for recovery verification.

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

EnableLinkJob

Defines that the cmdlet will link jobs with VMs that you want to verify with the SureBackup job.

If you provide this parameter, the Veeam Backup & Replication will verify VMs that are added to specified jobs with the SureBackup job. Otherwise, Veeam Backup & Replication will verify VMs from the application group only.

Provide the LinkedJob parameter to specify jobs that you want to link to a SureBackup job.

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.

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 recovery verification options for every VM from the jobs linked to the SureBackup job:

Accepts the VBRSureBackupJobVerificationOptions object. To create this object, run the New-VBRSureBackupJobVerificationOptions cmdlet.

False

Named

False

EnableSchedule

Defines that the cmdlet will enable a schedule for a SureBackup job.

If you provide this option, the SureBackup job will run according the specified schedule. Otherwise, you must start the job manually.

Provide the ScheduleOptions parameter to specify the schedule options.

SwitchParamter

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

Force

Defines that the cmdlet will not show any warnings.

SwitchParamter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

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

Examples

Set-VBRViSureBackupJobExample 1. Modifying Application Group of SureBackup Job

This example shows how to modify an application group for the Exchange Job SureBackup job. The SureBackup job will verify VMs that are added to the Exchange Application Group Application Group.

$surejob = Get-VBRSureBackupJob -Name "Exchange Job"

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

Set-VBRViSureBackupJob -Job $surejob -ApplicationGroup $appgroup

Perform the following steps:

  1. Run the Get-VBRSureBackupJob cmdlet. Specify the Name parameter value. Save the result to the $surejob variable.
  2. Run the Get-VBRApplicationGroup cmdlet. Specify the Name parameter value. Save the result to the $appgroup variable.
  3. Run the Set-VBRViSureBackupJob cmdlet. Set the $surejob variable as the Job parameter value. Set the $appgroup variable as the ApplicationGroup parameter value.

Set-VBRViSureBackupJobExample 2. Modifying Virtual Lab of SureBackup Job

This example shows how to modify a virtual lab for the Exchange Job SureBackup job. The SureBackup job will use the Exchange Lab virtual lab to verify VMs.

$surejob = Get-VBRSureBackupJob -Name "Exchange Job"

$lab = Get-VBRVirtualLab -Name "Exchange Lab"

Set-VBRViSureBackupJob -Job $surejob -VirtualLab $lab

Perform the following steps:

  1. Run the Get-VBRSureBackupJob cmdlet. Specify the Name parameter value. Save the result to the $surejob variable.
  2. Run the Get-VBRVirtualLab cmdlet. Specify the Name parameter value. Save the result to the $lab variable..
  3. Run the Set-VBRViSureBackupJob cmdlet. Set the $surejob variable as the Job parameter value. Set the $lab variable as the VirtualLab parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.