# VolumeProperties

## Properties

| Name                          | Type           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Notes                            |
| ----------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| **availability\_zone**        | **str**        | 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]                      |
| **backupunit\_id**            | **str**        | 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]                      |
| **boot\_order**               | **str**        | 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] \[default to 'AUTO'] |
| **boot\_server**              | **str**        | The UUID of the attached server.                                                                                                                                                                                                                                                                                                                                                                                                                            | \[optional] \[readonly]          |
| **bus**                       | **str**        | The bus type for this volume; default is VIRTIO.                                                                                                                                                                                                                                                                                                                                                                                                            | \[optional]                      |
| **cpu\_hot\_plug**            | **bool**       | Hot-plug capable CPU (no reboot required).                                                                                                                                                                                                                                                                                                                                                                                                                  | \[optional]                      |
| **device\_number**            | **int**        | The Logical Unit Number of the storage volume. Null for volumes, not mounted to a VM.                                                                                                                                                                                                                                                                                                                                                                       | \[optional] \[readonly]          |
| **disc\_virtio\_hot\_plug**   | **bool**       | Hot-plug capable Virt-IO drive (no reboot required).                                                                                                                                                                                                                                                                                                                                                                                                        | \[optional]                      |
| **disc\_virtio\_hot\_unplug** | **bool**       | Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.                                                                                                                                                                                                                                                                                                                                                                      | \[optional]                      |
| **image**                     | **str**        | Image or snapshot ID to be used as template for this volume.                                                                                                                                                                                                                                                                                                                                                                                                | \[optional]                      |
| **image\_alias**              | **str**        |                                                                                                                                                                                                                                                                                                                                                                                                                                                             | \[optional]                      |
| **image\_password**           | **str**        | 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]                      |
| **licence\_type**             | **str**        | OS type for this volume.                                                                                                                                                                                                                                                                                                                                                                                                                                    | \[optional]                      |
| **name**                      | **str**        | The name of the resource.                                                                                                                                                                                                                                                                                                                                                                                                                                   | \[optional]                      |
| **nic\_hot\_plug**            | **bool**       | Hot-plug capable NIC (no reboot required).                                                                                                                                                                                                                                                                                                                                                                                                                  | \[optional]                      |
| **nic\_hot\_unplug**          | **bool**       | Hot-unplug capable NIC (no reboot required).                                                                                                                                                                                                                                                                                                                                                                                                                | \[optional]                      |
| **pci\_slot**                 | **int**        | The PCI slot number of the storage volume. Null for volumes, not mounted to a VM.                                                                                                                                                                                                                                                                                                                                                                           | \[optional] \[readonly]          |
| **ram\_hot\_plug**            | **bool**       | Hot-plug capable RAM (no reboot required).                                                                                                                                                                                                                                                                                                                                                                                                                  | \[optional]                      |
| **size**                      | **float**      | The size of the volume in GB.                                                                                                                                                                                                                                                                                                                                                                                                                               |                                  |
| **ssh\_keys**                 | **list\[str]** | 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**                      | **str**        | Hardware type of the volume. DAS (Direct Attached Storage) could be used only in a composite call with a Cube server.                                                                                                                                                                                                                                                                                                                                       | \[optional]                      |
| **user\_data**                | **str**        | 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]                      |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ionos.com/python-sdk/models/volumeproperties.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
