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