New-VBRLinuxScheduleOptions
Short Description
Creates the schedule for backup policies for Linux computers.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
New-VBRLinuxScheduleOptions -Type <VBRServerScheduleType> {Daily | Monthly | Periodically | AfterJob} [-DailyOptions <VBRDailyOptions>] [-MonthlyOptions <VBRMonthlyOptions>] [-PeriodicallyOptions <VBRPeriodicallyOptions>] [-EnableRetry] [-RetryCount <int>][-RetryTimeout <int>] [<CommonParameters>] |
Detailed Description
This cmdlet creates the VBRLinuxScheduleOptions object. This object contains schedule settings for a backup policy that the Veeam Agent backup job applies to Linux computers.
|
For Veeam Agent jobs that back up Linux servers use the New-VBRServerScheduleOptions cmdlet. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
---|---|---|---|---|---|
Type | Specifies the Veeam Agent backup job schedule type.
| True | 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 try to run the Veeam Agent backup job 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. Default: 3. | False | Named | False |
|
RetryTimeout | For the EnableRetry parameter. Specifies a timeout 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.
Return Type
Example
This example shows how to create a monthly schedule for a Veeam Agent job that backs up Linux computers. The job will run monthly at 3:00 AM on the first Sunday.
- Run New-VBRMonthlyOptions to specify the monthly schedule. Save the result to the $monthly variable.
- Run New-VBRLinuxScheduleOptions with the $monthly variable. Specify the following parameters:
- Use the EnableRetry parameter to run the job again in case it fails.
- Specify the RetryCount parameter value.
- Specify the RetryTimeout parameter value.
- Set the $monthly option as the MonthlyOptions parameter value.
$monthly = New-VBRMonthlyOptions -Period 3:00 -DayNumberInMonth OnDay -DayOfMonth 20 New-VBRLinuxScheduleOptions -Type Monthly -EnableRetry -RetryCount 7 -RetryTimeout 15 -MonthlyOptions $monthly |
Related Commands