Set-VSBJobOptions

Short Description

Applies custom SureBackup job options.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VSBJobOptions [-Job] <CSbJob> [-Options] <CDRJobOptions> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet applies customized job options to SureBackup jobs.

To customize the SureBackup job options you need to first run the New-VSBJobOptions cmdlet. New-VSBJobOptions returns the CDRJobOptions object containing the set of default SureBackup job options. You can customize any of these options and apply further to a SureBackup job.

Run Set-VBRJobOptions to edit job options of backup, replication or copy job.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the array of SureBackup jobs. The cmdlet will apply the selected options to these jobs.

True

1

True (ByValue,
ByProperty
Name)

False

Options

Specifies the SureBackup job options you want to apply.

True

2

False

False

<CommonParameters>

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

Example 1

This command applies the customized options to the SUreBackup job named "SureBackup Job 01". The job object is obtained with Get-VSBJob and piped down. The options to apply are set to the $SureOptions variable beforehand by running New-VSBJobOptions.

Get-VBRJob -Name "SureBackup Job 01" | Set-VSBJobOptions -Options $SureOptions

Example 2

This command applies the customized job options to the SureBackup job represented by the $SureJob variable. The job is obtained with Get-VSBJob and assigned to the variable beforehand. The options to apply are set to the $SureOptions variable beforehand by running New-VSBJobOptions.

Set-VBRJobScheduleOptions -Job $SureJob -Options $SureOptions

Related Commands

Get-VSBJob