Set-VBRComputerGFSWeeklyOptions

In this article

    Short Description

    Modifies settings of a weekly GFS retention policy for Veeam Agent backup jobs.

    Applies to

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Set-VBRComputerGFSWeeklyOptions -Options <VBRComputerGFSWeeklyOptions> [-RetentionPeriod <Int32>] [-SelectedDay <DayOfWeek>] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies settings of a weekly GFS retention policy for Veeam Agent backup jobs. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Options

    Specifies a weekly GFS retention policy for Veeam Agent backup jobs. The cmdlet will modify this policy.

    Accepts the VBRComputerGFSWeeklyOptions object. To create this object, run the New-VBRComputerGFSWeeklyOptions cmdlet.

    True

    Named

    True

    RetentionPeriod

    Specifies the number of weeks to keep weekly full backups.

    Int32

    False

    Named

    False

    SelectedDay

    Specifies a day of week when a weekly backup is created. You can specify either of the following day of a week:

    • Sunday
    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday

    DayOfWeek

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    This cmdlet returns the VBRComputerGFSWeeklyOptions object that contains settings of a weekly GFS retention policy for Veeam Agent backup jobs.

    Examples

    Set-VBRComputerGFSWeeklyOptionsExample 1. Modifying Number of Weeks for GFS Retention Policy

    This example shows how to modify a number of weeks to keep weekly backups. Veeam Backup & Replication will keep weekly backups for 5 days.

    $options = New-VBRComputerGFSWeeklyOptions -RetentionPeriod 3 -SelectedDay Wednesday

    Set-VBRComputerGFSWeeklyOptions -Options $options -RetentionPeriod 5

    Perform the following steps:

    1. Run the New-VBRComputerGFSWeeklyOptions cmdlet. Specify the RetentionPeriod and the SelectedDay parameters. Save the result to the $options variable.
    2. Run the Set-VBRComputerGFSWeeklyOptions cmdlet. Set the $options variable as the Options parameter value. Specify the RetentionPeriod parameter value.

    Set-VBRComputerGFSWeeklyOptionsExample 2. Modifying Day When Backup is Created

    This example shows how to modify a day of a week when a weekly backup is created. Veeam Backup & Replication will create weekly backups on Tuesday.

    $options = New-VBRComputerGFSWeeklyOptions -RetentionPeriod 3 -SelectedDay Wednesday

    Set-VBRComputerGFSWeeklyOptions -Options $options -SelectedDay Tuesday

    Perform the following steps:

    1. Run the New-VBRComputerGFSWeeklyOptions cmdlet. Specify the RetentionPeriod and the SelectedDay parameters. Save the result to the $options variable.
    2. Run the Set-VBRComputerGFSWeeklyOptions cmdlet. Set the $options variable as the Options parameter value. Specify the SelectedDay parameter value.

    Related Commands

    New-VBRComputerGFSWeeklyOptions

    I want to report a typo

    There is a misspelling right here:

     

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