Set-VBRComputerGFSYearlyOptions

Short Description

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

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRComputerGFSYearlyOptions -Options <VBRComputerGFSYearlyOptions> [-RetentionPeriod <Int32>] [-SelectedMonth <VBRMonth>] [<CommonParameters>]

Detailed Description

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

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Options

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

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

True

Named

True

RetentionPeriod

Specifies the number of months to keep yearly full backups.

Int32

False

Named

False

SelectedMonth

Specifies a month when a yearly backup is created. You can specify either of the following months:

  • January
  • February
  • March
  • April
  • May
  • June
  • July
  • August
  • September
  • October
  • November
  • December

VBRMonth

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 VBRComputerGFSYearlyOptions object that contains settings of a yearly GFS retention policy for Veeam Agent backup jobs.

Examples

Set-VBRComputerGFSYearlyOptionsExample 1. Modifying Number of Years for GFS Retention Policy

This example shows how to modify a number of years to keep yearly backups. Veeam Backup & Replication will keep yearly backups for 3 years.

$options = New-VBRComputerGFSYearlyOptions -RetentionPeriod 2 -SelectedMonth November

Set-VBRComputerGFSYearlyOptions -Options $options -RetentionPeriod 3

Perform the following steps:

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

Set-VBRComputerGFSYearlyOptionsExample 2. Modifying Month of Yearly Backup Schedule

This example shows how to modify a month when a yearly backup is created. Veeam Backup & Replication will create yearly backups in February.

$options = New-VBRComputerGFSYearlyOptions -RetentionPeriod 2 -SelectedMonth November

Set-VBRComputerGFSYearlyOptions -Options $options -SelectedMonth February

Perform the following steps:

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

Related Commands

New-VBRComputerGFSYearlyOptions

I want to report a typo

There is a misspelling right here:

 

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