Set-VSBJobOptions (obsolete)

Short Description

Applies custom SureBackup job options.

Note

This cmdlet is obsolete. The cmdlet will still work but may not be supported in further versions.

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. The New-VSBJobOptions cmdlet 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 the Set-VBRJobOptions cmdlet to edit job options of backup, replication or copy job.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies the array of SureBackup jobs. The cmdlet will apply the selected options to these jobs.	Accepts the CSbJob object. To get this object, run the Get-VSBJob cmdlet.	True	1	True (ByValue, ByProperty Name)
Options	Specifies the SureBackup job options you want to apply.	Accepts the CDRJobOptions object. To get this object, run the New-VSBJobOptions cmdlet.	True	2	False

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

Examples

Example 1. Scheduling SureBackup Jobs to Run Daily

This example shows how to apply the customized options to the SureBackup Job 01 SureBackup job.

$SureOptions = New-VSBJobOptions

$SureOptions.EmailNotification = $true

$SureOptions.EmailNotificationAddresses = "mailto@veeam.com"

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

Perform the following steps:

Run the New-VSBJobOptions cmdlet. Save the result to the $SureOptions variable.
Provide the $true value for the EmailNotification property of the $SureOptions variable.
Specify the value for the EmailNotificationAddresses property.
Run the Get-VSBJob cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Set-VSBJobOptions cmdlet. Set the $SureOptions variable as the Options parameter value.

Example 2. Scheduling SureBackup Jobs to Run Daily

This example shows how to apply the customized options to the SureBackup Job 01 SureBackup job.

$SureOptions = New-VSBJobOptions

$SureOptions.EmailNotification = $true

$SureOptions.EmailNotificationAddresses = "mailto@veeam.com"

$SureJob = Get-VSBJob -Name "SureBackup Job 01"

Set-VSBJobOptions -Job $SureJob -Options $SureOptions

Perform the following steps:

Run the New-VSBJobOptions cmdlet. Save the result to the $SureOptions variable.
Provide the $true value for the EmailNotification property of the $SureOptions variable.
Specify the value for the EmailNotificationAddresses property.
Run the Get-VSBJob cmdlet. Specify the Name parameter value. Save the result to the $SureJob variable.
Run the Set-VSBJobOptions cmdlet. Set the $SureJob variable as the Job parameter value. Set the $SureOptions variable as the Options parameter value.

Related Commands

Get-VSBJob