This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRLinuxScheduleOptions
Short Description
Modifies the schedule for backup policies for Linux computers.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus
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.
To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.
|
For Veeam Agent jobs that back up Linux servers use the Set-VBRServerScheduleOptions cmdlet. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Options | Specifies the Linux computers schedule settings that you want to modify. Accepts the VBRLinuxScheduleOptions type. | True | Named | True (ByValue) |
|
Type | Specifies the Veeam Agent backup job schedule type.
| 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 schedule. Specifies periodically schedule settings. The cmdlet will create the server schedule with these settings. Accepts the VBRPeriodicallyOptions type. | False | Named | False |
|
EnableRetry | Indicates that Veeam Agent for Linux will attempt to run the Veeam Agent backup job again in case it fails. | False | Named | False |
|
RetryCount | For the EnableRetry parameter. Specifies the number of attempts to run the failed Veeam Agent backup job. | False | Named | False |
|
RetryTimeout | For the EnableRetry parameter. Specifies a timeout interval between retry attempts in minutes. | False | Named | False |
|
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Return Type
Example
This example shows how to modify an existing schedule for a Veeam Agent job that backs up Linux computers.
- Run Get-VBRJob to get the backup job that you want to modify. Save the result to the $job variable.
- Cast the $job variable to the VBRComputerBackupJob type. Use the [Veeam.Backup.PowerShell.Infos.VBRComputerBackupJob]$ComputerBackupJob value.
- Get the ScheduleOptions object. Save the result to the $schedule variable.
- Cast the $schedule variable to the VBRLinuxScheduleOptions type. Use the [Veeam.Backup.PowerShell.Infos.VBRLinuxScheduleOptions]$LinuxScheduleOptions value. Save the result to the $schedule variable.
- Run New-VBRDailyOptions to specify the daily schedule. Save the result to the $daily variable.
- Run Set-VBRLinuxScheduleOptions with the $schedule and $daily variables. Use the EnableRetry parameter with the RetryCount and RetryTimeout values to set up automatic retry options.
$job = Get-VBRJob -name "Linux_W_job" [Veeam.Backup.PowerShell.Infos.VBRComputerBackupJob]$ComputerBackupJob = $job $schedule=$computerbackupjob.ScheduleOptions [Veeam.Backup.PowerShell.Infos.VBRLinuxScheduleOptions]$LinuxScheduleOptions=$schedule $daily = New-VBRDailyOptions -DayOfWeek Wednesday -Period 17:00 -Type SelectedDays Set-VBRLinuxScheduleOptions -Options $schedule -Type Daily -DailyOptions $daily -EnableRetry -RetryCount 2 -RetryTimeout 45 |
Related Commands
