Volume
Example Syntax
Parameter Reference
The following parameters are supported:
datacenter
yes
string
The datacenter in which to create the volume.
server
no
string
The server on which to attach the volume.
name
yes/no
string
The name of the volume. You can enumerate the names using auto_increment.
size
no
integer
10
The size of the volume in GB.
bus
no
string
VIRTIO
The bus type of the volume: VIRTIO, IDE
image
no
string
Image, snapshot ID or image alias to be used as template for this volume.
backupunit_id
no
string
The uuid of the Backup Unit that user has access to. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' in conjunction with this property..
user_data
no
string
The cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' that has cloud-init compatibility in conjunction with this property.
image_password
no
string
Password set for the administrative user.
ssh_keys
no
list
Public SSH keys allowing access to the server.
disk_type
no
string
HDD
The disk type of the volume: HDD, SSD, SSD Standard or SSD Premium. If SSD
is provided, it will automatically use SSD Premium
licence_type
no
string
The licence type for the volume. This is used when the image is non-standard: LINUX, WINDOWS, UNKNOWN, OTHER, WINDOWS2016
availability_zone
no
string
AUTO
The storage availability zone assigned to the volume: AUTO, ZONE_1, ZONE_2, ZONE_3
count
no
integer
1
The number of volumes to create.
auto_increment
no
boolean
true
Whether or not to increment created servers.
cpu_hot_plug
no
boolean
Is capable of CPU hot plug (no reboot required).
ram_hot_plug
no
boolean
Is capable of memory hot plug (no reboot required).
nic_hot_plug
no
boolean
Is capable of nic hot plug (no reboot required).
nic_hot_unplug
no
boolean
Is capable of nic hot unplug (no reboot required).
disc_virtio_hot_plug
no
boolean
Is capable of Virt-IO drive hot plug (no reboot required).
disc_virtio_hot_unplug
no
boolean
Is capable of Virt-IO drive hot unplug (no reboot required). This works only for non-Windows virtual Machines.
instance_ids
yes/no
list
List of instance UUIDs or names. Required for state='absent'
or state='update'
to remove or update volumes.
api_url
no
string
The Ionos API base URL.
username
no
string
The Ionos username. Overrides the IONOS_USERNAME environment variable.
password
no
string
The Ionos password. Overrides the IONOS_PASSWORD environment variable.
wait
no
boolean
true
Wait for the resource to be created before continuing.
wait_timeout
no
integer
600
The number of seconds until the wait ends.
state
no
string
present
Indicate desired state of the resource: present, absent, update
Last updated