New-VBRServerScheduleOptions

Short Description

Creates the schedule for jobs.

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

New-VBRServerScheduleOptions -Type <VBRServerScheduleType> [-DailyOptions <VBRDailyOptions>]

[-MonthlyOptions <VBRMonthlyOptions>] [-PeriodicallyOptions <VBRPeriodicallyOptions>] [-Job <CBackupJob>]

[-EnableRetry] [-RetryCount <Int32>] [-RetryTimeout <Int32>] [-EnableBackupTerminationWindow]

[-TerminationWindow <VBRBackupWindowOptions>] [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRServerScheduleOptions object. This object contains schedule settings for backup jobs.

You can use this cmdlet to create a schedule for the following types of jobs:

Veeam Agent jobs that back up Linux servers.
Veeam Agent jobs that back up failover clusters.
Veeam Agent jobs that back up Windows servers.
The backup policy that the Veeam Agent job applies to Windows servers.
File backup jobs.
VDC replica jobs.
Application backup policies.

Note

Consider the following:

For Veeam Agent jobs that back up Linux workstations, use the New-VBRLinuxScheduleOptions cmdlet.
For the backup policy that Veeam Agent job applies to Windows workstations, use the New-VBRWindowsWorkstationScheduleOptions cmdlet.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
DailyOptions	For daily schedule. Specifies daily schedule settings. The cmdlet will create the server schedule with these settings. Accepts the `VBRDailyOptions` object. To get this object, run the `New-VBRDailyOptions` cmdlet.	`VBRDailyOptions`	False	Named	False
EnableBackupTerminationWindow	Enables the option to stop the Veeam Agent backup job if it exceeds the backup window.	`SwitchParameter`	False	Named	False
EnableRetry	Enables the option to run the Veeam Agent backup job again in case it fails.	`SwitchParameter`	False	Named	False
Job	For running after a job. Specifies the name of the backup job after which Veeam Backup & Replication will run Veeam Agent backup jobs. The cmdlet will create the server schedule with these settings. Accepts the `CBackupJob` object. To get this object, run the `Get-VBRJob` cmdlet.	`CBackupJob`	False	Named	False
MonthlyOptions	For monthly schedule. Specifies monthly schedule settings. The cmdlet will create the server schedule with these settings. Accepts the `VBRMonthlyOptions` object. To get this object, run the `New-VBRMonthlyOptions` cmdlet.	`VBRMonthlyOptions`	False	Named	False
PeriodicallyOptions	For periodical run. Specifies periodical schedule settings. The cmdlet will create the server schedule with these settings. Accepts the `VBRPeriodicallyOptions` object. To get this object, run the `New-VBRPeriodicallyOptions` cmdlet.	`VBRPeriodicallyOptions`	False	Named	False
RetryCount	For the `EnableRetry` parameter. Specifies the number of attempts to run the failed Veeam Agent backup job. Default: `3`.	`Int32`	False	Named	False
RetryTimeout	For the `EnableRetry` parameter. Specifies the time interval between retry attempts in minutes. Default: `30`.	`Int32`	False	Named	False
TerminationWindow	Specifies the time interval within which the backup job must complete. The cmdlet will create the Veeam Agent backup job with these settings. Accepts the `VBRBackupWindowOptions` object. To create this object, run the `New-VBRBackupWindowOptions` cmdlet.	`VBRBackupWindowOptions`	False	Named	False
Type	Specifies the backup job schedule type. `Daily`: use this option to run the job at a specific time daily. `Monthly`: use this option to run the job once a month on specific days. `Periodically`: use this option to run the job repeatedly throughout a day with a specific time interval. `AfterJob`: use this option to create a chain of jobs. Veeam Backup & Replication will start the Veeam Agent backup job after the other backup job. Note: The `AfterJob` option does not work for backup policy.	`VBRServerScheduleType`	True	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

This cmdlet returns the VBRServerScheduleOptions object that contains schedule settings for backup jobs.

Examples

Creating Server Schedule for Veeam Agent Backup Job

This example shows how to create the server schedule for a Veeam Agent backup job. The job will run on Fridays at 7:00 PM.

$daily = New-VBRDailyOptions -DayOfWeek Friday -Period 7:00

New-VBRServerScheduleOptions -Type Daily -DailyOptions $daily

Perform the following steps:

Run the New-VBRDailyOptions cmdlet. Specify the DayOfWeek and Period parameter values. Save the result to the $daily variable.
Run the New-VBRServerScheduleOptions cmdlet. Set the Daily value as the Type parameter value. Set the $daily variable as the DailyOptions parameter value.

New-VBRDailyOptions