Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
PowerShell Reference

New-VBOJobSchedulePolicy

Short Description

Creates a backup job schedule.

Syntax

This cmdlet provides 2 parameter sets.

  • For creating daily job schedule:

New-VBOJobSchedulePolicy -Type <VBOJobFrequencyType> {Periodically | Daily} [-PeriodicallyEvery <VBOPeriodicInterval> {Minutes5 | Minutes10 | Minutes15 | Minutes30 | Hours1 | Hours2 | Hours4 | Hours8}] [-BackupWindow <VBOBackupWindow>] [-RetryEnabled] [-RetryNumber <int>] [-RetryWaitInterval <int>] [<CommonParameters>]

  • For creating periodical job schedule:

New-VBOJobSchedulePolicy -Type <VBOJobFrequencyType> {Periodically | Daily} [-DailyTime <timespan>] [-DailyType <VBODailyType> {Everyday | Workdays | Weekends | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-BackupWindow <VBOBackupWindow>] [-RetryEnabled] [-RetryNumber <int>] [-RetryWaitInterval <int>] [<CommonParameters>]

Detailed Description

This cmdlet creates a backup job schedule.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Type

Specifies the job schedule type:

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

True

Named

False

False

DailyType

Specifies the days when the backup job will run:

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

Default: Everyday.

False

Named

False

False

DailyTime

Specifies the time when the job will start.

Default: 15:00:00.

False

Named

False

False

Periodically
Every

Specifies the time interval between the job runs:

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

Default: Minutes5.

False

Named

False

False

Backup
Window

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

For more information on how to create a backup window, see New-VBOBackupWindowSettings.

False

Named

False

False

Retry
Enabled

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

Default: True.

False

Named

False

False

Retry
Number

Specifies the number of attempts to run the backup job.

Default: 3.

False

Named

False

False

Retry
Wait
Interval

Specifies the time intervals between the job retry attempts (minutes):

Default: 10.

False

Named

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 configure a daily job schedule for a backup job. A job schedule will have the following settings:

  • A backup job will run everyday at 8 AM.
  • A backup job will stop if its processing exceeds the allowed backup window.

You will need to perform the following steps:

  1. Run Get-VBOJob to get a backup job whose schedule settings you want to modify. Save the result to the $job variable.
  2. Run New-VBOBackupWindowSettings to create a backup window within which the backup job must be completed. Save the result to the $bwindow variable.
  3. Run New-VBOJobSchedulePolicy with the $bwindow variable to set the job schedule. Save the result to the $daily variable.
  4. Run Set-VBOJob with the $job and $daily variables to apply new schedule settings to the backup job.

PS C:\PS> $job = Get-VBOJob -Name "ABC: Sales"

PS C:\PS> $bwindow = New-VBOBackupWindowSettings -FromDay Monday -FromHour 8 -ToDay Sunday -ToHour 17 -Enabled

PS C:\PS> $daily = New-VBOJobSchedulePolicy -Type Daily -DailyType Everyday -DailyTime 08:00:00 -BackupWindow $bwindow

PS C:\PS> Set-VBOJob -Job $job -SchedulePolicy $daily

Example 2

This example shows how to configure a periodical job schedule for a backup job. A job schedule will have the following settings:

  • A backup job will run every 4 hours.
  • Veeam Backup for Microsoft Office 365 will not restart a backup job if it fails.

You will need to perform the following steps:

  1. Run Get-VBOJob to get a backup job. Save the result to the $job variable.
  2. Run New-VBOJobSchedulePolicy to set the job schedule. Save the result to the $every4noretry variable.
  3. Run Set-VBOJob with the $job and $every4noretry variables.

PS C:\PS> $job = Get-VBOJob -Name "ABC: Sales"

PS C:\PS> $every4noretry = New-VBOJobSchedulePolicy -Type Periodically -PeriodicallyEvery Hours4 -RetryEnabled:$False

PS C:\PS> Set-VBOJob -Job $job -SchedulePolicy $every4noretry

Related Commands

Get-VBOJob

New-VBOBackupWindowSettings

Set-VBOJob

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference