New-VBRApplicationScheduleOptions
Short Description
Creates the schedule for application backup policies.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
New-VBRApplicationScheduleOptions -Type {Daily | Monthly | Periodically | AfterJob} [-DailyOptions <VBRDailyOptions>] [-MonthlyOptions <VBRMonthlyOptions>] [-PeriodicallyOptions <VBRPeriodicallyOptions>] [-Job <CBackupJob>] [-EnableRetry] [-RetryCount <int>] [-RetryTimeout <int>] [-EnableBackupTerminationWindow] [-TerminationWindow <VBRBackupWindowOptions>] [<CommonParameters>] |
Detailed Description
This cmdlet creates the VBRApplicationScheduleOptions object that contains schedule settings for application backup policies.
You can use this cmdlet to create a schedule for application backup policies for the following Veeam Plug-ins managed by Veeam Backup & Replication:
- Veeam Plug-in for Oracle RMAN
- Veeam Plug-in for SAP HANA
- Veeam Plug-in for SAP on Oracle
Parameters
Parameter | Description | Required | Position | Accept |
---|---|---|---|---|
Type | Specifies the 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 run. Specifies periodical schedule settings. The cmdlet will create the server schedule with these settings. Accepts the VBRPeriodicallyOptions type. | False | Named | False |
Job | For running after a job. Specifies the name of the backup job after which Veeam Backup & Replication will run application backup policies. The cmdlet will create the schedule with these settings. | False | Named | False |
EnableRetry | Indicates that Veeam Backup & Replication 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. Permitted values: 1 to 999. | False | Named | False |
RetryTimeout | For the EnableRetry parameter. Specifies the time interval between retry attempts in minutes. Permitted values: 1 to 999. | False | Named | False |
EnableBackupTerminationWindow | Indicates that Veeam Backup & Replication will stop the Veeam Agent backup job if it exceeds the backup window. | False | Named | False |
TerminationWindow | Specifies the time interval within which the backup job must complete. The cmdlet will create the Veeam Agent backup job with these settings. Accepts the VBRBackupWindowOptions type. | 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
The cmdlet returns the VBRApplicationScheduleOptions object that defines schedule settings for application backup policies.
Example
This example shows how to create the schedule for an application backup policy. The job will run on Fridays at 7:00 PM.
- Run New-VBRDailyOptions to specify the daily schedule options. Save the result to the $daily variable.
- Run New-VBRApplicationScheduleOptions with the $daily variable. Use the Type parameter to specify the type of the schedule.
$daily = New-VBRDailyOptions -DayOfWeek Friday -Period 7:00 New-VBRApplicationScheduleOptions -Type Daily -DailyOptions $daily |
Related Commands