New-VBOJobSchedulePolicy

In this article

    Short Description

    Creates a backup job schedule.

    Syntax

    This cmdlet provides the following parameter sets:

    • Create daily job schedule.

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

    • Create periodical job schedule.

    New-VBOJobSchedulePolicy -Type <VBOJobFrequencyType> {Periodically | Daily} [-DailyTime <timespan>] [-DailyType <VBODailyType> {Everyday | Workdays | Weekends | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-BackupWindowSettings <VBOBackupWindowSettings>] [-PeriodicallyWindowSettings <VBOBackupWindowSettings>] [-PeriodicallyOffsetMinutes <int>] [-RetryEnabled] [-RetryNumber <int>] [-RetryWaitInterval <int>] [-EnableSchedule]  [<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

    PeriodicallyEvery

    Specifies the time interval between the job runs:

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

    Default: Minutes5.

    False

    Named

    False

    False

    BackupWindowSettings

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

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

    False

    Named

    False

    False

    PeriodicallyWindowSettings

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

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

    False

    Named

    False

    False

    PeriodicallyOffsetMinutes

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

    Permitted value: 0–59.

    Default: 0.

    False

    Named

    False

    False

    RetryEnabled

    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

    RetryNumber

    Specifies the number of attempts to run the backup job.

    Permitted value: 1–-777.

    Default: 3.

    False

    Named

    False

    False

    RetryWaitInterval

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

    Permitted value: 1–999.

    Default: 10.

    False

    Named

    False

    False

    EnableSchedule

    Indicates that the backup job will be configured to follow this schedule. Otherwise, the backup job will not be scheduled.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Examples

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

    $job = Get-VBOJob -Name "ABC: Sales"

    $bwindow = New-VBOBackupWindowSettings -FromDay Monday -FromHour 8 -ToDay Sunday -ToHour 17 -Enabled

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

    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 the Get-VBOJob cmdlet to get a backup job. Save the result to the $job variable.
    2. Run the New-VBOJobSchedulePolicy cmdlet to set the job schedule. Save the result to the $every4noretry variable.
    3. Run the Set-VBOJob cmdlet with the $job and $every4noretry variables.

    $job = Get-VBOJob -Name "ABC: Sales"

    $every4noretry = New-VBOJobSchedulePolicy -Type Periodically -PeriodicallyEvery Hours4 -RetryEnabled:$False

    Set-VBOJob -Job $job -SchedulePolicy $every4noretry

    Related Commands