Set-VBRRPONotificationOption

In this article

    Short Description

    Modifies RPO notification settings.

    Applies to

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

    Syntax

    Set-VBRRPONotificationOption -RPONotificationOption <VBRRpoNotificationOption> [-EnableRPOWarning <SwitchParameter>] [-Value <Int32>] [-TimeUnit <VBRRpoTimeUnit>] [-RPOType <VBRRpoType>] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies RPO notification settings.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    RPONotificationOption

    Specifies the RPO notification settings that you want to modify.

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

    True

    Named

    True

    EnableRPOWarning

    Enables an RPO warning.

    SwitchParameter

    False

    Named

    False

    Value

    Specifies the number of minutes, hours or days when data must be copied from the source repository to the target repository.

    Int32

    False

    Named

    False

    TimeUnit

    Specifies a period of time when data must be copied from the source repository to the target repository. You can set one of the following periods of time:

    • Minutes
    • Hours
    • Days

    VBRRpoTimeUnit

    False

    Named

    False

    RPOType

    Specifies the following type of an RPO warning.

    • BackupJob: Use this option is you want to enable an RPO warning for a job.
    • BackupLogJob: Use this option is you want to enable an RPO warning for job logs.

    VBRRpoType

    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 VBRRPONotificationOptions object that defines RPO notification settings.

    Examples

    Modifying RPO Notification Settings

    This example shows how to modify the RPO notification settings. According to these options, Veeam Backup & Replication will mark a copy job with a warning if the newly created restore point is not copied within 15 minutes.

    $rpo = New-VBRRPONotificationOptions -EnableRPOWarning -TimeUnit Hours -Value 1

    Set-VBRRPONotificationOption -RPONotificationOption $rpo -TimeUnit Minutes -Value 15

    Perform the following steps:

    1. Run the New-VBRRPONotificationOptions cmdlet. Specify the Name, EnableRPOWarning, TimeUnit and Value parameter values. Save the result to the $rpo variable.
    2. Run the Set-VBRRPONotificationOption cmdlet. Specify the following settings:
    • Set the $rpo variable as the RPONotificationOption parameter value.
    • Specify the TimeUnit parameter value.
    • Specify the Value parameter value.