Creates a volume group backup copy in specified region. For general information about volume group backups, see Overview of Block Volume Backups.


oci bv volume-group-backup copy [OPTIONS]

Required Parameters

--destination-region [text]

The name of the destination region.


--volume-group-backup-id [text]

The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.

Optional Parameters

--display-name [text]

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link:

--kms-key-id [text]

The OCID of the Vault service key in the destination region which will be the master encryption key for the copied volume group backup. If you do not specify this attribute the volume group backup will be encrypted with the Oracle-provided encryption key when it is copied to the destination region.

For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state defined by --wait-for-state. Defaults to 1200 seconds.

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the resource has reached the lifecycle state defined by --wait-for-state. Defaults to 30 seconds.

Example using required parameter

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci bv volume-group create --generate-param-json-input source-details > source-details.json

Copy the following CLI commands into a file named Run the command by typing “bash” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export availability_domain=<substitute-value-of-availability_domain> #
    export compartment_id=<substitute-value-of-compartment_id> #
    export destination_region=<substitute-value-of-destination_region> #

    volume_group_id=$(oci bv volume-group create --availability-domain $availability_domain --compartment-id $compartment_id --source-details file://source-details.json --query --raw-output)

    volume_group_backup_id=$(oci bv volume-group-backup create --volume-group-id $volume_group_id --query --raw-output)

    oci bv volume-group-backup copy --destination-region $destination_region --volume-group-backup-id $volume_group_backup_id