Orchestration v2 Attributes for StorageAttachment

The following sample JSON shows the key attributes of the StorageAttachment 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.

{
    "storage_volume_name": "{{My_Storage_Volume:name}}",
    "instance_name": "{{My_Instance:name}}",
    "index": 1
 }
Parameter Required or Optional Description

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.

instance_name

required

The name of the instance to which you want to attach the storage volume.

You can specify the object name as a reference to an object. For example, for an instance with the label my_instance, you can specify its name as follows:

"instance_name": "{{my_instance:name}}", 

storage_volume_name

required

The name of the storage volume that you want to attach to the instance.

You can specify the object name as a reference to an object. For example, for a storage volume with the label my_volume, you can specify its name as follows:

"storage_volume_name": "{{my_volume:name}}", 

index

required

The index number for the volume.

The allowed range is 1 to 10. If you want to use a storage volume as the boot disk for an instance, you must specify the index number for that volume as 1.

The index determines the device name by which the volume is exposed to the instance. Index 0 is allocated to a nonpersistent boot disk, /dev/xvda. An attachment with index 1 is exposed to the instance as /dev/xvdb, an attachment with index 2 is exposed as /dev/xvdc, and so on.