Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

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
Pipeline
Input

Accept
Wildcard
Characters

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.

  1. Run Get-VBRJob to get the backup job that you want to modify. Save the result to the $job variable.
  2. Cast the backup job to the VBRComputerBackupJob type. Use the [Veeam.Backup.PowerShell.Infos.VBRComputerBackupJob]$ComputerBackupJob value.
  3. Get the SyntheticFullOptions object. Save the result to the $options variable.
  4. Cast the $options variable to the VBRSyntheticFullOptions type. Use the [Veeam.Backup.PowerShell.Infos.VBRSyntheticFullOptions]$SyntheticFullOptions value. Save the result to the $options variable.
  5. 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

New-VBRSelectedFilesBackupOptions

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation