New-VBRComputerGFSOptions

Short Description

Defines settings of GFS retention for Veeam Agent backup jobs.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

New-VBRComputerGFSOptions [-GFSWeeklyOptions <VBRComputerGFSWeeklyOptions>] [-GFSMonthlyOptions <VBRComputerGFSMonthlyOptions>] [-GFSYearlyOptions <VBRComputerGFSYearlyOptions>]  [<CommonParameters>]

Detailed Description

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

For more information on GFS retention, see the GFS Retention Policy section of the User Guide for VMware vSphere.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

GFSWeeklyOptions

Specifies settings of a weekly GFS retention. The cmdlet will define GFS retention with these settings.

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

False

Named

False

GFSMonthlyOptions

Specifies settings of a monthly GFS retention. The cmdlet will define GFS retention with these settings.

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

False

Named

False

GFSYearlyOptions

Specifies settings of a yearly GFS retention. The cmdlet will define GFS retention with these settings.

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

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

Examples

Defining GFS Retention Policy for Veeam Agent Backup Jobs

This example shows how to define GFS retention for Veeam Agent backup jobs. The cmdlet will define the GFS retention with the following weekly, monthly and yearly settings:

  • Weekly: every Wednesday, keep backups for 3 weeks.
  • Monthly: every first week of the month, keep backups for 3 months.
  • Yearly: every November, keep backups for 2 years.

 

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

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

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

New-VBRComputerGFSOptions -GFSWeeklyOptions $weekly -GFSMonthlyOptions $monthly -GFSYearlyOptions $yearly

Perform the following steps:

  1. Run the New-VBRComputerGFSWeeklyOptions cmdlet. Specify the RetentionPeriod and the SelectedDay parameters. Save the result to the $weekly variable.
  2. Run the New-VBRComputerGFSMonthlyOptions cmdlet. Specify the RetentionPeriod and the SelectedWeek parameters. Save the result to the $monthly variable.
  3. Run the New-VBRComputerGFSYearlyOptions cmdlet. Specify the RetentionPeriod and the SelectedMonth parameters. Save the result to the $monthly variable.
  4. Run the New-VBRComputerGFSOptions cmdlet. Specify the following settings:
  • Set the $weekly variable as the GFSWeeklyOptions parameter value.
  • Set the $monthly variable as the GFSMonthlyOptions parameter value.
  • Set the $yearly variable as the GFSYearlyOptions parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

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