Set-VBRFullBackupOptions
Short Description
Modifies active full backup schedule for Veeam Agent backup jobs.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRFullBackupOptions -Options <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 modifies the settings of schedule for Veeam Agent backup jobs. You can modify the settings of schedule for the following types of schedules for Veeam Agent backup jobs:
- HealthCheck schedules
- Compact full backup schedules
- Active full backup schedules
To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Options | Specifies the active full backup schedule that you want to modify. Accepts the VBRFullBackupOptions type. | True | Named | True (ByValue) |
|
Enable | Indicates that the Veeam Agent backup job will create active full backups. | False | Named | False |
|
ScheduleType | Specifies the type of active full backup schedule.
| False | Named | False |
|
SelectedDays | For weekly full backups. Specifies the day of the week when active full backups will be created. | False | Named | False |
|
DayNumber | For monthly backups. Specifies the day of the month when active full backups will be created (for example, Saturday):
| False | Named | False |
|
DayOfWeek | For monthly backups. Specifies the day of the week, when the job creates active full backups.
| 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. | False | Named | False |
|
SelectedMonths | Specifies the months, when the job creates active full backups.
| 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 active full backup schedule. Veeam Backup & Replication will change the schedule from weekly to monthly.
- Run New-VBRFullBackupOptions to specify the schedule. Save the result to the $activefull variable.
- Run Set-VBRFullBackupOptions with the $activefull variable.
$activefull = New-VBRFullBackupOptions -Enable -ScheduleType Weekly -SelectedDays Sunday, Wednesday Set-VBRFullBackupOptions -Options $activefull -Enable -ScheduleType Monthly -DayNumber OnDay -DayOfWeek Friday |
Related Commands