/v1/projects/{project_id}/qemu/vms/{vm_id}
----------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a Qemu VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
- **200**: Success
- **400**: Invalid request
- **404**: Instance doesn't exist
Output
*******
.. raw:: html
Name | Mandatory | Type | Description |
acpi_shutdown | ✔ | boolean | ACPI shutdown support |
adapter_type | ✔ | string | QEMU adapter type |
adapters | ✔ | integer | number of adapters |
console | ✔ | integer | console TCP port |
cpu_throttling | ✔ | integer | Percentage of CPU allowed for QEMU |
hda_disk_image | ✔ | string | QEMU hda disk image path |
hdb_disk_image | ✔ | string | QEMU hdb disk image path |
hdc_disk_image | ✔ | string | QEMU hdc disk image path |
hdd_disk_image | ✔ | string | QEMU hdd disk image path |
initrd | ✔ | string | QEMU initrd path |
kernel_command_line | ✔ | string | QEMU kernel command line |
kernel_image | ✔ | string | QEMU kernel image path |
kvm | ✔ | ['boolean', 'null'] | KVM support |
legacy_networking | ✔ | boolean | Use QEMU legagy networking commands (-net syntax) |
mac_address | ✔ | string | QEMU MAC address |
name | ✔ | string | QEMU VM instance name |
options | ✔ | string | Additional QEMU options |
process_priority | ✔ | enum | Possible values: realtime, very high, high, normal, low, very low |
project_id | ✔ | string | Project uuid |
qemu_path | ✔ | string | path to QEMU |
ram | ✔ | integer | amount of RAM in MB |
vm_id | ✔ | string | QEMU VM uuid |
Sample session
***************
.. literalinclude:: ../../examples/get_projectsprojectidqemuvmsvmid.txt
PUT /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a Qemu VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
- **200**: Instance updated
- **400**: Invalid request
- **404**: Instance doesn't exist
- **409**: Conflict
Input
*******
.. raw:: html
Name | Mandatory | Type | Description |
acpi_shutdown | | ['boolean', 'null'] | ACPI shutdown support |
adapter_type | | ['string', 'null'] | QEMU adapter type |
adapters | | ['integer', 'null'] | number of adapters |
console | | ['integer', 'null'] | console TCP port |
cpu_throttling | | ['integer', 'null'] | Percentage of CPU allowed for QEMU |
hda_disk_image | | ['string', 'null'] | QEMU hda disk image path |
hdb_disk_image | | ['string', 'null'] | QEMU hdb disk image path |
hdc_disk_image | | ['string', 'null'] | QEMU hdc disk image path |
hdd_disk_image | | ['string', 'null'] | QEMU hdd disk image path |
initrd | | ['string', 'null'] | QEMU initrd path |
kernel_command_line | | ['string', 'null'] | QEMU kernel command line |
kernel_image | | ['string', 'null'] | QEMU kernel image path |
kvm | | ['boolean', 'null'] | KVM support |
legacy_networking | | ['boolean', 'null'] | Use QEMU legagy networking commands (-net syntax) |
mac_address | | ['string', 'null'] | QEMU MAC address |
name | | ['string', 'null'] | QEMU VM instance name |
options | | ['string', 'null'] | Additional QEMU options |
process_priority | | enum | Possible values: realtime, very high, high, normal, low, very low, null |
qemu_path | | ['string', 'null'] | Path to QEMU |
ram | | ['integer', 'null'] | amount of RAM in MB |
Output
*******
.. raw:: html
Name | Mandatory | Type | Description |
acpi_shutdown | ✔ | boolean | ACPI shutdown support |
adapter_type | ✔ | string | QEMU adapter type |
adapters | ✔ | integer | number of adapters |
console | ✔ | integer | console TCP port |
cpu_throttling | ✔ | integer | Percentage of CPU allowed for QEMU |
hda_disk_image | ✔ | string | QEMU hda disk image path |
hdb_disk_image | ✔ | string | QEMU hdb disk image path |
hdc_disk_image | ✔ | string | QEMU hdc disk image path |
hdd_disk_image | ✔ | string | QEMU hdd disk image path |
initrd | ✔ | string | QEMU initrd path |
kernel_command_line | ✔ | string | QEMU kernel command line |
kernel_image | ✔ | string | QEMU kernel image path |
kvm | ✔ | ['boolean', 'null'] | KVM support |
legacy_networking | ✔ | boolean | Use QEMU legagy networking commands (-net syntax) |
mac_address | ✔ | string | QEMU MAC address |
name | ✔ | string | QEMU VM instance name |
options | ✔ | string | Additional QEMU options |
process_priority | ✔ | enum | Possible values: realtime, very high, high, normal, low, very low |
project_id | ✔ | string | Project uuid |
qemu_path | ✔ | string | path to QEMU |
ram | ✔ | integer | amount of RAM in MB |
vm_id | ✔ | string | QEMU VM uuid |
Sample session
***************
.. literalinclude:: ../../examples/put_projectsprojectidqemuvmsvmid.txt
DELETE /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a Qemu VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
.. literalinclude:: ../../examples/delete_projectsprojectidqemuvmsvmid.txt