New-VBRFullBackupOptions
Short Description
Creates active full backup schedule settings for Veeam Agent backup jobs.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
New-VBRFullBackupOptions [-Enable] [-ScheduleType <VBRFullBackupScheduleType> {Weekly | Monthly}] [-SelectedDays <DayOfWeek[]> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-DayNumber <VBRDayNumberInMonth> {First | Second | Third | Fourth | Last | OnDay}] [-DayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-DayOfMonth <string>] [-SelectedMonths <VBRMonth[]> {January | February | March | April | May | June | July | August | September | October | November | December}] [<CommonParameters>] |
Detailed Description
This cmdlet creates the VBRFullBackupOptions object. This object contains schedule settings that you can apply to Veeam Agent backup jobs. You can use this object to set up the following types of schedules for backup jobs:
- HealthCheck schedules
- Compact full backup schedules
- Active full backup schedules
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Enable | Enables the option for the backup job to create active full backups. | SwitchParameter | False | Named | False |
ScheduleType | Specifies the active full backups schedule type.
| VBRFullBackupScheduleType | False | Named | False |
SelectedDays | For weekly backups. Specifies the day of the week when the job creates active full backups. Default: Saturday. | DayOfWeek[] | False | Named | False |
DayNumber | For monthly backups. Specifies the day of the month when the job creates active full backups.
| VBRDayNumberInMonth | False | Named | False |
DayOfWeek | For monthly backups. Specifies the day of the week, when the job creates active full backups.
Default: Saturday. | DayOfWeek | False | Named | False |
DayOfMonth | For monthly backups with the OnDay option. Specifies the day of the month, when the job creates active full backups. For example, on the 3rd day of November. | String | False | Named | False |
SelectedMonths | Specifies the months, when the job creates active full backups.
Default: all months are selected. | VBRMonth[] | 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 VBRFullBackupOptions object that contains schedule settings for backup jobs.
Examples
Example 1. Creating Schedule for Weekly Active Full Backups
This command sets a schedule to create active full backups weekly. The job with these settings applied will create active full backups on Sundays and Wednesdays.
|
Example 2. Creating Schedule for Monthly Active Full Backups
This command sets a schedule to create active full backups monthly. The job with these settings applied will create active full backups on the 15th of January, April and September.
|