Set-VBRComputerGFSMonthlyOptions

Short Description

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

Applies to

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

Syntax

Set-VBRComputerGFSMonthlyOptions -Options <VBRComputerGFSMonthlyOptions> [-RetentionPeriod <Int32>] [-SelectedWeek <VBRWeekOfMonth>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of the monthly GFS retention policy that you can apply to Veeam Agent backup jobs.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Options	Specifies a monthly GFS retention policy for Veeam Agent backup jobs. The cmdlet will modify this policy.	Accepts the VBRComputerGFSMonthlyOptions object. To create this object, run the New-VBRComputerGFSMonthlyOptions cmdlet.	True	Named	True
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

Options

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

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

True

Named

True

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

Set-VBRComputerGFSMonthlyOptions Example 1. Modifying Number of Months for GFS Retention Policy

This example shows how to modify the settings of the monthly GFS retention policy and change a number of months to keep monthly backups. With these settings applied, Veeam Backup & Replication will keep monthly backups for 5 months.

$options = New-VBRComputerGFSMonthlyOptions -RetentionPeriod 3 -SelectedWeek First

Set-VBRComputerGFSMonthlyOptions -Options $options -RetentionPeriod 5

Perform the following steps:

Run the New-VBRComputerGFSMonthlyOptions cmdlet. Specify the RetentionPeriod and the SelectedWeek parameter values. Save the result to the $options variable.
Run the Set-VBRComputerGFSMonthlyOptions cmdlet. Set the $options variable as the Options parameter value. Specify the RetentionPeriod parameter value.

Set-VBRComputerGFSMonthlyOptions Example 2. Modifying Day When Backup is Created

This example shows how to modify the settings of the monthly GFS retention policy and change a week when a monthly backup is created. With these settings applied, Veeam Backup & Replication will create monthly backups on the last week of a month.

$options = New-VBRComputerGFSMonthlyOptions -RetentionPeriod 3 -SelectedWeek First

Set-VBRComputerGFSMonthlyOptions -Options $options -SelectedWeek Last

Perform the following steps:

Run the New-VBRComputerGFSMonthlyOptions cmdlet. Specify the RetentionPeriod and the SelectedWeek parameter values. Save the result to the $options variable.
Run the Set-VBRComputerGFSMonthlyOptions cmdlet. Set the $options variable as the Options parameter value. Set the Last option for the SelectedWeek parameter.

Related Commands

New-VBRComputerGFSMonthlyOptions