Set-VBRSyntheticFullOptions

Short Description

Modifies the synthetic full backup schedule 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 synthetic full backup schedule for 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 for backup jobs.

Examples

Modifying Synthetic Full Backup Schedule

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.

$job = Get-VBRComputerBackupJob -Name "BackupJob"

$options = New-VBRSyntheticFullOptions -Enable -Days Friday

Set-VBRSyntheticFullOptions -Options $options -Enable -Days Wednesday Friday

Perform the following steps:

  1. Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the New-VBRSyntheticFullOptions cmdlet. Provide the Enable parameter. Set the Friday option for Days parameter. Save the result to the $options variable.
  3. Run the Set-VBRSyntheticFullOptions cmdlet. Set the $options variable as the Options parameter value. Provide the Enable parameter. Set the Friday and Wednesday options for Days parameter.

Related Commands

Page updated 5/7/2024

Page content applies to build 12.2.0.334