Set-VBOJobSchedulePolicy

Short Description

Modifies the backup job schedule settings.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Change the schedule type to Periodically.

Set-VBOJobSchedulePolicy -Policy <VBOJobSchedulePolicy> [-Type <VBOJobFrequencyType>] [-PeriodicallyEvery <VBOPeriodicInterval>] [-BackupWindowEnabled] [-PeriodicallyWindowSettings <VBOBackupWindowSettings>] [-PeriodicallyOffsetMinutes <Int32>] [-BackupWindowSettings <VBOBackupWindowSettings>] [-RetryEnabled] [-RetryNumber <Int32>] [-RetryWaitInterval <Int32>] [-EnableSchedule] [<CommonParameters>]

  • Change the schedule type to Daily.

Set-VBOJobSchedulePolicy -Policy <VBOJobSchedulePolicy> [-Type <VBOJobFrequencyType>] [-DailyTime <TimeSpan>] [-DailyType <VBODailyType>] [-BackupWindowEnabled] [-BackupWindowSettings <VBOBackupWindowSettings>] [-RetryEnabled] [-RetryNumber <Int32>] [-RetryWaitInterval <Int32>] [-EnableSchedule] [<CommonParameters>]

Detailed Description

This cmdlet modifies the backup job schedule settings. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Policy

Specifies the backup job schedule whose settings you want to modify.

Accepts the VBOJobSchedulePolicy object.

To create this object, run the New-VBOJobSchedulePolicy cmdlet.

True

Named

True (ByValue)

Type

Specifies a type of the backup job schedule:

  • Daily: runs the backup job on specific days at the specified hours.
  • Periodically: runs the backup job repeatedly throughout a day with a specific time interval.

VBOJobFrequencyType

False

Named

False

PeriodicallyEvery

Specifies the time interval between the job runs:

  • Minutes5
  • Minutes10
  • Minutes15
  • Minutes30
  • Hours1
  • Hours2
  • Hours4
  • Hours8
  • Hours12

VBOPeriodicInterval

False

Named

False

BackupWindowEnabled

Defines that the job run will be terminated if it exceeds the allowed backup window.

Default: False

SwitchParameter

False

Named

False

PeriodicallyWindowSettings

Specifies the backup window within which the backup job will run periodically.

Accepts the VBOBackupWindowSettings object.

To create this object, run the New-VBOBackupWindowSettings cmdlet.

False

Named

False

PeriodicallyOffsetMinutes

Specifies the offset within an hour in minutes after which the job must start according to the periodic schedule.

Permitted values: 0–59.

Default: 0

Int32

False

Named

False

BackupWindowSettings

Specifies the backup window within which the backup job must be completed.

Accepts the VBOBackupWindowSettings object.

To create this object, run the New-VBOBackupWindowSettings cmdlet.

False

Named

False

RetryEnabled

Defines that Veeam Backup for Microsoft 365 will attempt to run a backup job again if the job fails for some reason.

Default: False

SwitchParameter

False

Named

False

RetryNumber

Specifies the number of attempts to run the backup job.

Permitted values: 1–777.

Default: 3

Int32

False

Named

False

RetryWaitInterval

Specifies the time intervals between the job retry attempts in minutes.

Permitted values: 1–999.

Default: 10

Int32

False

Named

False

EnableSchedule

Defines that the backup job will be configured to follow this schedule. If you set this parameter to the EnableSchedule:$false value, the backup job will not be scheduled.

Default: True

SwitchParameter

False

Named

False

DailyTime

Specifies the time to start the backup job.

TimeSpan

False

Named

False

DailyType

Specifies the days when the backup job will run:

  • Everyday
  • Weekends
  • Workdays
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday

VBODailyType

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 VBOJobSchedulePolicy object that contains the backup job schedule settings.

Examples

Set-VBOJobSchedulePolicyExample 1. Modifying Backup Job Schedule Settings

Set-VBOJobSchedulePolicyExample 2. Changing Backup Job Schedule Type from Daily to Periodically

Set-VBOJobSchedulePolicyExample 3. Changing Backup Job Schedule Type from Periodically to Daily

Related Commands

Page updated 5/7/2024

Page content applies to build 8.1.1.159