This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRComputerGFSYearlyOptions
Short Description
Modifies settings of a yearly GFS retention policy for Veeam Agent backup jobs.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRComputerGFSYearlyOptions -Options <VBRComputerGFSYearlyOptions> [-RetentionPeriod <Int32>] [-SelectedMonth <VBRMonth>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies settings of a yearly GFS retention policy for Veeam Agent backup jobs. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
Options | Specifies a yearly GFS retention policy for Veeam Agent backup jobs. The cmdlet will modify this policy. | Accepts the VBRComputerGFSYearlyOptions object. To create this object, run the New-VBRComputerGFSYearlyOptions cmdlet | True | Named | True |
RetentionPeriod | Specifies the number of months to keep yearly full backups. | Int32 | False | Named | False |
SelectedMonth | Specifies a month when a yearly backup is created. You can specify either of the following months:
| VBRMonth | 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 VBRComputerGFSYearlyOptions object that contains settings of a yearly GFS retention policy for Veeam Agent backup jobs.
Examples
Example 1. Modifying Number of Years for GFS Retention Policy
Example 2. Modifying Month of Yearly Backup Schedule
Related Commands
