An attached Storage on a Server.
A list of these is available in the Server.storageDevices property when fetching the detailed server information from the Server.load API.
When attaching or detaching normal storage or a CD-ROM device to a server, one would typically use Builder API to define the storage device, and then either attach or detach that device to/from a server.
Similarly, when inserting or ejecting a CD-ROM into/from the CD-ROM device, one would typically use Builder API to define the storage device, and then either insert or eject that device to/from a server.
Fields inherited from class | Fields |
---|---|
class Resource |
__$stMC |
Type | Name and description |
---|---|
String |
action The operation when creating a server: clone , create , or attach . |
String |
address Hardware address where the storage is attached on the server. |
String |
bootDisk Whether to use this storage device as a boot disk. |
String |
partOfPlan Whether the storage is included in fixed plan price of the server ( yes ). |
Integer |
size Size of the created storage in gigabytes. |
String |
storage Unique identifier of the Storage. |
Integer |
storageSize Storage size in gigabytes. |
String |
storageTitle Storage title. |
String |
tier On which storage tier the storage should be placed: hdd or maxiops . |
String |
title Title of the created storage. |
String |
type Type of the storage: disk or cdrom . |
Methods inherited from class | Name |
---|---|
class Resource |
setProperty, getProperty, toString, asType, getMetaClass, setMetaClass, wrapper, propertyMissing, propertyMissing, methodMissing, proj, invokeMethod, this$dist$invoke$1, this$dist$set$1, this$dist$get$1, super$1$toString, getHTTP, getSESSION, getMETA, wait, wait, wait, equals, hashCode, getClass, notify, notifyAll |
class Object |
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
The operation when creating a server: clone
, create
, or attach
.
This should be set to clone
when creating a server from template or by cloning another server.
In these cases, the storage should be set to the Storage.uuid of the cloned template
or server disk. The cloned storage UUID will be returned in the response.
When creating a server by installing it from a CD-ROM, one storage device (the new empty disk) should have
this set to create
(and no storage), and another storage device (the CD-ROM) should have
this set to attach
(and storage set to the Storage.uuid of the CD-ROM}).
This can not be used when attaching or detaching storage device from a server. This can not be specified when inserting a CD-ROM to a CD-ROM device.
Hardware address where the storage is attached on the server.
This is available in the server details response, and can optionally be set when creating a server or when attaching a new storage device to a server, where this defaults to next available slot. When detaching a storage device from a server, this is the only allowed property. This can not be specified when inserting a CD-ROM to a CD-ROM device.
Possible values are:
ide:0:0
ide:0:1
ide:1:0
ide:1:1
scsi:0:0
scsi:0:1
scsi:0:2
scsi:0:3
scsi:0:4
scsi:0:5
scsi:0:6
scsi:0:7
virtio:0
virtio:1
virtio:2
virtio:3
virtio:4
virtio:5
virtio:6
virtio:7
Whether to use this storage device as a boot disk.
This defaults to 0
which means that this storage device will not be used as boot disk.
This is available on a server details response.
This can optionally be set to 1
when attaching storage device to a server, or when creating a server.
This has no meaning when detaching a storage device from a server or when inserting a CD-ROM to a CD-ROM device.
A server can have only one boot disk. This setting can be overridden with the server Server.bootOrder attribute.
Whether the storage is included in fixed plan price of the server (yes
).
This is available on a server details response. This can not be set when creating a server or when attaching or detaching a storage device from a server. This can not be specified when inserting a CD-ROM to a CD-ROM device.
Size of the created storage in gigabytes.
When cloning a template or another server disk, this can optionally be set and defaults to the original size. When creating a new storage, this must be set. The newly created storage size will be returned in the storageSize property in the server details response.
This can not be used when attaching or detaching storage device from a server. This can not be specified when inserting a CD-ROM to a CD-ROM device.
Unique identifier of the Storage.
This is available on a server details response, where this corresponds to the attached storage.
When creating a server, this is required for storage devices with action clone
or
attach
, and not applicable for action create
. For cloning, this would correspond
to the template or server disk that is to be cloned. The new clone UUID will be returned in the response.
For attaching, this would correspond to the CD-ROM UUID.
When attaching a new storage device to a server, and using type of disk
, this must be
provided and corresponds to the storage that is to be attached. When attaching a CD-ROM device
(type cdrom
), this is optional. This can not be specified when detaching a storage device
from a server.
When inserting a storage as a CD-ROM to a CD-ROM device, this is the only allowed property.
Storage size in gigabytes.
This is available on a server details response. When creating a server from template or by installing it from a CD-ROM, use size property instead. This can not be used when attaching or detaching storage from a server. This can not be specified when inserting a CD-ROM to a CD-ROM device.
Storage title.
This is available on a server details response. When creating a server, use title property instead. This can not be used when attaching or detaching storage from a server. This can not be specified when inserting a CD-ROM to a CD-ROM device.
On which storage tier the storage should be placed: hdd
or maxiops
.
This can optionally be set when creating storage(s) for a new server (where action
is either
clone
or create
), and defaults to hdd
.
This can not be used when attaching or detaching storage device from a server. This can not be specified when inserting a CD-ROM to a CD-ROM device.
Title of the created storage.
This can optionally be set when creating storage(s) for a new server (where action
is either
clone
or create
), instead of storageTitle. This can not be used when attaching
or detaching storage device from a server. This can not be specified when inserting a CD-ROM to a CD-ROM
device.
Type of the storage: disk
or cdrom
.
This is available on a server details response. This should not be used when creating a server from
template or by cloning another server. When creating a server by installing it from a CD-ROM, this
can be set to cdrom
on the storage device that attaches the CD-ROM. When attaching a new storage
device to a server, this can be specified and defaults to disk
. This can not be specified when
detaching a storage from a server. This can not be specified when inserting a CD-ROM to a CD-ROM device.