Set-VBRLinuxScheduleOptions

Short Description

Modifies the schedule for backup policies for Linux computers.

Applies to

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

Syntax

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

Detailed Description

This cmdlet modifies schedule settings for a backup policy that the Veeam Agent backup job applies to Linux computers.

Important

For Veeam Agent jobs that back up Linux servers use the Set-VBRServerScheduleOptions cmdlet.

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

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Options	Specifies the Linux computers schedule settings that you want to modify.	Accepts the VBRLinuxScheduleOptions object. To get this object, run the New-VBRLinuxScheduleOptions cmdlet.	True	Named	True (ByValue)
Type	Specifies the Veeam Agent 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 run the job repeatedly throughout a day with a specific time interval.	VBRServerScheduleType	False	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 schedule. Specifies periodically 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 for the Veeam Agent for Linux to run the Veeam Agent backup job again in case it fails.	SwitchParameter	False	Named	False
RetryCount	For the EnableRetry parameter. Specifies the number of attempts to run the failed Veeam Agent backup job.	Int	False	Named	False
RetryTimeout	For the EnableRetry parameter. Specifies a timeout interval between retry attempts in minutes.	Int	False	Named	False

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

Output Object

This cmdlet returns the VBRLinuxScheduleOptions object that contains the schedule for the backup policies for Linux computers.

Examples

Modifying Schedule for Veeam Agent Job for Linux Computers

This example shows how to modify an existing schedule for a Veeam Agent job that backs up Linux computers.

$job = Get-VBRComputerBackupJob -Name "Linux_W_job"

$monthly = New-VBRMonthlyOptions -Period 3:00 -DayNumberInMonth OnDay -DayOfMonth 20

$options = New-VBRLinuxScheduleOptions -Type Monthly -EnableRetry -RetryCount 7 -RetryTimeout 15 -MonthlyOptions $monthly

$daily = New-VBRDailyOptions -DayOfWeek Wednesday -Period 17:00 -Type SelectedDays

Set-VBRLinuxScheduleOptions -Options $options -Type Daily -DailyOptions $daily -EnableRetry -RetryCount 2 -RetryTimeout 45

Perform the following steps:

Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the New-VBRMonthlyOptions cmdlet. Specify the Period, DayNumberInMonth and DayOfMonth parameter values. Save the result to the $monthly variable.
Run the New-VBRLinuxScheduleOptions cmdlet. Specify the following settings:

Set the Monthly value as the Type parameter value.
Provide the EnableRetry parameter.
Specify the RetryCount parameter value.
Specify the RetryTimeout parameter value.
Set the $monthly variable as the MonthlyOptions parameter value.

Save the result to the $options variable.

Run the New-VBRDailyOptions cmdlet. Specify the DayOfWeek, Period and Type parameter values. Save the result to the $daily variable.
Run the Set-VBRLinuxScheduleOptions cmdlet. Specify the following settings:

Set the $options variable as the Options parameter value.
Set the Daily value as the Type parameter value.
Set the $daily variable as the DailyOptions parameter value.
Provide the EnableRetry parameter.
Specify the RetryCount parameter value.
Specify the RetryTimeout parameter value.

Related Commands