Oracle Cloud Infrastructure Documentation

Policy-Based Volume Group Backups

Policy-based volume group backups are automated, scheduled backups defined by the policy assigned to the volume group.

Policy-based backups for volume groups are the same as policy-based backups for block volumes, the main difference is that the backup policy is applied to all the volumes in the volume group instead of a single volume. For general information about policy-based backups, see Policy-Based Backups. The process to create and configure user defined backup policies are the same for volume groups as they're for volumes, see Creating and Configuring User-Defined Backup Policies for these procedures.

Note

Vault encryption keys for volumes aren't copied to the destination region for scheduled volume and volume group backups enabled for cross region copy. Instead, you can specify a Vault encryption key for the backup copied to the destination region when you assign the backup policy. When you assign the backup policy, if it's enabled for cross region backup copies, select Encrypt using customer-managed keys for Cross region backup copy encryption to encrypt the volume or volume group backup in the destination region. If you select this option, you must specify the OCID for a valid encryption key in the destination region, see Requirements for Customer-Managed Encryption Keys for Cross-Region Operations for more information.
Note

Oracle defined backup policies aren't supported for scheduled volume group backups.

Managing Backup Policy Assignments to Volume Groups

The backup policy assigned to a volume group defines the frequency and schedule for volume group backups. This section covers how to perform tasks related to managing the backup policy assignments for your volume groups using the Console, command line interface (CLI), and REST APIs.

If a volume group has an assigned backup policy, you must remove any backup policy assignments from volumes before you can add them to the volume group.

Before you can assign a backup policy to an existing volume group containing one or more volumes with assigned backup policies, you must remove those policy assignments from the individual volumes.

Applying Tags

Apply tags to Block Volume resources to organize them to fit your needs.

Apply tags to resources to help organize them according to your business needs. You can apply tags when you create a resource, and you can update a resource later to add, revise, or remove tags. For general information about applying tags, see Resource Tags.

When a volume backup is created, the source volume's tags are automatically included. This also includes volumes with custom backup policies applied to create scheduled backups. Source volume tags are automatically assigned to all backups when they are created. You can also apply additional tags to volume backups as needed.

When a volume backup is copied to a new region, tags are also automatically copied with the volume backup. When the volume is restored from a backup, the volume is restored with the source volume's tags.

Assigning a Backup Policy to a Volume Group

Learn how to assign a backup policy to a volume group.

    1. Open the navigation menu  and select Storage. Under Block Storage, select Volume Groups.
    2. Select the volume group you want to assign a backup policy to.
    3. On the Volume Group Details page, select Edit.

    4. In the BACKUP POLICIES section, select the compartment containing the backup policies.

    5. Select the appropriate backup policy for your requirements.

    6. Optionally, if you select a backup policy enabled for cross region backup copies, you can encrypt the backup copy in the destination region with your own Vault encryption key by selecting Encrypt using customer-managed keys for Cross region backup copy encryption. If you select this option, you must specify the OCID for a valid encryption key in the destination region, see Requirements for Customer-Managed Encryption Keys for Cross-Region Operations.

    7. Select Save Changes.

  • Use the oci bv volume-backup-policy-assignment create command and specify the --asset-id and --policy-id parameters to assign the policy to the volume backup group:

    oci bv volume-backup-policy-assignment create --asset-id <volume_group_ID> --policy-id <policy_ID> --xrc-kms-key-id <kms_key_ID>

    For example:

    oci bv volume-backup-policy-assignment create --asset-id ocid1.volumegroup.oc1..<unique_ID> --policy-id ocid1.volumebackuppolicy.oc1..<unique_ID> --xrc-kms-key-id ocid1.key.oc1.iad-ad-1.<unique_ID>

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Run the CreateVolumeBackupPolicyAssignment operation and specify the assetId and policyId attributes in the CreateVolumeBackupPolicyAssignmentDetails resource to assign the policy to the volume group backup.

