New-VBOJobSchedulePolicy

Short Description

Creates a backup job schedule.

Syntax

This cmdlet provides the following parameter sets:

Daily (Default)

New-VBOJobSchedulePolicy [-EnableSchedule] [-Type <VBOJobFrequencyType>] [-DailyTime <TimeSpan>]

[-DailyType <VBODailyType>] [-BackupWindowSettings <VBOBackupWindowSettings>] [-RetryEnabled]

[-RetryNumber <Int32>] [-RetryWaitInterval <Int32>] [<CommonParameters>]

Periodically

New-VBOJobSchedulePolicy [-EnableSchedule] [-Type <VBOJobFrequencyType>]

[-PeriodicallyEvery <VBOPeriodicInterval>] [-BackupWindowSettings <VBOBackupWindowSettings>]

[-PeriodicallyWindowSettings <VBOBackupWindowSettings>] [-PeriodicallyOffsetMinutes <Int32>] [-RetryEnabled]

[-RetryNumber <Int32>] [-RetryWaitInterval <Int32>] [<CommonParameters>]

Detailed Description

This cmdlet creates a backup job schedule.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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.	`VBOBackupWindowSettings`	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
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
PeriodicallyEvery	Specifies the time interval between the job runs: `Minutes5` `Minutes10` `Minutes15` `Minutes30` `Hours1` `Hours2` `Hours4` `Hours8` `Hours12` Default: Minutes5	`VBOPeriodicInterval`	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
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.	`VBOBackupWindowSettings`	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
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

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns the VBOJobSchedulePolicy object that contains the backup job schedule settings.

Examples

New-VBOJobSchedulePolicy Example 1: Creating Daily Schedule for Backup Job

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.

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

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

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

Set-VBOJob -Job $job -SchedulePolicy $daily

Perform the following steps:

Run the Get-VBOJob cmdlet to get a backup job whose schedule settings you want to configure. Save the result to the $job variable.
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.
Run the New-VBOJobSchedulePolicy cmdlet with the $bwindow variable to set the job schedule. Save the result to the $daily variable.
Run the Set-VBOJob cmdlet with the $job and $daily variables to apply new schedule settings to the backup job.

New-VBOJobSchedulePolicy Example 2: Creating Periodical Schedule for Backup Job

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 365 will not restart a backup job if it fails.

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

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

Set-VBOJob -Job $job -SchedulePolicy $every4noretry

Perform the following steps:

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