Set-VBRComputerGFSMonthlyOptions
Short Description
Modifies settings of a monthly GFS retention policy for Veeam Agent backup jobs.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRComputerGFSMonthlyOptions -Options <VBRComputerGFSMonthlyOptions> [-RetentionPeriod <Int32>] [-SelectedWeek <VBRWeekOfMonth>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies settings of a monthly GFS retention policy for 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
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
Options | Specifies a monthly GFS retention policy for Veeam Agent backup jobs. The cmdlet will modify this policy. | Accepts the VBRComputerGFSMonthlyOptions object. To create this object, run the New-VBRComputerGFSMonthlyOptions cmdlet. | True | Named | True |
RetentionPeriod | Specifies the number of months to keep monthly full backups. | Int32 | False | Named | False |
SelectedWeek | Specifies a week of a month when a monthly backup is created. You can specify either of the following weeks:
| VBRWeekOfMonth | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
This cmdlet returns the VBRComputerGFSMonthlyOptions object that contains settings of a monthly GFS retention policy for Veeam Agent backup jobs.
Examples
Example 1. Modifying Number of Months for GFS Retention Policy
This example shows how to modify a number of months to keep monthly backups. Veeam Backup & Replication will keep monthly backups for 5 months.
Perform the following steps:
|
Example 2. Modifying Day When Backup is Created
This example shows how to modify a week when a monthly backup is created. Veeam Backup & Replication will create monthly backups on the last week of a month.
Perform the following steps:
|
Related Commands