Set-VBRMacScheduleOptions

Short Description

Modifies schedule for macOS jobs.

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

Syntax

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

Detailed Description

This cmdlet modifies schedule for macOS jobs, created with Veeam Agent for Oracle Solaris or Veeam Agent for IBM AIX.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Options

Specifies schedule settings for macOS jobs that you want to modify.

Accepts the VBRMacScheduleOptions cmdlet.

True

Named

False

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.

False

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

<CommonParameters>

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 modify schedule for macOS jobs. The job schedule will be set to run on Wednesday instead of Fridays.

  1. Run New-VBRDailyOptions to specify the daily schedule options. Save the result to the $daily variable.
  2. Run New-VBRMacScheduleOptions with the $daily variable. Use the Type parameter to specify the type of the schedule.
  3. Run New-VBRDailyOptions to specify the daily schedule options. Save the result to the $newdaily variable.
  4. Run New-VBRMacScheduleOptions with the $newdaily variable. Use the DailyOptions parameters to specify the schedule.

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

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

$newdaily = New-VBRDailyOptions -DayOfWeek Wednesday -Period 7:00

Set-VBRMacScheduleOptions -Options $macschedule -DailyOptions $newdaily

Related Commands