# Volume ## volume Allows you to create, update or remove a volume from a Ionos datacenter. ### Example Syntax ```yaml name: Create volumes ionoscloudsdk.ionoscloud.volume: datacenter: 'AnsibleAutoTestCompute' name: 'AnsibleAutoTestCompute %02d' disk_type: SSD Premium image: 'ubuntu:latest' image_password: '{{ lookup('ansible.builtin.password', '/dev/null chars=ascii_letters,digits') }}' count: 2 size: 20 availability_zone: AUTO cpu_hot_plug: false ram_hot_plug: true nic_hot_plug: true nic_hot_unplug: true disc_virtio_hot_plug: true disc_virtio_hot_unplug: true wait_timeout: 600 wait: true state: present register: volume_create_response name: Update no change ionoscloudsdk.ionoscloud.volume: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute 01' disk_type: SSD Premium size: 20 availability_zone: AUTO image: 'c638b244-eeaa-11ef-8fa7-aee9942a25aa' licence_type: LINUX ram_hot_plug: true nic_hot_plug: true nic_hot_unplug: true disc_virtio_hot_plug: true disc_virtio_hot_unplug: true allow_replace: false wait_timeout: 600 wait: true state: update register: volume_create_response_nochange name: Delete volumes ionoscloudsdk.ionoscloud.volume: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute modified' - 'AnsibleAutoTestCompute 02' wait_timeout: 600 state: absent ``` ### Returned object ```json { "changed": true, "failed": false, "volumes": [ { "href": "https://api.ionos.com/cloudapi/v6/datacenters/ea545f2e-4c15-4be7-8fb8-867fb6e9d330/volumes/9be90788-1b11-4d1b-bfb3-857f0c7bd5a3", "id": "9be90788-1b11-4d1b-bfb3-857f0c7bd5a3", "metadata": { "created_by": "", "created_by_user_id": "", "created_date": "2023-05-29T09:43:18+00:00", "etag": "1e8b91b7c574e42452b1628408959166", "last_modified_by": "", "last_modified_by_user_id": "", "last_modified_date": "2023-05-29T09:43:18+00:00", "state": "BUSY" }, "properties": { "availability_zone": null, "backupunit_id": null, "boot_order": "AUTO", "boot_server": null, "bus": "VIRTIO", "cpu_hot_plug": false, "device_number": null, "disc_virtio_hot_plug": false, "disc_virtio_hot_unplug": false, "image": null, "image_alias": null, "image_password": null, "licence_type": "OTHER", "name": "AnsibleAutoTestCompute-data", "nic_hot_plug": false, "nic_hot_unplug": false, "pci_slot": null, "ram_hot_plug": false, "size": 20.0, "ssh_keys": [], "type": "HDD", "user_data": null }, "type": "volume" } ], "action": "create", "instance_ids": [ "9be90788-1b11-4d1b-bfb3-857f0c7bd5a3" ] } ``` #### For more examples please check out the tests [here](https://github.com/ionos-cloud/module-ansible/tree/master/tests/compute-engine). ***NOTE:*** **If you are using a versions 7.0.0 and up**: modules can replace resources if certain set parameters differ from the results found in the API! ### Parameters that can trigger a resource replacement: * size * disk\_type * availability\_zone * licence\_type * user\_data (Might trigger replace just by being set as this parameter is retrieved from the API as the image ID, so when using an alias it will always cause a resource replacement!) * image (Might trigger replace just by being set as this parameter is retrieved from the API as the image ID, so when using an alias it will always cause a resource replacement!) * image\_password (Will trigger replace just by being set as this parameter cannot be retrieved from the api to check for changes!) * ssh\_keys (Will trigger replace just by being set as this parameter cannot be retrieved from the api to check for changes!) * backupunit (Will trigger replace just by being set as this parameter cannot be retrieved from the api to check for changes!) ## state: **present** ```yaml name: Create volumes ionoscloudsdk.ionoscloud.volume: datacenter: 'AnsibleAutoTestCompute' name: 'AnsibleAutoTestCompute %02d' disk_type: SSD Premium image: 'ubuntu:latest' image_password: '{{ lookup('ansible.builtin.password', '/dev/null chars=ascii_letters,digits') }}' count: 2 size: 20 availability_zone: AUTO cpu_hot_plug: false ram_hot_plug: true nic_hot_plug: true nic_hot_unplug: true disc_virtio_hot_plug: true disc_virtio_hot_unplug: true wait_timeout: 600 wait: true state: present register: volume_create_response ``` #### Available parameters for state **present**:
NameRequiredDescription
datacenter
str		TrueThe datacenter in which to create the volumes.
server
str		FalseThe server to which to attach the volume.
name
str		TrueThe name of the resource.
size
int		FalseThe size of the volume in GB.
bus
str		FalseThe bus type for this volume; default is VIRTIO.
Default: VIRTIO
Options: ['VIRTIO', 'IDE', 'UNKNOWN']
image
str		FalseImage or snapshot ID to be used as template for this volume. MSSQL Enterprise Images can be used only if the feature toggle for MSSQL Enterprise is enabled on the contract.
image_password
str		FalseInitial 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.
ssh_keys
list		FalsePublic 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.
disk_type
str		FalseThe disk type of the volume.
Options: ['HDD', 'SSD', 'SSD Premium', 'SSD Standard', 'DAS', 'ISO']
licence_type
str		FalseOS type for this volume.
Options: ['UNKNOWN', 'WINDOWS', 'WINDOWS2016', 'WINDOWS2019', 'WINDOWS2022', 'WINDOWS2025', 'RHEL', 'LINUX', 'OTHER']
availability_zone
str		FalseThe 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.
Options: ['AUTO', 'ZONE_1', 'ZONE_2', 'ZONE_3']
count
int		FalseThe number of volumes you wish to create.
Default: 1
backupunit
str		FalseThe 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.
user_data
str		FalseThe 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.
cpu_hot_plug
bool		FalseHot-plug capable CPU (no reboot required).
ram_hot_plug
bool		FalseHot-plug capable RAM (no reboot required).
nic_hot_plug
bool		FalseHot-plug capable NIC (no reboot required).
nic_hot_unplug
bool		FalseHot-unplug capable NIC (no reboot required).
disc_virtio_hot_plug
bool		FalseHot-plug capable Virt-IO drive (no reboot required).
disc_virtio_hot_unplug
bool		FalseHot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.
allow_replace
bool		FalseBoolean indicating if the resource should be recreated when the state cannot be reached in another way. This may be used to prevent resources from being deleted from specifying a different value to an immutable property. An error will be thrown instead
Default: False
api_url
str		FalseThe Ionos API base URL.
certificate_fingerprint
str		FalseThe Ionos API certificate fingerprint.
username
str		FalseThe Ionos username. Overrides the IONOS_USERNAME environment variable.
password
str		FalseThe Ionos password. Overrides the IONOS_PASSWORD environment variable.
token
str		FalseThe Ionos token. Overrides the IONOS_TOKEN environment variable.
wait
bool		FalseWait for the resource to be created before returning.
Default: True
Options: [True, False]
wait_timeout
int		FalseHow long before wait gives up, in seconds.
Default: 600
state
str		FalseIndicate desired state of the resource.
Default: present
Options: ['present', 'absent', 'update']
## state: **absent** ```yaml name: Delete volumes ionoscloudsdk.ionoscloud.volume: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute modified' - 'AnsibleAutoTestCompute 02' wait_timeout: 600 state: absent ``` #### Available parameters for state **absent**:
NameRequiredDescription
datacenter
str		TrueThe datacenter in which to create the volumes.
name
str		FalseThe name of the resource.
instance_ids
list		Falselist of instance ids or names. Should only contain one ID if renaming in update state
Default:
api_url
str		FalseThe Ionos API base URL.
certificate_fingerprint
str		FalseThe Ionos API certificate fingerprint.
username
str		FalseThe Ionos username. Overrides the IONOS_USERNAME environment variable.
password
str		FalseThe Ionos password. Overrides the IONOS_PASSWORD environment variable.
token
str		FalseThe Ionos token. Overrides the IONOS_TOKEN environment variable.
wait
bool		FalseWait for the resource to be created before returning.
Default: True
Options: [True, False]
wait_timeout
int		FalseHow long before wait gives up, in seconds.
Default: 600
state
str		FalseIndicate desired state of the resource.
Default: present
Options: ['present', 'absent', 'update']
## state: **update** ```yaml name: Update no change ionoscloudsdk.ionoscloud.volume: datacenter: 'AnsibleAutoTestCompute' instance_ids: - 'AnsibleAutoTestCompute 01' disk_type: SSD Premium size: 20 availability_zone: AUTO image: 'c638b244-eeaa-11ef-8fa7-aee9942a25aa' licence_type: LINUX ram_hot_plug: true nic_hot_plug: true nic_hot_unplug: true disc_virtio_hot_plug: true disc_virtio_hot_unplug: true allow_replace: false wait_timeout: 600 wait: true state: update register: volume_create_response_nochange ``` #### Available parameters for state **update**:
NameRequiredDescription
datacenter
str		TrueThe datacenter in which to create the volumes.
name
str		FalseThe name of the resource.
size
int		FalseThe size of the volume in GB.
bus
str		FalseThe bus type for this volume; default is VIRTIO.
Default: VIRTIO
Options: ['VIRTIO', 'IDE', 'UNKNOWN']
availability_zone
str		FalseThe 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.
Options: ['AUTO', 'ZONE_1', 'ZONE_2', 'ZONE_3']
instance_ids
list		Falselist of instance ids or names. Should only contain one ID if renaming in update state
Default:
cpu_hot_plug
bool		FalseHot-plug capable CPU (no reboot required).
ram_hot_plug
bool		FalseHot-plug capable RAM (no reboot required).
nic_hot_plug
bool		FalseHot-plug capable NIC (no reboot required).
nic_hot_unplug
bool		FalseHot-unplug capable NIC (no reboot required).
disc_virtio_hot_plug
bool		FalseHot-plug capable Virt-IO drive (no reboot required).
disc_virtio_hot_unplug
bool		FalseHot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.
allow_replace
bool		FalseBoolean indicating if the resource should be recreated when the state cannot be reached in another way. This may be used to prevent resources from being deleted from specifying a different value to an immutable property. An error will be thrown instead
Default: False
api_url
str		FalseThe Ionos API base URL.
certificate_fingerprint
str		FalseThe Ionos API certificate fingerprint.
username
str		FalseThe Ionos username. Overrides the IONOS_USERNAME environment variable.
password
str		FalseThe Ionos password. Overrides the IONOS_PASSWORD environment variable.
token
str		FalseThe Ionos token. Overrides the IONOS_TOKEN environment variable.
wait
bool		FalseWait for the resource to be created before returning.
Default: True
Options: [True, False]
wait_timeout
int		FalseHow long before wait gives up, in seconds.
Default: 600
state
str		FalseIndicate desired state of the resource.
Default: present
Options: ['present', 'absent', 'update']