New-VBRMacScheduleOptions

Short Description

Defines the schedule for macOS jobs.

Applies to

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

Type

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.

VBRServerScheduleType

True

Named

False

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.

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.

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.

False

Named

False

EnableRetry

Enables the option to run a macOS job again in case it fails.

SwitchParameter

False

Named

False

RetryCount

For the EnableRetry parameter.

Specifies the number of attempts to run the failed macOS backup job.

Default: 3.

Int

False

Named

False

RetryTimeout

For the EnableRetry parameter.

Specifies the time interval between retry attempts in minutes.

Default: 30.

Int

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see 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.

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

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

Perform the following steps:

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

Related Commands

New-VBRDailyOptions