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.
Note: |
For Veeam Agent jobs that back up Linux servers use the New-VBRServerScheduleOptions cmdlet. |
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
Type | Specifies the Veeam Agent backup job schedule type.
| VBRServerScheduleType | True | 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 try to run the Veeam Agent backup job 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. Default: 3. | Int | False | Named | False |
RetryTimeout | For the EnableRetry parameter. Specifies a timeout interval between retry attempts in minutes. Default: 30. | Int | False | Named | False |
<CommonParameters>
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
Creating Monthly Schedule for Veeam Agent Job for Linux Computers
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.
$monthly = New-VBRMonthlyOptions -Period 3:00 -DayNumberInMonth OnDay -DayOfMonth 20 New-VBRLinuxScheduleOptions -Type Monthly -EnableRetry -RetryCount 7 -RetryTimeout 15 -MonthlyOptions $monthly |
Perform the following steps:
- 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 option for the Type parameter.
- Provide the EnableRetry parameter.
- Specify the RetryCount parameter value.
- Specify the RetryTimeout parameter value.
- Set the $monthly variable as the MonthlyOptions parameter value.
Related Commands