Retention Settings
This section describes retention settings for backup files stored on the backup target.
|
Parent Tag |
Parameter |
Description |
|---|---|---|
|
RetentionInfo |
Parent tag that encapsulates information about short-term retention policy settings. |
|
|
RetentionType |
Type of the applied short-term retention policy. This parameter has the following value: 1. Veeam Agent retains restore points for a certain number of days. |
|
|
RestorePointsCount |
Parameter defines the number of days during which Veeam Agent retains a restore point. |
|
Example
You use the Workstation edition and want to keep restore points in the backup chain for 10 days. The input XML file will contain the following parameters:
|
<ExecutionResult> |
GFS Policy Settings
This section describes long-term retention settings that follow the Grandfather-Father-Son (GFS) scheme. GFS retention lets you keep weekly, monthly, and yearly full backups on the target repository.
|
Parent Tag |
Parameter |
Description |
|---|---|---|
|
GfsPolicyInfo |
Parent tag that encapsulates information about GFS retention policy settings. |
|
|
GfsPolicy |
Parent tag that encapsulates information about weekly, monthly and yearly GFS tiers. |
|
|
IsEnabled |
Parameter specifies whether the GFS retention policy is enabled. Possible values:
|
|
|
GfsWeeklyPolicy |
Parent tag that encapsulates information about the weekly GFS tier. |
|
|
IsEnabled |
Parameter specifies whether the weekly GFS tier is enabled. Possible values: True or False. |
|
|
NumberOfWeeks |
Number of weeks during which Veeam Agent for Microsoft Windows retains the weekly GFS backup. |
|
|
BeginTimeUtc |
Date and time (UTC) from which Veeam Agent for Microsoft Windows starts to keep weekly GFS backups, for example: 11/18/2025 12:25:31. |
|
|
DesiredTime |
Day of the week when the weekly GFS backup must be flagged for long-term retention. Value is the ordinal number of the day (0 — Sunday, 1 — Monday, ..., 6 — Saturday). |
|
|
GfsMonthlyPolicy |
Parent tag that encapsulates information about the monthly GFS tier. |
|
|
IsEnabled |
Parameter specifies whether the monthly GFS tier is enabled. Possible values: True or False. |
|
|
NumberOfMonths |
Number of months during which Veeam Agent for Microsoft Windows retains the monthly GFS backup. |
|
|
BeginTimeUtc |
Date and time (UTC) from which Veeam Agent for Microsoft Windows starts to keep monthly GFS backups. |
|
|
DesiredTime |
Week of the month whose backup is flagged as the monthly GFS backup. |
|
|
GfsYearlyPolicy |
Parent tag that encapsulates information about the yearly GFS tier. |
|
|
IsEnabled |
Parameter specifies whether the yearly GFS tier is enabled. Possible values: True or False. |
|
|
NumberOfYears |
Number of years during which Veeam Agent for Microsoft Windows retains the yearly GFS backup. |
|
|
BeginTimeUtc |
Date and time (UTC) from which Veeam Agent for Microsoft Windows starts to keep yearly GFS backups. |
|
|
DesiredTime |
Month of the year whose backup is flagged as the yearly GFS backup. |
|