VolumeProperties

Properties

NameTypeDescriptionNotes

availabilityZone

The availability zone in which the volume should be provisioned. The storage volume will be provisioned on as few physical storage devices as possible, but this cannot be guaranteed upfront. This is uavailable for DAS (Direct Attached Storage), and subject to availability for SSD.

[optional]

backupunitId

String

The ID of the backup unit that the user has access to. The property is immutable and is only allowed to be set on creation of a new a volume. It is mandatory to provide either 'public image' or 'imageAlias' in conjunction with this property.

[optional]

bootOrder

Determines whether the volume will be used as a boot volume. Set to `NONE`, the volume will not be used as boot volume. Set to `PRIMARY`, the volume will be used as boot volume and all other volumes must be set to `NONE`. Set to `AUTO` or `null` requires all volumes to be set to `AUTO` or `null`; this will use the legacy behavior, which is to use the volume as a boot volume only if there are no other volumes or cdrom devices.

[optional]

bootServer

String

The UUID of the attached server.

[optional] [readonly]

bus

The bus type for this volume; default is VIRTIO.

[optional]

cpuHotPlug

Boolean

Hot-plug capable CPU (no reboot required).

[optional]

deviceNumber

Long

The Logical Unit Number of the storage volume. Null for volumes, not mounted to a VM.

[optional] [readonly]

discVirtioHotPlug

Boolean

Hot-plug capable Virt-IO drive (no reboot required).

[optional]

discVirtioHotUnplug

Boolean

Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.

[optional]

image

String

Image or snapshot ID to be used as template for this volume.

[optional]

imageAlias

String

[optional]

imagePassword

String

Initial password to be set for installed OS. Works with public images only. Not modifiable, forbidden in update requests. Password rules allows all characters from a-z, A-Z, 0-9.

[optional]

licenceType

OS type for this volume.

[optional]

name

String

The name of the resource.

[optional]

nicHotPlug

Boolean

Hot-plug capable NIC (no reboot required).

[optional]

nicHotUnplug

Boolean

Hot-unplug capable NIC (no reboot required).

[optional]

pciSlot

Integer

The PCI slot number of the storage volume. Null for volumes, not mounted to a VM.

[optional] [readonly]

ramHotPlug

Boolean

Hot-plug capable RAM (no reboot required).

[optional]

size

The size of the volume in GB.

sshKeys

List<String>

Public SSH keys are set on the image as authorized keys for appropriate SSH login to the instance using the corresponding private key. This field may only be set in creation requests. When reading, it always returns null. SSH keys are only supported if a public Linux image is used for the volume creation.

[optional]

type

Hardware type of the volume. DAS (Direct Attached Storage) could be used only in a composite call with a Cube server.

[optional]

userData

String

The cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on creation of a new a volume. It is mandatory to provide either 'public image' or 'imageAlias' that has cloud-init compatibility in conjunction with this property.

[optional]

Enum: AvailabilityZoneEnum

NameValue

AUTO

"AUTO"

ZONE_1

"ZONE_1"

ZONE_2

"ZONE_2"

ZONE_3

"ZONE_3"

Enum: BootOrderEnum

NameValue

AUTO

"AUTO"

NONE

"NONE"

PRIMARY

"PRIMARY"

Enum: BusEnum

NameValue

VIRTIO

"VIRTIO"

IDE

"IDE"

UNKNOWN

"UNKNOWN"

Enum: LicenceTypeEnum

NameValue

UNKNOWN

"UNKNOWN"

WINDOWS

"WINDOWS"

WINDOWS2016

"WINDOWS2016"

WINDOWS2022

"WINDOWS2022"

RHEL

"RHEL"

LINUX

"LINUX"

OTHER

"OTHER"

Enum: TypeEnum

NameValue

HDD

"HDD"

SSD

"SSD"

SSD_STANDARD

"SSD Standard"

SSD_PREMIUM

"SSD Premium"

DAS

"DAS"

ISO

"ISO"

Last updated