Set-VBRComputerGFSOptions

Short Description

Modifies GFS retention settings for Veeam Agent backup jobs.

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

Syntax

Set-VBRComputerGFSOptions -GFSOptions <VBRComputerGFSOptions> [-GFSWeeklyOptions <VBRComputerGFSWeeklyOptions>]

[-GFSMonthlyOptions <VBRComputerGFSMonthlyOptions>] [-GFSYearlyOptions <VBRComputerGFSYearlyOptions>]

[-EnableGFSWeeklyBackup] [-EnableGFSMonthlyBackup] [-EnableGFSYearlyBackup] [-ReadEntireRestorePoint] [<CommonParameters>]

Detailed Description

This cmdlet modifies GFS retention settings 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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
EnableGFSMonthlyBackup	Defines that the cmdlet will enable a monthly GFS retention policy. If you do not provide this parameter, the cmdlet will not change the settings of a monthly GFS retention policy.	`SwitchParameter`	False	Named	False
EnableGFSWeeklyBackup	Defines that the cmdlet will enable a weekly GFS retention policy. If you do not provide this parameter, the cmdlet will not change the settings of weekly GFS retention policy.	`SwitchParameter`	False	Named	False
EnableGFSYearlyBackup	Defines that the cmdlet will enable a yearly GFS retention policy. If you do not provide this parameter, the cmdlet will not change the settings of a yearly GFS retention policy.	`SwitchParameter`	False	Named	False
GFSMonthlyOptions	Specifies settings of a monthly GFS retention policy. The cmdlet will define GFS retention with these settings. Accepts the `VBRComputerGFSMonthlyOptions` object. To create this object, run the `New-VBRComputerGFSMonthlyOptions` cmdlet.	`VBRComputerGFSMonthlyOptions`	False	Named	False
GFSOptions	Specifies GFS retention. The cmdlet will modify this policy.	`VBRComputerGFSOptions`	True	Named	True (ByValue)
GFSWeeklyOptions	Specifies settings of a weekly GFS retention policy. The cmdlet will define GFS retention with these settings. Accepts the `VBRComputerGFSWeeklyOptions` object. To create this object, run the `New-VBRComputerGFSWeeklyOptions` cmdlet.	`VBRComputerGFSWeeklyOptions`	False	Named	False
GFSYearlyOptions	Specifies settings of a yearly GFS retention policy. The cmdlet will define GFS retention with these settings. Accepts the `VBRComputerGFSYearlyOptions` object. To create this object, run the `New-VBRComputerGFSYearlyOptions` cmdlet.	`VBRComputerGFSYearlyOptions`	False	Named	False
ReadEntireRestorePoint	Defines that the cmdlet will process the most recent restore point instead of waiting for the current backup file to become available.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

This cmdlet returns the VBRComputerGFSOptions object that contains settings of GFS retention for Veeam Agent backup jobs.

Examples

Set-VBRComputerGFSOptions Example 1. Enabling Monthly GFS Retention Policy

This example shows how to modify the monthly retention policy settings to create backups on the last week of every month and keep them for 2 months.

$weekly = New-VBRComputerGFSWeeklyOptions -RetentionPeriod 3 -SelectedDay Wednesday

$options = New-VBRComputerGFSOptions -GFSWeeklyOptions $weekly

$monthly = New-VBRComputerGFSMonthlyOptions -RetentionPeriod 2 -SelectedWeek Last

Set-VBRComputerGFSOptions -GFSOptions $options -EnableGFSMonthlyBackup -GFSMonthlyOptions $monthly

Perform the following steps:

Define the GFS Retention Policy:
1. Run the New-VBRComputerGFSWeeklyOptions cmdlet. Specify the RetentionPeriod and the SelectedDay parameter values. Save the result to the $weekly variable.
2. Run the New-VBRComputerGFSOptions cmdlet. Set the $weekly variable as the GFSWeeklyOptions parameter value. Save the result to the $options variable.
Run the New-VBRComputerGFSMonthlyOptions cmdlet. Specify the RetentionPeriod and the SelectedWeek parameter values. Save the result to the $monthly variable.
Run the Set-VBRComputerGFSOptions cmdlet. Specify the following settings:
- Set the $options variable as the GFSOptions parameter value.
- Provide the EnableGFSMonthlyBackup parameter.
- Set the $monthly variable as the GFSMonthlyOptions parameter value.

Set-VBRComputerGFSOptions Example 2. Enabling Yearly GFS Retention Policy

This example shows how to modify the yearly retention policy settings to create backups on November and keep them for 2 years.

$weekly = New-VBRComputerGFSWeeklyOptions -RetentionPeriod 3 -SelectedDay Wednesday

$options = New-VBRComputerGFSOptions -GFSWeeklyOptions $weekly

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

Set-VBRComputerGFSOptions -GFSOptions $options -EnableGFSYearlyBackup -GFSYearlyOptions $yearly

Perform the following steps:

Define the GFS Retention Policy:
1. Run the New-VBRComputerGFSWeeklyOptions cmdlet. Specify the RetentionPeriod and the SelectedDay parameter values. Save the result to the $weekly variable.
2. Run the New-VBRComputerGFSOptions cmdlet. Set the $weekly variable as the GFSWeeklyOptions parameter value. Save the result to the $options variable.
Run the New-VBRComputerGFSYearlyOptions cmdlet. Specify the RetentionPeriod and the SelectedMonth parameter values. Save the result to the $yearly variable.
Run the Set-VBRComputerGFSOptions cmdlet. Specify the following settings:
- Set the $options variable as the GFSOptions parameter value.
- Provide the EnableGFSYearlyBackup parameter.
- Set the $yearly variable as the GFSYearlyOptions parameter value.