New-VBRGFSRetentionPolicy

In this article

    Short Description

    Defines GFS retention settings for Veeam Agent backup copy jobs.

    Applies to

    Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

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

    Detailed Description

    This cmdlet creates the VBRGFSRetentionPolicy object. This object contains GFS retention settings for Veeam Agent backup copy jobs. Veeam Backup & Replication will keep the copied restore points on the target backup repository according to these settings.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    RestorePoints

    Specifies the number of restore points that you want to keep in the backup chain on the target backup repository.

    False

    Named

    False

    GFSWeeklyBackups

    Specifies the number of weekly backups that you want to keep on the target backup repository.

    False

    Named

    False

    GFSMonthlyBackups

    Specifies the number of monthly backups that you want to keep on the target backup repository.

    False

    Named

    False

    GFSQuarterlyBackups

    Specifies the number of quarterly backups that you want to keep on the target backup repository.

    False

    Named

    False

    GFSYearlyBackups

    Specifies the number of yearly backups that you want to keep on the target backup repository.

    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.

    Return Type

    This cmdlet returns the VBRGFSRetentionPolicy object that contains GFS retention settings for Veeam Agent backup copy jobs.

    Example

    This command creates a GFS retention policy for a backup copy job with the following settings:

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

    New-VBRGFSRetentionPolicy -RestorePoints 2 -GFSWeeklyBackups 3 -GFSMonthlyBackups 4 -GFSQuarterlyBackups 5 -GFSYearlyBackups 9