Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Set-VBRJobScheduleOptions

Short Description

Applies modified job schedule settings to jobs.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRJobScheduleOptions [-Job] <CBackupJob[]> [-Options] <ScheduleOptions> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet applies customized scheduling options to a selected backup, replication or copy job.

Run New-VBRJobScheduleOptions to create the new schedule settings.

You can modify schedule of backup, replication or copy jobs.

Run Set-VSBJobScheduleOptions to set scheduling options to SureBackup job.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

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

True

1

True (ByValue,
ByProperty
Name)

False

Options

Specifies the schedule options you want to apply.

True

2

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This example shows how to schedule the backup job to run repeatedly throughout a day with the time interval of 2 hours.

You will need to perform the following steps:

  1. Run New-VBRJobScheduleOptions to get the new job schedule settings object. Save the result to the $newschedule variable.
  2. Set the OptionsPeriodically parameter to $true to enable the job to run repeatedly.
  3. Specify the value of the OptionsPeriodically parameter in minutes to set the time interval for the job runs.
  4. Run Get-VBRJob to get the job whose schedule settings you want to modify. Save the result to the $job variable.
  5. Run Set-VBRJobScheduleOptions with the $job and $newschedule variables to apply the new schedule settings to the job.

PS C:\PS> $newschedule = New-VBRJobScheduleOptions

PS C:\PS> $newschedule.OptionsPeriodically.Enabled = $true

PS C:\PS> $newschedule.OptionsPeriodically.FullPeriod = 120

PS C:\PS> $job = Get-VBRJob -Name "Backup Job 1"

PS C:\PS> Set-VBRJobScheduleOptions -Job $job -Options $newschedule

Example 2

This command applies the customized scheduling options to the jobs named "DC Backup" and "DC File Copy". The jobs are obtained with Get-VBRJob and piped down. The options to apply are set to the $"Schedule Options" variable beforehand by running New-VBRJobScheduleOptions.

PS C:\PS> Get-VBRJob -Name "DC Backup", "DC File Copy" | Set-VBRJobScheduleOptions -Options $ScheduleOptions

Example 3

This command applies the customized scheduling options to the job represented by the $job variable. The job is obtained with Get-VBRJob and assigned to the variable beforehand. The options to apply are set to the $"Schedule Options" variable beforehand by running New-VBRJobScheduleOptions.

PS C:\PS> Set-VBRJobScheduleOptions -Job $job -Options $ScheduleOptions

Related Commands

Get-VBRJob

New-VBRJobScheduleOptions

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation