New-VBOJobSchedulePolicy

Short Description

Creates a backup job schedule.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Create periodical job schedule.

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

  • Create daily job schedule.

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

Detailed Description

This cmdlet creates a backup job schedule.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

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

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

DailyTime

Specifies the time to start the backup job.

Default: 15:00:00

TimeSpan

False

Named

False

DailyType

Specifies the days when the backup job will run:

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

Default: Everyday

VBODailyType

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

PeriodicallyEvery

Specifies the time interval between the job runs:

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

Default: Minutes5

VBOPeriodicInterval

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

<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

New-VBOJobSchedulePolicyExample 1. Creating Daily Schedule for Backup Job

New-VBOJobSchedulePolicyExample 2. Creating Periodical Schedule for Backup Job

Related Commands

Page updated 5/7/2024

Page content applies to build 8.1.1.159