Changing the Backup Policy Assigned to a Volume Group

Learn how to change the backup policy assigned to a Volume Group.

    1. Open the navigation menu  and select Storage. Under Block Storage, select Volume Groups.
    2. Select the volume group for which you want to change the backup policy for.
    3. On the Volume Group Details page, select Edit.

    4. In the Backup policy section, select the compartment containing the backup policy.

    5. Select the backup policy you want to switch to.

    6. Optionally, if you select a backup policy enabled for cross-region backup copies, you can encrypt the backup copy in the destination region with your own Vault encryption key by selecting Encrypt using customer-managed keys for Cross region backup copy encryption. If you select this option, you must specify the OCID for a valid encryption key in the destination region. For more information, see Requirements for Customer-Managed Encryption Keys for Cross-Region Operations.
    7. Select Next.
    8. Select Save changes.

  • Use the oci bv volume-backup-policy-assignment-create command and specify the --asset-id, --policy-id, and --xrc-kms-key-id parameters to change the backup policy assigned to a volume group:

    oci bv volume-backup-policy-assignment create --asset-id <volume_group_ID> --policy-id <policy_ID> --xrc-kms-key-id <kms_key_ID>

    For example:

    oci bv volume-backup-policy-assignment create --asset-id ocid1.volumegroup.oc1..<unique_ID> --policy-id ocid1.volumebackuppolicy.oc1..<unique_ID> --xrc-kms-key-id ocid1.key.oc1.iad-ad-1.<unique_ID>

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Run the CreateVolumeBackupPolicyAssignment operation and specify the assetId for an existing volume group and policyId attributes in the CreateVolumeBackupPolicyAssignmentDetails resource to assign the policy to the volume group backup.

Deleting a Backup Policy Assigned to a Volume Group

Learn how to delete a backup policy assigned to a volume group.

    1. Open the navigation menu  and select Storage. Under Block Storage, select Volume Groups.
    2. Select the volume group you want to remove the backup policy for.
    3. On the Volume Group Details page select Edit.
    4. Select Backup policy.

    5. In the Backup policies section, select None from the list, and then select Save changes.

  • Use the oci bv volume-backup-policy-assignment delete command and specify the --policy-id parameter to delete a backup policy assigned to a volume group:

    oci bv volume-backup-policy-assignment delete --policy-id <policy_ID>

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Run the DeleteVolumeBackupAssignment operation and specify the policyAssignmentId attribute to delete a volume group backup policy assignment.

Getting a Volume Group's Backup Assignment Policy Details

Learn how to get a the backup assignment policy details for a volume.

    1. Open the navigation menu  and select Storage. Under Block Storage, select Volume Groups.
    2. The backup policies assigned to volume groups are listed in the Backup policy column.

  • Use the oci bv volume-backup-policy-assignment get-volume-backup-policy-asset-assignment command and specify the --asset-id parameter to get the backup assignment policy details for a volume group:

    oci bv volume-backup-policy-assignment get-volume-backup-policy-asset-assignment --asset-id <volume_group_ID>

    For example:

    oci bv volume-backup-policy-assignment get-volume-backup-policy-asset-assignment --asset-id ocid1.volumegroup.oc1..<unique_ID>

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Run the GetVolumeBackupPolicyAssetAssignment operation and specify the assetId attribute to get the backup assignment policy details for a volume group.

Getting Details for a Specific Backup Policy Assignment

Learn how to retrieve details for a specific backup policy assignment.

  • This task can't be performed using the Console.

  • Use the oci bv volume-backup-policy-assignment get command and specify the --policy-assignment-id parameter to get details for a backup policy assignment:

    oci bv volume-backup-policy-assignment get --policy-assignment-id policy_assignment_ID

    For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

  • Run the GetVolumeBackupPolicyAssignment operation and specify the policyAsssignmentId attribute to retrieve information for a volume backup policy assignment.