Set-VBRGFSRetentionPolicy

Short Description

Modifies a GFS retention policy for backup copy jobs that process backups stored on external repositories.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRGFSRetentionPolicy -RetentionPolicy <VBRGFSRetentionPolicy> [-RestorePoints <int>] [-GFSWeeklyBackups<int>] [-GFSMonthlyBackups <int>] [-GFSQuarterlyBackups <int>] [-GFSYearlyBackups <int>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies a GFS retention policy for backup copy jobs that process backups stored on external repositories.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

RetentionPolicy

Specifies the GFS retention policy that you want to modify.

True

Named

True (ByValue)

 

RestorePoints

Specifies the number of the restore points for the regular backups.

False

Named

False

 

GFSWeeklyBackups

Specifies the number of the restore points for the weekly backups.

False

Named

False

 

GFSMonthlyBackups

Specifies the number of the restore points for the monthly backups.

False

Named

False

 

GFSQuarterlyBackups

Specifies the number of the restore points for the quarterly backups.

False

Named

False

 

GFSYearlyBackups

Specifies the number of the restore points for the yearly backups.

False

Named

False

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

Example

This example shows how to modify a GFS retention policy for a backup copy job. The cmdlet will change the GFS retention policy with the following settings:

  • The number of regular backups is set to 5.
  • The number of weekly backups is set to 8.
  • The number of monthly backups is set to 4.
  • The number of yearly backups is set to 9.

You will need to perform the following steps:

  1. Run Get-VBRJob to get the backup copy job. Save the result to the $job variable.
  2. Run Get-VBRRetentionPolicy with the $job variable. Save the result to the $policy variable.
  3. Run Set-VBRGFSRetentionPolicy with the $policy variable.

$job = Get-VBRJob -Name "EC2 BCJ 01"

$policy = Get-VBRRetentionPolicy -Job $job

Set-VBRGFSRetentionPolicy -RetentionPolicy $policy -RestorePoints 5 -GFSWeeklyBackups 8 -GFSMonthlyBackups 4 -GFSYearlyBackups 9

Related Commands

Get-VBRJob

Get-VBRRetentionPolicy

I want to report a typo

There is a misspelling right here:

 

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