Set-VBRImmutabilityLockExpirationDate

In this article

    Short Description

    Modifies immutability period of restore points located in a hardened repository.

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

    Syntax

    Set-VBRImmutabilityLockExpirationDate [-RestorePoint] <COib[]> -ExpirationDate <DateTime> [<CommonParameters>]

    Note

    The following parameter sets are available starting from Veeam Backup & Replication 11a (build 11.0.1.1261).

    This cmdlet provides parameter sets that allow you to:

    • Extend immutability period of restore points located in a hardened repository.

    Set-VBRImmutabilityLockExpirationDate [-RestorePoint] <COib[]> -ExpirationDate <datetime>  [<CommonParameters>]

    • Reset immutability period of restore points located in a hardened repository.

    Set-VBRImmutabilityLockExpirationDate [-RestorePoint] <COib[]> -ToOriginal  [<CommonParameters>]

    Detailed Descriptio

    This cmdlet modifies immutability period of restore points located in a hardened repository.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    RestorePoint

    Specifies an array of restore points. The cmdlet will modify immutability period for these restore points.

    Accepts the COib[] object. To create this object, run the Get-VBRRestorePoint cmdlet.

    True

    0

    True (ByValue, ByPropertyName)

    ExpirationDate

    Specifies a date when Veeam Backup & Replication is allowed to remove restore points from a hardened repository with immutability.

    DateTime

    True

    Named

    False

    ToOriginal

    Note: This parameter is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261).

    Defines that the cmdlet will reset the immutability period of restore points to their original value. If you provide this value, the cmdlet will set the immutability to the maximum time period that is available for the hardened repository.

    SwitchParameter

    True

    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 VBRImmutabilityLockExpirationDate object that contains immutability period of of restore points located in hardened repository with immutability.

    Examples

    Set-VBRImmutabilityLockExpirationDateExample 1. Extending Immutability Period of Restore Points

    This examples shows how to set Veeam Backup & Replication to remove restore points on 03.02.2021 from the hardened repository.

    $restorepoint = Get-VBRRestorePoint

    $date = Get-Date -Year 2021 -Month 2 -Day 3 -Hour 0 -Minute 0 -Second 0

    Set-VBRImmutabilityLockExpirationDate -RestorePoint $restorepoint -ExpirationDate $date

    Perform the following steps:

    1. Run the Get-VBRRestorePoint cmdlet. Save the result to the $restorepoint variable.
    2. Run the Get-Date cmdlet. Save the result to the $date variable.
    3. Run the Set-VBRImmutabilityLockExpirationDate cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Specify the ExpirationDate parameter value.

    Set-VBRImmutabilityLockExpirationDateExample 2. Resetting Immutability Period of Restore Points

    This examples shows how to reset immutability period of restore points. The cmdlet will set the immutability to the time period that was originally specified for the hardened repository.

    $restorepoint = Get-VBRRestorePoint

    Set-VBRImmutabilityLockExpirationDate -RestorePoint $restorepoint -ToOriginal

    Perform the following steps:

    1. Run the Get-VBRRestorePoint cmdlet. Save the result to the $restorepoint variable.
    2. Run the Set-VBRImmutabilityLockExpirationDate cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Provide the ToOriginal parameter.

    Related Commands