Set-VBRSyntheticFullOptions

In this article

    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. 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-VBRComputerBackupJob to get the backup job that you want to modify. Save the result to the $job variable.
    2. Run New-VBRSyntheticFullOptions to create a synthetic full backup schedule. Save the result to the $options variable.
    3. Run Set-VBRSyntheticFullOptions with the $options variable.

    $job = Get-VBRComputerBackupJob -name "BackupJob"

    $options = New-VBRSyntheticFullOptions -Enable -Days Friday

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

    Related Commands

    New-VBRSelectedFilesBackupOptions

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.