Set-VSBJobScheduleOptions (obsolete)

Short Description

Applies customized job scheduling options to a selected SureBackup job.

Note

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

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VSBJobScheduleOptions [[-Job] <CSbJob>] [[-Options] <ScheduleOptions>] [<CommonParameters>]

Detailed Description

This cmdlet applies customized scheduling options to a selected SureBackup job.

To customize the scheduling options you need to first run the New-VBRJobScheduleOptionsCreates new job schedule options. This cmdlet is obsolete. You can still run this cmdlet but, depending on the job type, it is recommended to run one of the following cmdlets: - The New-VBRServerScheduleOptions cmdlet to define schedule settings for backup jobs. - The New-VBRWindowsWorkstationScheduleOptions cmdlet to create a job schedule for Windows workstations. - The New-VBRLinuxScheduleOptions cmdlet to create a job schedule for Linux computers. - The New-VBRMacScheduleOptions cmdlet to create a job schedule for macOS computers. - The Set-VBRJobSchedule cmdlet to modify a job schedule. cmdlet. The New-VBRJobScheduleOptionsCreates new job schedule options. This cmdlet is obsolete. You can still run this cmdlet but, depending on the job type, it is recommended to run one of the following cmdlets: - The New-VBRServerScheduleOptions cmdlet to define schedule settings for backup jobs. - The New-VBRWindowsWorkstationScheduleOptions cmdlet to create a job schedule for Windows workstations. - The New-VBRLinuxScheduleOptions cmdlet to create a job schedule for Linux computers. - The New-VBRMacScheduleOptions cmdlet to create a job schedule for macOS computers. - The Set-VBRJobSchedule cmdlet to modify a job schedule. returns the ScheduleOptions object containing the set of default scheduling options. You can customize any of these options and apply further to any kind of jobs.

Run the Set-VBRJobScheduleOptionsApplies modified job schedule settings to jobs. This cmdlet is obsolete. You can still run this cmdlet, but it is recommended to modify job schedule using the Set-VBRJobSchedule cmdlet. cmdlet to set scheduling options of backup, replication or copy job.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies the array of the SureBackup jobs. The cmdlet will apply the schedule settings to these jobs.

Accepts the CSbJob object. To get this object, run the Get-VSBJobReturns SureBackup jobs. This cmdlet is obsolete. Run the Get-VBRSureBackupJob cmdlet instead. cmdlet.

CSbJob

False

0

True (ByPropertyName, ByValue)

Options

Specifies the SureBackup job schedule options you want to apply.

Accepts the ScheduleOptions object. To get this object, run the New-VBRJobScheduleOptionsCreates new job schedule options. This cmdlet is obsolete. You can still run this cmdlet but, depending on the job type, it is recommended to run one of the following cmdlets: - The New-VBRServerScheduleOptions cmdlet to define schedule settings for backup jobs. - The New-VBRWindowsWorkstationScheduleOptions cmdlet to create a job schedule for Windows workstations. - The New-VBRLinuxScheduleOptions cmdlet to create a job schedule for Linux computers. - The New-VBRMacScheduleOptions cmdlet to create a job schedule for macOS computers. - The Set-VBRJobSchedule cmdlet to modify a job schedule. cmdlet.

ScheduleOptions

False

1

False

<CommonParameters>

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

Examples

Set-VSBJobScheduleOptions (obsolete)Example 1. Applying Scheduling Options to SureBackup Jobs [Using Pipeline]

This example shows how to apply the customized scheduling options to the SharePoint SureJob and MailServer SureJob SureBackup jobs.

$ScheduleOptions = New-VBRJobScheduleOptions

$ScheduleOptions.OptionsPeriodically.Enabled = $true

$ScheduleOptions.OptionsPeriodically.FullPeriod = 120

Get-VSBJob -Name "SharePoint SureJob", "MailServer SureJob" | Set-VSBJobScheduleOptions -Options $ScheduleOptions

Perform the following steps:

  1. Run the New-VBRJobScheduleOptionsCreates new job schedule options. This cmdlet is obsolete. You can still run this cmdlet but, depending on the job type, it is recommended to run one of the following cmdlets: - The New-VBRServerScheduleOptions cmdlet to define schedule settings for backup jobs. - The New-VBRWindowsWorkstationScheduleOptions cmdlet to create a job schedule for Windows workstations. - The New-VBRLinuxScheduleOptions cmdlet to create a job schedule for Linux computers. - The New-VBRMacScheduleOptions cmdlet to create a job schedule for macOS computers. - The Set-VBRJobSchedule cmdlet to modify a job schedule. cmdlet. Save the result to the $ScheduleOptions variable.
  2. Provide the $true value for the OptionsPeriodically property of the $ScheduleOptions variable.
  3. Specify the value for the OptionsPeriodically property in minutes.
  4. Run the Get-VSBJobReturns SureBackup jobs. This cmdlet is obsolete. Run the Get-VBRSureBackupJob cmdlet instead. cmdlet. Specify the Name parameter value.
  5. Pipe the cmdlet output to the Set-VSBJobScheduleOptions cmdlet. Set the $ScheduleOptions variable as the Options parameter value.

Set-VSBJobScheduleOptions (obsolete)Example 2. Applying Scheduling Options to SureBackup Jobs [Using Variable]

This example shows how to apply the customized scheduling options to the SharePoint SureJob and MailServer SureJob SureBackup jobs.

$ScheduleOptions = New-VBRJobScheduleOptions

$ScheduleOptions.OptionsPeriodically.Enabled = $true

$ScheduleOptions.OptionsPeriodically.FullPeriod = 120

$SureJob = Get-VSBJob -Name "SharePoint SureJob", "MailServer SureJob"

Set-VSBJobScheduleOptions -Job $SureJob -Options $ScheduleOptions

Perform the following steps:

  1. Run the New-VBRJobScheduleOptionsCreates new job schedule options. This cmdlet is obsolete. You can still run this cmdlet but, depending on the job type, it is recommended to run one of the following cmdlets: - The New-VBRServerScheduleOptions cmdlet to define schedule settings for backup jobs. - The New-VBRWindowsWorkstationScheduleOptions cmdlet to create a job schedule for Windows workstations. - The New-VBRLinuxScheduleOptions cmdlet to create a job schedule for Linux computers. - The New-VBRMacScheduleOptions cmdlet to create a job schedule for macOS computers. - The Set-VBRJobSchedule cmdlet to modify a job schedule. cmdlet. Save the result to the $ScheduleOptions variable.
  2. Provide the $true value for the OptionsPeriodically property of the $ScheduleOptions variable.
  3. Specify the value for the OptionsPeriodically property in minutes.
  4. Run the Get-VSBJobReturns SureBackup jobs. This cmdlet is obsolete. Run the Get-VBRSureBackupJob cmdlet instead. cmdlet. Specify the Name parameter value. Save the result to the $SureJob variable.
  5. Run the Set-VSBJobScheduleOptions cmdlet. Set the $SureJob variable as the Job parameter value. Set the $ScheduleOptions variable as the Options parameter value.
  • Get-VSBJobReturns SureBackup jobs. This cmdlet is obsolete. Run the Get-VBRSureBackupJob cmdlet instead.
  • New-VBRJobScheduleOptionsCreates new job schedule options. This cmdlet is obsolete. You can still run this cmdlet but, depending on the job type, it is recommended to run one of the following cmdlets: - The New-VBRServerScheduleOptions cmdlet to define schedule settings for backup jobs. - The New-VBRWindowsWorkstationScheduleOptions cmdlet to create a job schedule for Windows workstations. - The New-VBRLinuxScheduleOptions cmdlet to create a job schedule for Linux computers. - The New-VBRMacScheduleOptions cmdlet to create a job schedule for macOS computers. - The Set-VBRJobSchedule cmdlet to modify a job schedule.

Page updated 2026-08-19

Page content applies to build 13.1.1.18