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, Veeam Universal License
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.
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 |
|---|---|---|---|---|---|
RetentionPolicy | Specifies the GFS retention policy that you want to modify. | Accepts the VBRGFSRetentionPolicy object. To get this object, run the New-VBRGFSRetentionPolicy cmdlet. | True | Named | True (ByValue) |
RestorePoints | Specifies the number of the restore points for the regular backups. | Int | False | Named | False |
GFSWeeklyBackups | Specifies the number of the restore points for the weekly backups. | Int | False | Named | False |
GFSMonthlyBackups | Specifies the number of the restore points for the monthly backups. | Int | False | Named | False |
GFSQuarterlyBackups | Specifies the number of the restore points for the quarterly backups. | Int | False | Named | False |
GFSYearlyBackups | Specifies the number of the restore points for the yearly backups. | Int | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
The cmdlet returns the VBRGFSRetentionPolicy object that contains settings of a GFS retention policy for backup copy jobs.
Examples
Modifying GFS Retention Policy for Backup Copy Job
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.
$job = Get-VBRJob -Name "EC2 BCJ 01" $policy = Get-VBRRetentionPolicy -Job $job Set-VBRGFSRetentionPolicy -RetentionPolicy $policy -RestorePoints 5 -GFSWeeklyBackups 8 -GFSMonthlyBackups 4 -GFSYearlyBackups 9 |
Perform the following steps:
- Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
- Run the Get-VBRRetentionPolicy cmdlet. Set the $job variable as the Job parameter value. Save the result to the $policy variable.
- Run the Set-VBRGFSRetentionPolicy cmdlet. Specify the following settings:
- Set the $policy variable as the RetentionPolicy parameter value.
- Specify the RestorePoints parameter value.
- Specify the GFSWeeklyBackups parameter value.
- Specify the GFSMonthlyBackups parameter value.
- Specify the GFSYearlyBackups parameter value.
Related Commands