<a id="protection-groups"></a>

# Data Protection using Protection Groups

## Introduction

Backup Protection Groups are backup policies that define backup schedule
intervals and retention periods.

VMs and volumes that are a protection group’s protected resources are
backed up according to the group’s backup schedule and retention settings.

A Protection Group can optionally be configured to back up local snapshots
to a Remote Object Storage.

There are no prerequisites for the creation of a Protection Group.

Protected resources such as volumes and VM instances can be added to a
Protection Group at any time.

## Backup Protection Group Operations

### Viewing Backup Protection Groups

1. Navigate to **Protection > Protection Groups**.
2. Click the **Backup Protection Groups** tab.

   A list of configured Backup Protection Groups displays, with the
   following columns:

   | Column                | Description                                                        |
   |-----------------------|--------------------------------------------------------------------|
   | Name                  | The Protection Group’s name                                        |
   | Remote Retention Days | Number of days the backup is retained in the remote Object Storage |
   | Local Retention Days  | Number of days the local backup is retained                        |
   | Last Triggered        | The last date and time a snapshot was taken                        |
   | User                  | The user that triggered the last snapshot                          |
   | Resources             | The number of protected resources backed up in the last snapshot   |
   | Enabled               | Indicator whether the Protection Group is currently enabled        |
   | External Endpoint     | Name of the External Endpoint to Object Storage                    |
   | Admin Only            | Indicator whether the Protection Group is managed only by the MSP  |
   | Health                | The Protection Group’s health status                               |
   | State                 | The Protection Group’s readiness status for triggering snapshots   |
