Orchestration v2 Attributes for StorageSnapshot

The following sample JSON shows the key attributes of the StorageSnapshot object type. A description of each of the required and optional attributes of this object type is provided in the table that follows the JSON sample.

{
           "volume": "/Compute-acme/joe/vol1",
           "name": "/Compute-acme/joe/vol1-snapshot"
           "description": "Remote snapshot of vol1"
}
Parameter Required or Optional Description

volume

required

The three-part name /Compute-identity_domain/user/object_name of the storage volume that you want to create a snapshot of.

name

optional

The three-part name of the object (/Compute-identity_domain/user/object).

If you don’t specify a name for this object, then the name is generated automatically.

Object names can contain only alphanumeric characters, hyphens, underscores, and periods. Object names are case-sensitive.

When you specify the object name, ensure that an object of the same type and with the same name doesn’t already exist. If such an object already exists, another object of the same type and with the same name won’t be created and the existing object won’t be updated.

property

optional

Specify /oracle/private/storage/snapshot/collocated to create a colocated snapshot. Colocated snapshots are stored in the same physical location as the original storage volume. Colocated snapshots and volumes from colocated snapshots can be created very quickly.

If you don't specify a value, a remote snapshot is created. Remote snapshots aren't stored in the same location as the original storage volume. Instead, they are stored in the associated Oracle Cloud Infrastructure Object Storage Classic instance. Creating a remote snapshot and restoring a storage volume from a remote snapshot can take a longer time than for colocated snapshots, as data is written to and from the Oracle Cloud Infrastructure Object Storage Classic instance.

platform

optional

Specify the operating system platform for a bootable storage volume, such as Linux or Windows.

tags

optional

Strings that you can use to tag the storage snapshot.

description

optional

Description of the storage snapshot.