Set-VBRSyntheticFullOptions
Short Description
Modifies the synthetic full backup schedule settings for Veeam Agent backup jobs.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRSyntheticFullOptions -Options <VBRSyntheticFullOptions> [-Enable] [-Days <DayOfWeek[]> {Sunday | Monday |Tuesday | Wednesday | Thursday | Friday | Saturday}] [<CommonParameters>] |
Detailed Description
This cmdlet modifies the VBRSyntheticFullOptions object that contains synthetic full backup schedule settings that you can apply to Veeam Agent backup jobs.
Note |
To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged. |
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Options | Specifies synthetic full backup settings that you want to modify. | Accepts the VBRSyntheticFullOptions object. To get this object, run the New-VBRSyntheticFullOptions cmdlet. | True | Named | True (ByValue) |
Enable | Enables the option for the Veeam Agent backup job to create synthetic full backups. | SwitchParameter | False | Named | False |
Days | Specifies the days of the week when the Veeam Agent backup job will create synthetic full backups. | DayOfWeek[] | 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 VBRSyntheticFullOptions object that contains schedule settings for backup jobs.
Examples
Modifying Synthetic Full Backup Schedule
This example shows how to modify synthetic full backup schedule settings. With these settings applied, the Veeam Agent backup job will back up computers on Wednesdays and Fridays.
$job = Get-VBRComputerBackupJob -Name "BackupJob" $newoption = Set-VBRSyntheticFullOptions -Options $job.SyntheticFullOptions -Days Wednesday, Friday Set-VBRComputerBackupJob -Job $job -SyntheticFullOptions $newoption |
Perform the following steps:
- Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
- Run the Set-VBRSyntheticFullOptions cmdlet. Get the SyntheticFullOptions property of the $job variable. Set the Wednesday, Friday option for the Days parameter. Save the result to the $newoption variable.
- Run the Set-VBRComputerBackupJob cmdlet. Set the $job variable as the Job parameter value. Set the $newoption variable as the SyntheticFullOptions parameter value.
Related Commands