New-VBOJobSchedulePolicy
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>] [-RetryEnabled] [-RetryNumber <int>] [-RetryWaitInterval <int>] [-EnableSchedule] [<CommonParameters>] |
Detailed Description
This cmdlet creates a backup job schedule.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Type | Specifies the job schedule type:
| True | Named | False | False |
DailyType | Specifies the days when the backup job will run:
Default: Everyday. | False | Named | False | False |
DailyTime | Specifies the time when the job will start. Default: 15:00:00. | False | Named | False | False |
Periodically | Specifies the time interval between the job runs:
Default: Minutes5. | False | Named | False | False |
Backup | 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 | 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 | Specifies the number of attempts to run the backup job. Default: 3. | False | Named | False | False |
Retry | Specifies the time intervals between the job retry attempts (minutes): 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 Microsoft Docs.
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:
- Run Get-VBOJob to get a backup job whose schedule settings you want to modify. Save the result to the $job variable.
- Run New-VBOBackupWindowSettings to create a backup window within which the backup job must be completed. Save the result to the $bwindow variable.
- Run New-VBOJobSchedulePolicy with the $bwindow variable to set the job schedule. Save the result to the $daily variable.
- Run Set-VBOJob 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:
- Run Get-VBOJob to get a backup job. Save the result to the $job variable.
- Run New-VBOJobSchedulePolicy to set the job schedule. Save the result to the $every4noretry variable.
- Run Set-VBOJob 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