---
title: "Set-VBRComputerGFSOptions"
description: "This cmdlet modifies GFS retention settings that you can apply to Veeam Agent backup jobs. To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrcomputergfsoptions.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Agent Management > Working with Veeam Agent Backup Jobs and Policies > Veeam Agent Job Advanced Settings > Set-VBRComputerGFSOptions"
dateModified: "2026-08-19"
---

# 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

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableGFSMonthlyBackup</span></p>
        </td>
        <td>
          <p>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.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableGFSWeeklyBackup</span></p>
        </td>
        <td>
          <p>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.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableGFSYearlyBackup</span></p>
        </td>
        <td>
          <p>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.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">GFSMonthlyOptions</span></p>
        </td>
        <td>
          <p>Specifies settings of a monthly GFS retention policy. The cmdlet will define GFS retention with these settings.</p><p>Accepts the <code>VBRComputerGFSMonthlyOptions</code> object. To create this object, run the <a href="new-vbrcomputergfsmonthlyoptions.md"><code>New-VBRComputerGFSMonthlyOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRComputerGFSMonthlyOptions</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">GFSOptions</span></p>
        </td>
        <td>
          <p>Specifies GFS retention. The cmdlet will modify this policy.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRComputerGFSOptions</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">GFSWeeklyOptions</span></p>
        </td>
        <td>
          <p>Specifies settings of a weekly GFS retention policy. The cmdlet will define GFS retention with these settings.</p><p>Accepts the <code>VBRComputerGFSWeeklyOptions</code> object. To create this object, run the <a href="new-vbrcomputergfsweeklyoptions.md"><code>New-VBRComputerGFSWeeklyOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRComputerGFSWeeklyOptions</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">GFSYearlyOptions</span></p>
        </td>
        <td>
          <p>Specifies settings of a yearly GFS retention policy. The cmdlet will define GFS retention with these settings.</p><p>Accepts the <code>VBRComputerGFSYearlyOptions</code> object. To create this object, run the <a href="new-vbrcomputergfsyearlyoptions.md"><code>New-VBRComputerGFSYearlyOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRComputerGFSYearlyOptions</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ReadEntireRestorePoint</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will process the most recent restore point instead of waiting for the current backup file to become available.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

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

## Examples

::: example
### 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:

1. Define the GFS Retention Policy:

   1. Run the [`New-VBRComputerGFSWeeklyOptions`](new-vbrcomputergfsweeklyoptions.md) cmdlet. Specify the `RetentionPeriod` and the `SelectedDay` parameter values. Save the result to the `$weekly` variable.
   2. Run the [`New-VBRComputerGFSOptions`](new-vbrcomputergfsoptions.md) cmdlet. Set the `$weekly` variable as the `GFSWeeklyOptions` parameter value. Save the result to the `$options` variable.

2. Run the [`New-VBRComputerGFSMonthlyOptions`](new-vbrcomputergfsmonthlyoptions.md) cmdlet. Specify the `RetentionPeriod` and the `SelectedWeek` parameter values. Save the result to the `$monthly` variable.
3. 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.

:::

::: example
### 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:

1. Define the GFS Retention Policy:

   1. Run the [`New-VBRComputerGFSWeeklyOptions`](new-vbrcomputergfsweeklyoptions.md) cmdlet. Specify the `RetentionPeriod` and the `SelectedDay` parameter values. Save the result to the `$weekly` variable.
   2. Run the [`New-VBRComputerGFSOptions`](new-vbrcomputergfsoptions.md) cmdlet. Set the `$weekly` variable as the `GFSWeeklyOptions` parameter value. Save the result to the `$options` variable.

2. Run the [`New-VBRComputerGFSYearlyOptions`](new-vbrcomputergfsyearlyoptions.md) cmdlet. Specify the `RetentionPeriod` and the `SelectedMonth` parameter values. Save the result to the `$yearly` variable.
3. 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.

:::

## Related Commands

- [`New-VBRComputerGFSWeeklyOptions`](new-vbrcomputergfsweeklyoptions.md)
- [`New-VBRComputerGFSMonthlyOptions`](new-vbrcomputergfsmonthlyoptions.md)
- [`New-VBRComputerGFSYearlyOptions`](new-vbrcomputergfsyearlyoptions.md)
- [`New-VBRComputerGFSOptions`](new-vbrcomputergfsoptions.md)