This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRSyntheticFullOptions
Short Description
Modifies the synthetic full backup schedule for Veeam Agent backup jobs.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRSyntheticFullOptions -Options <VBRSyntheticFullOptions> [-Enable] [-Days <DayOfWeek[]> {Sunday | Monday |Tuesday | Wednesday | Thursday | Friday | Saturday}] [<CommonParameters>] |
Detailed Description
This cmdlet modifies the synthetic full backup schedule for Veeam Agent backup jobs. 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 synthetic full backup settings that you want to modify. Accepts the VBRSyntheticFullOptions type. | True | Named | True (ByValue) |
|
Enable | Indicates that the Veeam Agent backup job will create synthetic full backups. | False | Named | False |
|
Days | Specifies the days of the week when the Veeam Agent backup job will create synthetic 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 a synthetic full backup schedule. Per these settings, the Veeam Agent backup job will backup computers on Wednesday and Friday.
- Run Get-VBRJob to get the backup job that you want to modify. Save the result to the $job variable.
- Cast the backup job to the VBRComputerBackupJob type. Use the [Veeam.Backup.PowerShell.Infos.VBRComputerBackupJob]$ComputerBackupJob value.
- Get the SyntheticFullOptions object. Save the result to the $options variable.
- Cast the $options variable to the VBRSyntheticFullOptions type. Use the [Veeam.Backup.PowerShell.Infos.VBRSyntheticFullOptions]$SyntheticFullOptions value. Save the result to the $options variable.
- Run Set-VBRSyntheticFullOptions with the $options variable.
$job = Get-VBRJob -name "BackupJob" [Veeam.Backup.PowerShell.Infos.VBRComputerBackupJob]$ComputerBackupJob=$job $options = $ComputerBackupJob.SyntheticFullOptions [Veeam.Backup.PowerShell.Infos.VBRSyntheticFullOptions]$SyntheticFullOptions =$schedule Set-VBRSyntheticFullOptions -Options $options -Enable -Days Wednesday Friday |
Related Commands
