How do I enable and configure Object Lock settings in an HBS job?


Last modified date: 2024-04-10

Applicable Products

Hybrid Backup Sync


Background

Object Lock is a feature on some cloud service providers that enables you to store objects using a WORM (Write Once Read Many) model, which prevents objects from being deleted or overwritten for a specified amount of time. 

Hybrid Backup Sync (HBS) supports the Object Lock feature on certain cloud service providers, including Amazon S3, Backblaze B2, and Wasabi. You can enable and configure Object Lock settings in HBS jobs where one of these cloud storage spaces is the destination. 


Instructions

In the following steps, we show you how to enable and configure Object Lock settings by creating a backup job using Amazon S3 as the destination.

  1. Open HBS 3.
  2. Optional: Create a storage space on Amazon S3 & S3 Compatible.
    Skip this step if you have already created the storage space in HBS 3.
    1. Go to Storage Spaces.
    2. Click Create > Amazon S3 & S3 Compatible.
      The Create a Storage Space window opens.
    3. Configure the storage space settings.
    4. Click Create.
  3. Go to Backup & Restore.
  4. Click Create > New backup job.
    The Create a Backup Job wizard opens.
  5. Select one or more source folders.
  6. Click Next.
  7. Click Amazon S3 & S3 Compatible.
  8. Create a bucket with Object Lock enabled.
    1. Click New Bucket.
      The Create a New Bucket window opens.
    2. Specify a bucket name.
    3. Specify the region.
    4. Select Enable Object Lock.
    5. Click Create.
  9. Configure the remaining settings on the page.
  10. Click Select.
  11. Select the destination folder.
  12. Click OK.
  13. Optional: Specify the job name and description.
  14. Click Next.
  15. Optional: Configure the schedule settings.
  16. Click Next.
  17. Optional: Override the default Object Lock settings.
    1. Go to Policies > Advanced settings.
    2. Select Override Object Lock default settings.
    3. Change the immutability period.
      The default immutability period is 30 days.
    4. Change the extended retention period.
      The default extended retention period is 10 days.
      Note
      For illustrated examples of how the immutability and extended retention periods work, see the next section.
  18. Optional: Configure other settings.
  19. Click Next.
  20. Click Create.
    HBS 3 creates the backup job with Object Lock enabled.

How Do the Immutability and Extended Retention Periods Work?

To understand how the immutability period and extended retention period work, let's look at two examples below.

Suppose we configure the job schedule and Object Lock settings as follows:

  • Backup job schedule: Daily
  • Immutability period: 20 days
  • Extended retention period: 10 days
Example 1 - The file does not change during the immutability period

Day 1: HBS 3 uploads Cat.png (version 1) to the destination storage space.

Days 2-20: Cat.png has not been modified, so the file is not uploaded to the destination.

Day 21: The retention date of Cat.png version 1 is extended for an additional 10 days of protection.

Example 2 - The file changes during the immutability period

Day 1: HBS 3 uploads Cat.png object (version 1) to the destination storage space.

Day 16: Cat.png has been modified, so HBS 3 uploads the modified Cat.png to the destination as Cat.png version 2.
Cat.png version 2 is treated as a different object because Cat.png version 1 is still in its immutability period, so a different immutability period begins for Cat.png version 2.

Day 36 (Day 16 + 20 days):  The retention date of Cat.png version 2 is extended for an additional 10 days of protection.

The two examples show that if you modify a file during its immutability period, the modified file will be treated as a new object with its own immutability and extended retention periods when it is uploaded to the cloud storage space.

The HBS 3 database and the cloud storage database both keep track of each file's version history and Object Lock status.

Users can change the immutability period and the extended retention period any time by editing the job and going to Rules > Policies > Advanced settings > Override Object Lock default settings.


Further Reading

Was this article helpful?

60% of people think it helps.
Thank you for your feedback.

Please tell us how this article can be improved:

If you want to provide additional feedback, please include it below.

Choose specification

      Show more Less

      Choose Your Country or Region

      open menu
      back to top