New-VBRComputerGFSYearlyOptions

Short Description

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

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

New-VBRComputerGFSYearlyOptions [-RetentionPeriod <Int32>] [-SelectedMonth <VBRMonth>] [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRComputerGFSMonthlyOptions object. This object contains settings of a yearly GFS retention policy for Veeam Agent backup jobs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

RetentionPeriod

Specifies the number of years 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

Defining Yearly GFS Retention Policy

This command defines a yearly GFS retention policy with the following settings:

  • Veeam Backup & Replication will keep yearly full backups for 2 years.
  • Veeam Backup & Replication will create yearly backups on November.

 

New-VBRComputerGFSYearlyOptions -RetentionPeriod 2 -SelectedMonth November

I want to report a typo

There is a misspelling right here:

 

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