3. To view a Backup Protection Group’s details, click
   its **Name**, to display the following:
   * **Top Menu Bar**

     The Backup Protection Group’s top menu bar displays the following
     option buttons:
     * **Disable**: See [Enabling or Disabling a Backup Protection Group](#enable-disable-backup-protection-group).
     * **Modify**: See [Modifying a Backup Protection Group](#modify-backup-protection-group).
     * **Schedule**: See [Rescheduling a Backup Protection Group](#reschedule-backup-protection-group).
     * **Trigger Now**: See [Backup Protection Group Trigger Now](#trigger-now-backup-protection-group).
     * **Delete**: See [Deleting a Backup Protection Group](#delete-backup-protection-group).

     If the Backup Protection Group is not configured for backup to
     remote Object Store, the top menu bar also display’s the following
     option button:
     * **Associate Object Storage**: See [Associating a Backup Protection Group with an Object Storage](#associate-backup-protection-group-with-object-storage).
   * **Top Pane**

     The Backup Protection Group’s top pane displays the following
     sections:
     * **Backup Protection Group** basic information: Name, Description,
       Status and Health
     * **Schedule** details for local Snapshots and Remote Object
       Storage Snapshots
     * **Protected Resources** summary count of protected resources,
       grouped by type (VMs, volumes)
     * **External Endpoint** parameter values
   * **Lower Pane** tabs:

     The Backup Protection Group’s lower pane has the following tabs:
     * **Overview** tab:

       Basic information about the Backup Protection Group:

       | Column            | Description                                                       |
       |-------------------|-------------------------------------------------------------------|
       | Name              | The Protection Group’s name                                       |
       | Type              | The type of Protection Group (Backup or Restore)                  |
       | Creation Date     | The date and time the Protection Group was created                |
       | Last Update       | The date and time of the last change to the configuration         |
       | External Endpoint | Name of the External Endpoint to Object Storage                   |
       | Enabled           | Indicator whether the Protection Group is currently enabled       |
       | Admin Only        | Indicator whether the Protection Group is managed only by the MSP |
       | ID                | The Protection Group’s UUID                                       |
     * **Events** tab

       Allows applying filters to view selections of the Protection
       Group’s events log.
     * **Protected Resources** tab

       See [Adding or Removing Protected Resources](#add-protected-resources-to-backup-protection-group).
     * **Local Protection Group Snapshots** tab

       List of the Protection Group’s local snapshots, with the option
       for authorized users to select and delete snapshots.
     * **Remote Protection Group Snapshots** tab

       List of the Protection Group’s snapshots on remote Object Storage,
       with the option for authorized users to select and delete snapshots.

<a id="creating-backup-protection-group"></a>

### Creating a Backup Protection Group

To create a Backup Protection Group and configure its backup snapshot schedule:

1. Navigate to **Protection > Protection Groups**.

   A list of configured Backup Protection Groups displays in the
   **Backup Protection Groups** tab.
2. In the top menu bar, click **+ Create**.
3. In the **Create Backup Protection Group** dialog:
   1. In the **Group** tab, enter the parameters:
      * **Name**: A unique meaningful name for the Backup Protection Group.
      * **Description**: Optional description.
      * **Backup to Object Store**: Toggle switch determining whether
        local snapshots are backed up to a remote Object Store.

        Select:
        * **Off** (default): The snapshots are created locally.
        * **On**:

          If selected, from the **External Endpoint** dropdown select
          the B2OS endpoint for the remote Object Storage backup
          container.

          The snapshots are created locally.

          Local snapshots are backed up to the selected remote Object
          Storage destination container, as specified in the selected
          remote Object Storage’s External Endpoint.

      Click **Next**.
   2. In the **Schedule** tab, enter the parameters:

      **Local Snapshots**:
      * **Recurrence**: The frequency interval units, as one of:
        * **Minute**
        * **Hour**
        * **Day**
        * **Week**
        * **Month**
      * **Every**: The frequency interval as a number of the
        selected unit, between each snapshot.
        * For **Week** intervals, click the days of the week that
          weekly snapshots are scheduled.
        * For **Month** intervals, select one of the **Repeat by**
          options, and the **Start date**:

          **Day of the month**:

          Snapshots are scheduled for
          the selected day of the month, starting from the
          **Start date**, and repeating according to the interval
          defined as the number of months (*n*) in
          **Every** *n* **Month(s)**.

          For example, if **Every** = 2
          and **Start date** = 17 Jan 2025, snapshots are scheduled
          for the 17th of every second month, starting 17 Jan 2025.

          **Day of the week**:

          Snapshots are scheduled for
          the selected day of the week, and week of the month,
          starting from the **Start date**, and repeating
          according to the interval defined as the number of
          months (*n*) in **Every** *n* **Month(s)**.

          For example, if **Every** = 2
          and **Start date** = Fri 17 Jan 2025, since the start date
          occurs on the 3rd Friday of the month, snapshots are
          scheduled for the 3rd Friday of every second month,
          starting 17 Jan 2025.
        * **Start Time**: The start time of the schedule, in Hours and
          Minutes in 12-hour format, and either AM or PM.
        * **Retention for Local snapshots**: The duration in **days**
          to retain local snapshots.

          Local snapshots are deleted automatically after this duration.

      Additional parameters for Backup Protection Groups that are
      configured for **Backup to Object Store**:
      * **Remote Object Storage Snapshots**:
        * **Remote snapshots every**: The number oflocal
          snapshots that accumulate, after which they are backed up to
          the remote Object Store.
        * **Retention for Remote snapshots**: The duration in **days**
          to retain Remote snapshots.

          Remote snapshots are deleted automatically after this duration.

      Click **Finish**.

<a id="add-protected-resources-to-backup-protection-group"></a>

### Adding or Removing Protected Resources

1. Navigate to **Protection > Protection Groups**.

   A list of configured Backup Protection Groups displays in the
   **Backup Protection Groups** tab.
2. Click the Backup Protection Group to add or remove protected resources.

   The Backup Protection Group’s details display.
3. In the lower pane, click the **Protected Resources** tab.

   The Backup Protection Group’s protected resources are listed.
   * **Adding a VM instance to the Backup Protection Group**
     1. In the lower pane menu bar click **+ Add VM**.
     2. In the **Add instance to protection group** dialog,
        from the **VMs** dropdown, select the VM instance to add to the
        Backup Protection Group, and click **OK**.

        The VM instance appears in the Backup Protection Group’s
        protected resources list.

        Future snapshots of the Backup Protection Group will include the
        VM instance and its attached volumes.
   * **Adding a Volume to the Backup Protection Group**
     1. In the lower pane menu bar click **+ Add Volume**.
     2. In the **Add volume to protection group** dialog,
        from the **Volumes** dropdown, select the volume to add to the
        Backup Protection Group, and click **OK**.

        The volume appears in the Backup Protection Group’s
        protected resources list.

        Future snapshots of the Backup Protection Group will include the
        volume.
   * **Removing a VM or Volume from the Backup Protection Group**

     To remove a protected resource:
     1. On the row of the VM or volume to remove from the Backup
        Protection Group, click anywhere **except** on the Resource Name.

        The **Remove Protection** option appears on the lower pane
        menu bar.
     2. Click **Remove Protection**.

        In the **Remove Protection** confirmation dialog, click **OK**
        to proceed with removing the selected VM or volume from the
        Backup Protection Group.

        The VM or volume disappears from the Backup Protection Group’s
        protected resources list.

        Future snapshots of the Backup Protection Group will no longer
        include the removed VM or volume.

<a id="enable-disable-backup-protection-group"></a>

### Enabling or Disabling a Backup Protection Group

1. Navigate to **Protection > Protection Groups**.

   A list of configured Backup Protection Groups displays in the
   **Backup Protection Groups** tab.

   The **Enabled** column displays the Backup Protection Group’s Enabled
   or Disabled status.
2. Click a Backup Protection Group to select it for Enabling or Disabling.

   The Backup Protection Group details display.
3. In the top menu bar, click the **Enable/Disable** toggle.

   The **Enabled** status field displays the Backup Protection Group’s
   updated Enabled or Disabled status.

> <a id="modify-backup-protection-group"></a>

### Modifying a Backup Protection Group

To modify a Backup Protection Group:

1. Navigate to **Protection > Protection Groups**.

   A list of configured Backup Protection Groups displays.
2. Click a Backup Protection Group to modify it.

   The Backup Protection Group details display.
3. In the top menu bar, click **Modify**.
4. In the **Update Backup Protection Group** dialog,
   optionally modify one or more of the modifiable parameters:
   * **Name**: A unique meaningful name for the Backup Protection Group.
   * **Description**: Optional description.
   * **Backup to Object Store**: Toggle switch determining whether
     local snapshots are backed up to a remote Object Store.

     Select:
     * **Off** (default): The snapshots are created locally.
     * **On**:

       The snapshots are created locally.

       Local snapshots are backed up to the selected remote Object
       Storage destination container, as specified in the selected
       remote Object Storage’s External Endpoint.

       If selected, the **Associate Object Storage** dialog opens.

       **Group** tab:
       1. From the **External Endpoint** dropdown select the B2OS
          endpoint for the remote Object Storage backup container.
       2. Click **Next** to continue to the **Schedule** tab.

       **Schedule** tab:
       1. Optionally modify the **Local Snapshots** schedule parameters
          as described in [Rescheduling a Backup Protection Group](#reschedule-backup-protection-group).
       2. Accept or modify the **Remote Object Storage Snapshots**
          parameters, as described in
          [Rescheduling a Backup Protection Group](#reschedule-backup-protection-group).
       3. Click **Finish**.

<a id="reschedule-backup-protection-group"></a>

### Rescheduling a Backup Protection Group

To change the frequency or time of a Backup Protection Group’s local or
remote Object Storage snapshots:

1. Navigate to **Protection > Protection Groups**.

   A list of configured Backup Protection Groups displays.
2. Click a Backup Protection Group to select it for snapshot rescheduling.

   The Backup Protection Group details display.
3. In the top menu bar, click **Schedule**.
4. In the **Schedule Backup Protection Group** dialog, modify the relevant
   parameters:
   * **Local Snapshots**:
     * **Recurrence**: The snapshot frequency interval units, as one of:
       * **Minute**
       * **Hour**
       * **Day**
       * **Week**
       * **Month**
     * **Every**: The snapshot frequency interval as a number of the
       selected unit, between each snapshot.
       * For **Week** intervals, click the days of the week that
         weekly snapshots are scheduled.
       * For **Month** intervals, select one of the **Repeat by**
         options, and the **Start date**:

         **day of the month**:

         Based on the **Start date**,
         snapshots are scheduled to repeat on the selected day
         of the month at the interval frequency of the number
         entered for **Every** number of months.

         For example, if **Every** = 2
         and **Start date** = 24 Jan 2025, snapshots are scheduled
         for the 24th of every second month, starting 24 Jan 2025.

         **day of the week**:

         Based on the **Start date**,
         snapshots are scheduled to repeat on the selected day
         of the week, and week of the month, at the interval
         frequency of the number entered for **Every** number of
         months.

         For example, if **Every** = 2
         and **Start date** = Fri 24 Jan 2025, since the start date
         occurs on the 4th Friday of the month, snapshots are
         scheduled for the 4th Friday of every second month,
         starting 24 Jan 2025.
     * **Start Time**: The start time of the schedule, in Hours and
       Minutes in 12-hour format, and either AM or PM.
     * **Retention for Local snapshots**: The duration in **days**
       to retainlocal snapshots.

       Local snapshots are deleted automatically after this duration.

   Additional parameters for Backup Protection Groups that are
   configured for **Backup to Object Store**:
   * **Remote Object Storage Snapshots**:
     * **Remote snapshots every**: The number of local
       snapshots that accumulate, after which they are backed up to the remote
       Object Store.
     * **Retention for Remote snapshots**: The duration in **days**
       to retain remote snapshots.

       Remote snapshots are deleted automatically after this duration.

   Click **Finish**.

<a id="trigger-now-backup-protection-group"></a>

### Backup Protection Group Trigger Now

To trigger an immediate snapshot of a Backup Protection Group’s
protected resources, in addition to its scheduled snapshot:

1. Navigate to **Protection > Protection Groups**.

   A list of configured Backup Protection Groups displays.
2. Click a Backup Protection Group to select it for
   triggering an immediate snapshot.

   The Backup Protection Group details display.
3. In the top menu bar, click **Trigger Now**.
4. In the **Trigger Backup Protection Group** dialog:
   1. Optionally, enable **Remote Object Storage Snapshots** to send the
      snapshot to remote Object Storage.
   2. Click **OK** to progress with creating the snaphot of the protected
      resources immediately.

      The snapshot and its progress are listed in the Backup Protection
      Group’s **Local Protection Group Snapshots** tab in the lower pane.

      If **Remote Object Storage Snapshots** is enabled,
      the snapshot and its progress are also listed in the Remote Protection
      Group’s **Local Protection Group Snapshots** tab in the lower pane.

<a id="delete-backup-protection-group"></a>

### Deleting a Backup Protection Group

To delete a Backup Protection Group:

1. Navigate to **Protection > Protection Groups**.

   A list of configured Backup Protection Groups displays.
2. Click a Backup Protection Group to select it for deletion.

   The Backup Protection Group details display.
3. In the top menu bar, click **Delete**.
4. In the **Delete Protection Group** dialog, click **Delete** to confirm
   deletion of the Backup Protection Group.

<a id="associate-backup-protection-group-with-object-storage"></a>

### Associating a Backup Protection Group with an Object Storage

If a Backup Protection Group is configured for **Local Snapshots** only,
it is also possible to configure backup to remote Object Storage
by associating the Backup Protection Group with an Object Storage:

To associate a Backup Protection Group with an Object Storage:

1. Navigate to **Protection > Protection Groups**.

   A list of configured Backup Protection Groups displays.
2. Click a Backup Protection Group to select it for association with an
   Object Storage.

   The Backup Protection Group details display.
3. In the top menu bar, click **Associate Object Storage**.

   The **Associate Object Storage** dialog opens:

   In the **Group** tab:
   1. From the **External Endpoint** dropdown select the B2OS
      endpoint for the remote Object Storage backup container.
   2. Click **Next** to continue to the **Schedule** tab.

   In the **Schedule** tab:
   1. Optionally modify the **Local Snapshots** schedule parameters
      as described in [Rescheduling a Backup Protection Group](#reschedule-backup-protection-group).
   2. Accept or modify the Remote Object Storage Snapshots
      parameters, as described in
      [Rescheduling a Backup Protection Group](#reschedule-backup-protection-group).
4. Click **Finish**.

### Restoring from a Backup Protection Group

#### Restoring a VM instance

To restore a **VM instance**,
see [Recover VM Instances from Snapshots](msp-snapshots.md#recover-vm-instances-from-snapshots) in the
[Snapshots](msp-snapshots.md#snapshots) page.

The VM’s attached volumes are restored as an integral part of the VM
instance’s recovery process.

#### Restoring a Volume

To restore a **volume**:

1. Navigate to **Storage > Snapshots**.
2. Select the **Local Snapshots** tab.
3. Click **Create Volume** in the upper menu bar.
   1. In the **Create Volume** dialog, accept or update the values for:
      * **Name**: Volume name
      * **Volume Type**
   2. Click **OK**.

The restored volume displays in the **Storage > Block Storage**
list.

See [Volume Snapshot Operations](msp-snapshots.md#volume-snapshot-operations) in the [Snapshots](msp-snapshots.md#snapshots) page for
other snapshot operations.

## Restore Protection Group Operations

### Viewing Restore Protection Groups

1. Navigate to **Protection > Protection Groups**.
2. Click the **Restore Protection Groups** tab.

   A list of configured Restore Protection Groups displays, with the
   following columns:

   **Name**, **User**, **External Endpoint**, **Health** and **State**.
3. To view a Restore Protection Group’s External Endpoint details, click
   a Restore Protection Group.

   The Restore Protection Group’s External Endpoint details display
   in the lower pane.

### Creating a Restore Protection Group

To create a Restore Protection Group:

1. Navigate to **Protection > Protection Groups**.
2. Click the **Restore Protection Groups** tab.

   A list of configured Restore Protection Groups displays.
3. In the top menu bar, click **+ Create**.
4. In the **Create Restore Protection Group** dialog:
   1. Enter the parameters:
      * **Name**: A unique meaningful name for the Restore Protection Group.
      * **Description**: Optional description.
      * **External Endpoint**: From the dropdown, select the remote Object
        Storage from the list of B2OS endpoints.
   2. Click **Finish**.

### Modifying a Restore Protection Group

To modify a Restore Protection Group:

1. Navigate to **Protection > Protection Groups**.
2. Click the **Restore Protection Groups** tab.

   A list of configured Restore Protection Groups displays.
3. Click a Restore Protection Group to modify it.

   The Restore Protection Group details display.
4. In the top menu bar, click **Modify**.
5. In the **Update Restore Protection Group** dialog:
   1. Optionally modify one or both modifiable parameters:
      * **Name**: A unique meaningful name for the Restore Protection Group.
      * **Description**: Optional description.
   2. Click **Finish**.

### Deleting a Restore Protection Group

To delete a Restore Protection Group:

1. Navigate to **Protection > Protection Groups**.
2. Click the **Restore Protection Groups** tab.

   A list of configured Restore Protection Groups displays.
3. Click a Restore Protection Group to select it for deletion.

   The Restore Protection Group details display.
4. In the top menu bar, click **Delete**.
5. In the **Delete Protection Group** dialog, click **Delete** to confirm
   deletion of the Restore Protection Group.

### Restoring from a Restore Protection Group

### Restoring a VM instance from Object Storage

To restore a **VM instance** from a remote Object Storage,
see [Recover VM Instances from Snapshots](msp-snapshots.md#recover-vm-instances-from-snapshots) in the
[Snapshots](msp-snapshots.md#snapshots) page.

The VM’s attached volumes are restored as an integral part of the VM
instance’s recovery process.

### Restoring a Volume from Object Storage

To restore a **volume** from a remote Object Storage:

1. Navigate to **Storage > Snapshots**.
2. Select the **Remote Snapshots** tab.
3. Click **Create Volume** in the upper menu bar.
   1. In the **Create Volume** dialog, accept or update the values for:
      * **Name**: Volume name
      * **Volume Type**
   2. Click **OK**.

The restored volume displays in the **Storage > Block Storage**
list.

See [Volume Snapshot Operations](msp-snapshots.md#volume-snapshot-operations) in the [Snapshots](msp-snapshots.md#snapshots) page for
other snapshot operations.
