This is an archive version of the document. To get the most up-to-date information, see the current version.

New-VBRMacScheduleOptions

Short Description

Defines the schedule for macOS jobs.

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

Syntax

New-VBRMacScheduleOptions -Type {Daily | Monthly | Periodically | AfterJob} [-DailyOptions <VBRDailyOptions>][-MonthlyOptions <VBRMonthlyOptions>] [-PeriodicallyOptions <VBRPeriodicallyOptions>] [-EnableRetry] [-RetryCount<int>] [-RetryTimeout <int>] [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRMacScheduleOptions object that defines schedule for macOS jobs.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input
Type	Specifies the macOS 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 macOS job after the other backup job. NOTE: The AfterJob option does not work for backup policy.	True	Named	False
DailyOptions	For daily schedule. Specifies daily schedule settings. The cmdlet will create the server schedule with these settings. Accepts the VBRDailyOptions type.	False	Named	False
MonthlyOptions	For monthly schedule. Specifies monthly schedule settings. The cmdlet will create the server schedule with these settings. Accepts the VBRMonthlyOptions type.	False	Named	False
PeriodicallyOptions	For periodical run. Specifies periodical schedule settings. The cmdlet will create the server schedule with these settings. Accepts the VBRPeriodicallyOptions type.	False	Named	False
EnableRetry	Indicates that Veeam Backup & Replication will attempt to run a macOS job again in case it fails.	False	Named	False
RetryCount	For the EnableRetry parameter. Specifies the number of attempts to run the failed macOS backup job. Default: 3.	False	Named	False
RetryTimeout	For the EnableRetry parameter. Specifies the time interval between retry attempts in minutes. Default: 30.	False	Named	False

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

Output Object

The cmdlet returns the VBRMacScheduleOptions object that defines schedule for macOS jobs.

Examples

Defining Schedule for MacOS Jobs

This example shows how to define schedule for MacOS jobs. The job will run on Fridays at 7:00 PM.

Run New-VBRDailyOptions to specify the daily schedule options. Save the result to the $daily variable.
Run New-VBRMacScheduleOptions with the $daily variable. Use the Type parameter to specify the type of the schedule.

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

$macschedule = New-VBRMacScheduleOptions -Type Daily -DailyOptions $daily

Related Commands

New-VBRDailyOptions