Set-VBRMacScheduleOptions

Short Description

Modifies schedule for macOS jobs.

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

Syntax

Set-VBRMacScheduleOptions -Options <VBRMacScheduleOptions> [-Type <VBRServerScheduleType>]

[-DailyOptions <VBRDailyOptions>] [-MonthlyOptions <VBRMonthlyOptions>]

[-PeriodicallyOptions <VBRPeriodicallyOptions>] [-EnableRetry] [-RetryCount <Int32>] [-RetryTimeout <Int32>]

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

Detailed Description

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

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

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 a macOS job again in case it fails.	`SwitchParameter`	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
Options	Specifies schedule settings for macOS jobs that you want to modify. Accepts the `VBRMacScheduleOptions` object. To get this object, run the `New-VBRMacScheduleOptions` cmdlet.	`VBRMacScheduleOptions`	True	Named	True (ByValue)
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 macOS 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. Accepts the `VBRBackupWindowOptions` object. To create this object, run the `New-VBRBackupWindowOptions` cmdlet.	`VBRBackupWindowOptions`	False	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.	`VBRServerScheduleType`	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 modify schedule for macOS jobs. The job schedule will be set to run on Wednesday instead of Fridays. The example also restricts the job to a backup window from 20:00 to 22:59, Monday to Friday.

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

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

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

$window = New-VBRBackupWindowOptions -FromDay Monday -ToDay Friday -FromHour 20 -ToHour 22 -Enabled

Set-VBRMacScheduleOptions -Options $macschedule -DailyOptions $newdaily -EnableBackupTerminationWindow -TerminationWindow $window

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-VBRMacScheduleOptions cmdlet. Set the Daily option for the Type parameter. Set the $daily variable as the DailyOptions parameter value. Save the result to the $macschedule variable.
Run the New-VBRDailyOptions cmdlet. Specify the DayOfWeek and Period parameter values. Save the result to the $newdaily variable.
Run the New-VBRBackupWindowOptions cmdlet. Specify the FromDay, ToDay, FromHour and ToHour parameter values. Provide the Enabled parameter. Save the result to the $window variable.
Run the Set-VBRMacScheduleOptions cmdlet. Set the $macschedule variable as the Options parameter value. Set the $newdaily variable as the DailyOptions parameter value. Provide the EnableBackupTerminationWindow parameter. Set the $window variable as the TerminationWindow parameter value.