Set-VBRCDPPolicyRetentionOptions

In this article

    Short Description

    Modifies retention settings of CDP policies.

    Applies to

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

    Syntax

    Set-VBRCDPPolicyRetentionOptions -Options <VBRCDPPolicyRetentionOptions> [-RPOIntervalType <VBRCDPRPOIntervalType> {Minutes | Seconds}] [-RPOInterval <int>] [-BackupWindow <VBRBackupWindowOptions>] [-ShortTermRetentionIntervalType <VBRCDPRetentionIntervalType> {Minutes | Hours}] [-ShortTermRetentionInterval <int>] [-LongTermRetentionFrequency <int>] [-LongTermRetentionInterval <int>] [-LongTermRetentionIntervalType <VBRCDPRetentionIntervalType> {Minutes | Hours}] [-ApplicationProcessingBackupWindow <VBRBackupWindowOptions>] [-EnableRPOMarkAsWarning <bool>] [-MarkJobAsWarningThreshold <int>] [-MarkJobAsWarningIntervalType    <VBRCDPRPOIntervalType> {Minutes | Seconds}] [-EnableRPOMarkAsError <bool>] [-MarkJobAsErrorThreshold <int>][-MarkJobAsErrorIntervalType <VBRCDPRPOIntervalType> {Minutes | Seconds}]  [<CommonParameters>]

    This cmdlet modifies retention setting of CDP policies. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Options

    Specifies retention settings of CDP policies that you want to modify.

    Accepts the VBRCDPPolicyRetentionOptions object. To create this object, run the New-VBRCDPPolicyRetentionOptions cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

    RPOIntervalType

    Specifies RPO settings. The cmdlet will schedule the CDP policy to create a replicated state of the source VMs. You can set one of the following units of time:

    • Minutes: Use this option to schedule a CDP policy to create a replicated state of the source VMs every N minutes.
    • Seconds: Use this option to schedule a CDP policy to create a replicated state of the source VMs every N seconds.

    Default: Seconds.

    VBRCDPRPOIntervalType

    False

    Named

    False

    RPOInterval

    Specifies a number of minutes or seconds for the RPO settings. The cmdlet will schedule the CDP policy to create a replicated state of the source VMs every N seconds or minutes.

    Default: 15

    Int

    False

    Named

    False

    BackupWindow

    Specifies a time interval within which a CDP policy is allowed to create a replicated state of the source VMs.

    Accepts the VBRBackupWindowOptions object. To get this object, run the New-VBRBackupWindowOptions cmdlet.

    False

    Named

    False

    ShortTermRetentionIntervalType

    For a short-term retention policy.

    Specifies a period during which Veeam Backup & Replication will store a replicated state of the source VMs on a target datastore. You can set the period in one of the following units of time:

    • Minutes: Use this option to store a replicated state of the source VMs for last N minutes.
    • Hours: Use this option to store a replicated state of the source VMs for last N hours.

    Default: Hours.

    VBRCDPRetentionIntervalType

    False

    Named

    False

    ShortTermRetentionInterval

    For a short-term retention settings.

    Specifies a number of minutes or hours to store a replicated state of the source VMs. The cmdlet will schedule a CDP policy to store a replicated state of the source VMs only for last N minutes or hours.

    Default: 4

    Int

    False

    Named

    False

    LongTermRetentionIntervalType

    For a long-term retention settings.

    Specifies a period when a CDP policy must create long-term restore points. You can set the period in one of the following units of time:

    • Minutes: Use this option to create a long-term restore point every N minutes.
    • Hours: Use this option to create a long-term restore point every N hours.

    Default: Hours.

    VBRCDPRetentionIntervalType

    False

    Named

    False

    LongTermRetentionFrequency

    For a long-term retention option.

    Specifies how often a CDP policy must create a long-term restore point. The cmdlet will schedule the CDP policy to create a restore point every N hours.

    Default: 8.

    Int

    False

    Named

    False

    LongTermRetentionInterval

    For a long-term retention option.

    Specifies a number of days to keep a long-term restore point on a datastore. After this period is passed, Veeam Backup & Replication will delete a long-term restore point.

    Default: 7.

    Int

    False

    Named

    False

    ApplicationProcessingBackupWindow

    Specifies a schedule that defines when a CDP policy must create crash-consistent and application-consistent backups.

    Accepts the New-VBRBackupWindowOptions object. To get this object, run the New-VBRBackupWindowOptions cmdlet.

    False

    Named

    False

    EnableRPOMarkAsWarning

    For RPO reports.

    Enables RPO warning reports for a CDP policy.

    Bool

    False

    Named

    False

    MarkJobAsWarningThreshold

    For RPO reports.

    Specifies an allowed time limit of the exceeded RPO. Veeam Backup & Replication will send notification with a warning if this time limit is reached.

    Defaule: 2.

    Int

    False

    Named

    False

    MarkJobAsWarningIntervalType

    For RPO reports.

    Specifies a time interval of the exceeded RPO. You can set the period in one of the following units of time:

    • Seconds: Use this option to get a warning notification after a time interval of the exceeded RPO reaches N seconds.
    • Minutes: Use this option to get a warning notification after a time interval of the exceeded RPO reaches N minutes.

    Default: Seconds.

    VBRCDPRPOIntervalType

    False

    Named

    False

    EnableRPOMarkAsError

    For RPO reports.

    Enables RPO error reports for a CDP policy.

    Bool

    False

    Named

    False

    MarkJobAsErrorThreshold

    For RPO reports.

    Specifies an allowed time limit of the exceeded RPO. Veeam Backup & Replication will send notification with a warning if this time limit is reached.

    Defaule: 3.

    Int

    False

    Named

    False

    MarkJobAsErrorIntervalType

    For RPO reports.

    Specifies a time interval of the exceeded RPO. You can set the period in one of the following units of time:

    • Seconds: Use this option to get an error notification after a time interval of the exceeded RPO reaches N seconds.
    • Minutes: Use this option to get an error notification after a time interval of the exceeded RPO reaches N minutes.

    Default: Seconds.

    VBRCDPRPOIntervalType

    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

    The cmdlet returns the VBRCDPPolicyRetentionOptions object that defines retention policy and schedule settings of CDP policies.

    Examples

    Set-VBRCDPPolicyRetentionOptionsExample 1. Modifying Short-Term Retention for CDP Policy

    This example shows how to modify short-term retention for CDP policy to keep keep only those replicated states of the source VMs that were created within last 5 hours.

    $options = New-VBRCDPPolicyRetentionOptions -ShortTermRetentionIntervalType Hours -ShortTermRetentionInterval 2

    Set-VBRCDPPolicyRetentionOptions -Options $options -ShortTermRetentionInterval 5

    Perform the following steps:

    1. Run the New-VBRCDPPolicyRetentionOptions cmdlet. Specify the ShortTermRetentionIntervalType and ShortTermRetentionInterval parameters. Save the result to the $options variable.
    2. Run the Set-VBRCDPPolicyRetentionOptions cmdlet. Set the $options variable as the Options parameter value. Specify the ShortTermRetentionInterval parameter value.

    Set-VBRCDPPolicyRetentionOptionsExample 2. Modifying Long-Term Retention for CDP Policy

    This example shows how to modify long-term retention for CDP policy to create a long-term restore point every 9 hours.

    $options = New-VBRCDPPolicyRetentionOptions -LongTermRetentionIntervalType Hours -LongTermRetentionInterval 3

    Set-VBRCDPPolicyRetentionOptions -Options $options -LongTermRetentionInterval 9

    Perform the following steps:

    1. Run the New-VBRCDPPolicyRetentionOptions cmdlet. Specify the LongTermRetentionIntervalType and LongTermRetentionInterval parameters. Save the result to the $options variable.
    2. Run the Set-VBRCDPPolicyRetentionOptions cmdlet. Set the $options variable as the Options parameter value. Specify the LongTermRetentionInterval parameter value.

    Related Commands

    New-VBRCDPPolicyRetentionOptions

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.