New-VBRComputerGFSMonthlyOptions

Short Description

Specifies settings of a monthly GFS retention policy for Veeam Agent backup jobs.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

New-VBRComputerGFSMonthlyOptions [-RetentionPeriod <Int32>] [-SelectedWeek <VBRWeekOfMonth>] [<CommonParameters>]

Detailed Description

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

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

RetentionPeriod

Specifies the number of months to keep monthly full backups.

Int32

False

Named

False

SelectedWeek

Specifies a week of a month when a monthly backup is created. You can specify either of the following weeks:

  • First - the cmdlet will create the monthly backup in the first week of the month.
  • Last - the cmdlet will create the monthly backup in the last week of the month.

VBRWeekOfMonth

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

Examples

New-VBRComputerGFSMonthlyOptionsExample 1. Defining Monthly GFS Retention Policy to Create Backups on First Week

This command defines monthly GFS retention policy with the following settings:

  • Veeam Backup & Replication will keep monthly backups for 3 weeks.
  • Veeam Backup & Replication will create monthly backups on the first week of the month.

 

New-VBRComputerGFSMonthlyOptions -RetentionPeriod 3 -SelectedWeek First

New-VBRComputerGFSMonthlyOptionsExample 2. Defining Monthly GFS Retention Policy to Create Backups on Last Week

This command defines monthly GFS retention policy with the following settings:

  • Veeam Backup & Replication will keep monthly backups for 3 weeks.
  • Veeam Backup & Replication will create monthly backups on the last week of the month.

 

New-VBRComputerGFSMonthlyOptions -RetentionPeriod 3 -SelectedWeek Last

I want to report a typo

There is a misspelling right here:

 

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