# Image ## image This is a simple module that supports updating or removing Images. This module has a dependency on ionoscloud >= 6.0.2 ### Example Syntax ```yaml name: Update image ionoscloudsdk.ionoscloud.image: image_id: 87fe5b95-05e4-11ee-a7cb-028794406dc9 name: debian-11.7.0-amd64-netinst-renamed.iso description: An image used for testing the Ansible Module cpu_hot_plug: true cpu_hot_unplug: false ram_hot_plug: true ram_hot_unplug: true nic_hot_plug: true nic_hot_unplug: true disc_virtio_hot_plug: true disc_virtio_hot_unplug: true disc_scsi_hot_plug: true disc_scsi_hot_unplug: false licence_type: LINUX cloud_init: V1 state: update register: image_output name: Delete image ionoscloudsdk.ionoscloud.image: image_id: 916b10ea-be31-11eb-b909-c608708a73fa state: absent ``` ### Returned object ```json { "changed": true, "failed": false, "action": "update", "image": { "href": "https://api.ionos.com/cloudapi/v6/images/87fe5b95-05e4-11ee-a7cb-028794406dc9", "id": "87fe5b95-05e4-11ee-a7cb-028794406dc9", "metadata": { "created_by": "", "created_by_user_id": "", "created_date": "2023-06-08T10:09:18+00:00", "etag": "1a305d1a2beaabd6027d5ad4fe5940a8", "last_modified_by": "", "last_modified_by_user_id": "", "last_modified_date": "2023-06-08T10:15:32+00:00", "state": "BUSY" }, "properties": { "cloud_init": "V1", "cpu_hot_plug": true, "cpu_hot_unplug": false, "description": "An image used for testing the Ansible Module", "disc_scsi_hot_plug": true, "disc_scsi_hot_unplug": false, "disc_virtio_hot_plug": true, "disc_virtio_hot_unplug": true, "image_aliases": [], "image_type": "CDROM", "licence_type": "LINUX", "location": "de/fra", "name": "debian-11.7.0-amd64-netinst-renamed.iso", "nic_hot_plug": true, "nic_hot_unplug": true, "public": false, "ram_hot_plug": true, "ram_hot_unplug": true, "size": 0.39 }, "type": "image" } } ``` #### For more examples please check out the tests [here](https://github.com/ionos-cloud/module-ansible/tree/master/tests/compute-engine). ## state: **absent** ```yaml name: Delete image ionoscloudsdk.ionoscloud.image: image_id: 916b10ea-be31-11eb-b909-c608708a73fa state: absent ``` #### Available parameters for state **absent**:

Name	Required	Description
image_id str	True	The ID of the image.
name str	False	The resource name.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['absent', 'update']

## state: **update** ```yaml name: Update image ionoscloudsdk.ionoscloud.image: image_id: 87fe5b95-05e4-11ee-a7cb-028794406dc9 name: debian-11.7.0-amd64-netinst-renamed.iso description: An image used for testing the Ansible Module cpu_hot_plug: true cpu_hot_unplug: false ram_hot_plug: true ram_hot_unplug: true nic_hot_plug: true nic_hot_unplug: true disc_virtio_hot_plug: true disc_virtio_hot_unplug: true disc_scsi_hot_plug: true disc_scsi_hot_unplug: false licence_type: LINUX cloud_init: V1 state: update register: image_output ``` #### Available parameters for state **update**:

Name	Required	Description
image_id str	True	The ID of the image.
name str	False	The resource name.
description str	False	Human-readable description.
cpu_hot_plug bool	False	Hot-plug capable CPU (no reboot required).
cpu_hot_unplug bool	False	Hot-unplug capable CPU (no reboot required).
ram_hot_plug bool	False	Hot-plug capable RAM (no reboot required).
ram_hot_unplug bool	False	Hot-unplug capable RAM (no reboot required).
nic_hot_plug bool	False	Hot-plug capable NIC (no reboot required).
nic_hot_unplug bool	False	Hot-unplug capable NIC (no reboot required).
disc_scsi_hot_plug bool	False	Hot-plug capable SCSI drive (no reboot required).
disc_scsi_hot_unplug bool	False	Hot-unplug capable SCSI drive (no reboot required). Not supported with Windows VMs.
disc_virtio_hot_plug bool	False	Hot-plug capable Virt-IO drive (no reboot required).
disc_virtio_hot_unplug bool	False	Hot-unplug capable Virt-IO drive (no reboot required). Not supported with Windows VMs.
licence_type str	True	The OS type of this image.
cloud_init str	False	Cloud init compatibility.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['absent', 'update']

--- # 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/ansible/api/compute-engine/modules/image.md?ask= ``` 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.