New-VBRComputerGFSMonthlyOptions

Short Description

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

Applies to

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

Syntax

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

Detailed Description

This cmdlet creates the VBRComputerGFSMonthlyOptions object.This object contains settings of the monthly GFS retention policy that you can apply to 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

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

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see 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-VBRComputerGFSMonthlyOptions Example 1. Defining Monthly GFS Retention Policy to Create Backups on First Week

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

With these settings applied, Veeam Backup & Replication will keep monthly backups for 3 weeks.
With these settings applied, Veeam Backup & Replication will create monthly backups on the first week of the month.

New-VBRComputerGFSMonthlyOptions -RetentionPeriod 3 -SelectedWeek First

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

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

With these settings applied, Veeam Backup & Replication will keep monthly backups for 3 weeks.
With these settings applied, Veeam Backup & Replication will create monthly backups on the last week of the month.

New-VBRComputerGFSMonthlyOptions -RetentionPeriod 3 -SelectedWeek Last