Set-VBRJobAdvancedBackupOptions
Short Description
Modifies advanced job backup settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRJobAdvancedBackupOptions [-Algorithm {ReverseIncremental | Incremental | RecoveryPointObjective | Unknown}] [-DayNumberInMonth {First | Second | Third | Fourth | Last | OnDay}] [-DayOfMonth <CDayOfMonth>] [-DayOfWeek {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-EnableFullBackup <Boolean>] [-FullBackupDays {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-FullBackupScheduleKind {Daily | Monthly}] -Job <CBackupJob[]> [-Months {January | February | March | April | May | June | July | August | September | October | November | December}] [-SyntheticDayNumberInMonth {First | Second | Third | Fourth | Last | OnDay}] [-SyntheticDayOfMonth <CDayOfMonth>] [-SyntheticDayOfWeek {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-TransformFullToSyntethic <Boolean>] [-TransformIncrementsToSyntethic <Boolean>] [-TransformToSyntethicDays {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-TransformToSyntethicMonths {January | February | March | April | May | June | July | August | September | October | November | December}] [-TransformToSyntethicScheduleKind {Daily | Monthly}] [<CommonParameters>] |
Detailed Description
This cmdlet modifies advanced backup options of a selected job.
You can select backup method: reverse incremental or incremental, and set schedule settings for synthetic full backups.
Important |
Cmdlet parameters have a typo. The following parameters are spelled incorrectly:
In scripts, enter parameters as specified in command syntax. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
---|---|---|---|---|---|
Job | Specifies the array of jobs. The cmdlet will modify advanced backup options of these jobs. | True | Named | True (ByValue, | False |
Algorithm | Specifies backup method:
Note: To enable forever forward incremental backup method, disable TransformFullToSynthetic and EnableFullBackup. | False | Named | False | False |
TransformFullToSyntethic | Note: This parameter has a typo in spelling. In scripts, enter parameters as specified in command syntax. For incremental backup method. Indicates that the job will create a full synthetic backup. Use TransformToSyntethicDays to set the days to perform the synthetic full backups. | False | Named | False | False |
TransformIncrementsToSyntethic | Note: This parameter has a typo in spelling. In scripts, enter parameters as specified in command syntax. For incremental backup method with synthetic full. Indicates that the job will transform the backup chains before the synthetic full backup into rollbacks. | False | Named | False | False |
TransformToSyntethicScheduleKind | Note: This parameter has a typo in spelling. In scripts, enter parameters as specified in command syntax. For synthetic full schedule. Specifies the active full backup schedule type:
|
|
|
|
|
TransformToSyntethicDays | Note: This parameter has a typo in spelling. In scripts, enter parameters as specified in command syntax. For synthetic full schedule. Specifies days when the job will perform the synthetic fulls: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. | False | Named | False | False |
TransformToSyntethicMonths | Note: This parameter has a typo in spelling. In scripts, enter parameters as specified in command syntax. For synthetic full schedule: monthly. Specifies months to perform the synthetic full backup: January, February, March, April, May, June, July, August, September, October, November, December. | False | Named | False | False |
SyntheticDayOfWeek | Specifies the day of week to run the backup job: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. Use this parameter to set the day for SyntheticDayNumberInMonth parameter, for example, to run the job on first Saturday every month. | False | Named | False | False |
EnableFullBackup | Indicates that the job will create active full backups. Use the FullBackupDays, FullBackupScheduleKind, Months, DayNumberInMonth and DayOfWeek parameters to set the full backup schedule. | False | Named | False | False |
FullBackupDays | For active full schedule: daily. Specifies days when the job will perform the active full backup: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. | False | Named | False | False |
FullBackupScheduleKind | For active full schedule. Specifies the active full backup schedule type:
| False | Named | False | False |
Months | For active full schedule: monthly. Specifies months to perform the full backup: January, February, March, April, May, June, July, August, September, October, November, December. | False | Named | False | False |
DayNumberInMonth | For active full schedule: monthly. Specifies the number of day in month (for example, Saturday):
| False | Named | False | False |
DayOfMonth | For active full schedule: monthly with the OnDay option. Specifies the day of month to perform an active full backup. | False | Named | False | False |
DayOfWeek | For active full schedule: monthly. Specifies the day of week to run the backup job: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. Use this parameter to set the day for -NumberInMonth parameter, i.e. to run the job on first Saturday every month. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Example 1
This command sets the following backup options for the backup job represented by the $job variable:
- The backup algorithm is set to ReverseIncremental,
- The active full backup schedule is set to monthly.
The job object is obtained with Get-VBRJob, assigned to the variable beforehand and piped down.
$job | Set-VBRJobAdvancedBackupOptions -Algorithm ReverseIncremental -FullBackupScheduleKind Monthly |
Example 2
This command sets the following backup options for all backup jobs:
- The backup algorithm is set to Incremental.
- The synthetic full backup is enabled on every Sunday and Thursday.
- The previous fulls are set to rollback to chain of increments to save disk space.
- The active full backup schedule is set to every second Sunday monthly.
Get-VBRJob -Name Backup* | Set-VBRJobAdvancedBackupOptions -Algorithm Incremental -TransformFullToSyntethic $True -TransformIncrementsToSyntethic $True -TransformToSyntethicDays Sunday, Thursday -EnableFullBackup $True -FullBackupScheduleKind Monthly -DayNumberInMonth Second -FullBackupScheduleKind Daily -DayOfWeek Sunday |
Related Commands