/v2/compute/projects/{project_id}/qemu/nodes/{node_id}¶
GET /v2/compute/projects/{project_id}/qemu/nodes/{node_id}¶
Get a Qemu VM instance
Parameters¶
project_id: Project UUID
node_id: Node UUID
Response status codes¶
200: Success
400: Invalid request
404: Instance doesn’t exist
Output¶
Name | Mandatory | Type | Description |
---|---|---|---|
adapter_type | ✔ | string | QEMU adapter type |
adapters | ✔ | integer | Number of adapters |
bios_image | ✔ | string | QEMU bios image path |
bios_image_md5sum | ✔ | ['string', 'null'] | QEMU bios image checksum |
boot_priority | ✔ | enum | Possible values: c, d, n, cn, cd, dn, dc, nc, nd |
cdrom_image | ✔ | string | QEMU cdrom image path |
cdrom_image_md5sum | ✔ | ['string', 'null'] | QEMU cdrom image checksum |
command_line | ✔ | string | Last command line used by GNS3 to start QEMU |
console | ✔ | ['integer', 'null'] | Console TCP port |
console_type | ✔ | enum | Possible values: telnet, vnc, spice, spice+agent, none |
cpu_throttling | ✔ | integer | Percentage of CPU allowed for QEMU |
cpus | ✔ | ['integer', 'null'] | Number of vCPUs |
create_config_disk | ✔ | ['boolean', 'null'] | Automatically create a config disk on HDD disk interface (secondary slave) |
hda_disk_image | ✔ | string | QEMU hda disk image path |
hda_disk_image_md5sum | ✔ | ['string', 'null'] | QEMU hda disk image checksum |
hda_disk_interface | ✔ | string | QEMU hda interface |
hdb_disk_image | ✔ | string | QEMU hdb disk image path |
hdb_disk_image_md5sum | ✔ | ['string', 'null'] | QEMU hdb disk image checksum |
hdb_disk_interface | ✔ | string | QEMU hdb interface |
hdc_disk_image | ✔ | string | QEMU hdc disk image path |
hdc_disk_image_md5sum | ✔ | ['string', 'null'] | QEMU hdc disk image checksum |
hdc_disk_interface | ✔ | string | QEMU hdc interface |
hdd_disk_image | ✔ | string | QEMU hdd disk image path |
hdd_disk_image_md5sum | ✔ | ['string', 'null'] | QEMU hdd disk image checksum |
hdd_disk_interface | ✔ | string | QEMU hdd interface |
initrd | ✔ | string | QEMU initrd path |
initrd_md5sum | ✔ | ['string', 'null'] | QEMU initrd path |
kernel_command_line | ✔ | string | QEMU kernel command line |
kernel_image | ✔ | string | QEMU kernel image path |
kernel_image_md5sum | ✔ | ['string', 'null'] | QEMU kernel image checksum |
legacy_networking | ✔ | boolean | Use QEMU legagy networking commands (-net syntax) |
mac_address | ✔ | string | QEMU MAC address |
name | ✔ | string | QEMU VM instance name |
node_directory | ✔ | string | Path to the VM working directory |
node_id | ✔ | string | Node UUID |
on_close | ✔ | enum | Possible values: power_off, shutdown_signal, save_vm_state |
options | ✔ | string | Additional QEMU options |
platform | ✔ | enum | Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null |
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 |
replicate_network_connection_state | ✔ | boolean | Replicate the network connection state for links in Qemu |
save_vm_state | ['boolean', 'null'] | Save VM state support | |
status | ✔ | enum | Possible values: started, stopped, suspended |
tpm | ✔ | boolean | Enable the Trusted Platform Module (TPM) in Qemu |
uefi | ✔ | boolean | Enable the UEFI boot mode in Qemu |
usage | ✔ | string | How to use the QEMU VM |
Sample session¶
curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/c54889dc-8163-4fa4-8e7c-14eca8dd6474'
GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/c54889dc-8163-4fa4-8e7c-14eca8dd6474 HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 1381
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:26:29 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/qemu/nodes/{node_id}
{
"adapter_type": "e1000",
"adapters": 1,
"bios_image": "",
"bios_image_md5sum": null,
"boot_priority": "c",
"cdrom_image": "",
"cdrom_image_md5sum": null,
"command_line": "",
"console": 5004,
"console_type": "telnet",
"cpu_throttling": 0,
"cpus": 1,
"hda_disk_image": "",
"hda_disk_image_md5sum": null,
"hda_disk_interface": "ide",
"hdb_disk_image": "",
"hdb_disk_image_md5sum": null,
"hdb_disk_interface": "ide",
"hdc_disk_image": "",
"hdc_disk_image_md5sum": null,
"hdc_disk_interface": "ide",
"hdd_disk_image": "",
"hdd_disk_image_md5sum": null,
"hdd_disk_interface": "ide",
"initrd": "",
"initrd_md5sum": null,
"kernel_command_line": "",
"kernel_image": "",
"kernel_image_md5sum": null,
"legacy_networking": false,
"mac_address": "0c:dd:80:64:74:00",
"name": "PC TEST 1",
"node_directory": "/tmp/tmp3gc2avyo/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/c54889dc-8163-4fa4-8e7c-14eca8dd6474",
"node_id": "c54889dc-8163-4fa4-8e7c-14eca8dd6474",
"on_close": "power_off",
"options": "",
"platform": "x86_64",
"process_priority": "low",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"qemu_path": "/tmp/tmphb4tqqk2/qemu-system-x86_64",
"ram": 256,
"status": "stopped",
"usage": ""
}
PUT /v2/compute/projects/{project_id}/qemu/nodes/{node_id}¶
Update a Qemu VM instance
Parameters¶
project_id: Project UUID
node_id: Node UUID
Response status codes¶
200: Instance updated
400: Invalid request
404: Instance doesn’t exist
409: Conflict
Input¶
Name | Mandatory | Type | Description |
---|---|---|---|
adapter_type | ['string', 'null'] | QEMU adapter type | |
adapters | ['integer', 'null'] | Number of adapters | |
bios_image | string | QEMU bios image path | |
bios_image_md5sum | ['string', 'null'] | QEMU bios image checksum | |
boot_priority | enum | Possible values: c, d, n, cn, cd, dn, dc, nc, nd | |
cdrom_image | string | QEMU cdrom image path | |
cdrom_image_md5sum | ['string', 'null'] | QEMU cdrom image checksum | |
console | ['integer', 'null'] | Console TCP port | |
console_type | enum | Possible values: telnet, vnc, spice, spice+agent, none | |
cpu_throttling | ['integer', 'null'] | Percentage of CPU allowed for QEMU | |
cpus | ['integer', 'null'] | Number of vCPUs | |
create_config_disk | ['boolean', 'null'] | Automatically create a config disk on HDD disk interface (secondary slave) | |
custom_adapters | array | ||
hda_disk_image | string | QEMU hda disk image path | |
hda_disk_image_md5sum | ['string', 'null'] | QEMU hda disk image checksum | |
hda_disk_interface | string | QEMU hda interface | |
hdb_disk_image | string | QEMU hdb disk image path | |
hdb_disk_image_md5sum | ['string', 'null'] | QEMU hdb disk image checksum | |
hdb_disk_interface | string | QEMU hdb interface | |
hdc_disk_image | string | QEMU hdc disk image path | |
hdc_disk_image_md5sum | ['string', 'null'] | QEMU hdc disk image checksum | |
hdc_disk_interface | string | QEMU hdc interface | |
hdd_disk_image | string | QEMU hdd disk image path | |
hdd_disk_image_md5sum | ['string', 'null'] | QEMU hdd disk image checksum | |
hdd_disk_interface | string | QEMU hdd interface | |
initrd | string | QEMU initrd path | |
initrd_md5sum | ['string', 'null'] | QEMU initrd path | |
kernel_command_line | ['string', 'null'] | QEMU kernel command line | |
kernel_image | string | QEMU kernel image path | |
kernel_image_md5sum | ['string', 'null'] | QEMU kernel image checksum | |
legacy_networking | ['boolean', 'null'] | Use QEMU legagy networking commands (-net syntax) | |
linked_clone | boolean | Whether the VM is a linked clone or not | |
mac_address | ['string', 'null'] | QEMU MAC address | |
name | ['string', 'null'] | QEMU VM instance name | |
on_close | enum | Possible values: power_off, shutdown_signal, save_vm_state | |
options | ['string', 'null'] | Additional QEMU options | |
platform | enum | Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null, null | |
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 | |
replicate_network_connection_state | ['boolean', 'null'] | Replicate the network connection state for links in Qemu | |
tpm | ['boolean', 'null'] | Enable the Trusted Platform Module (TPM) in Qemu | |
uefi | ['boolean', 'null'] | Enable the UEFI boot mode in Qemu | |
usage | string | How to use the QEMU VM |
Output¶
Name | Mandatory | Type | Description |
---|---|---|---|
adapter_type | ✔ | string | QEMU adapter type |
adapters | ✔ | integer | Number of adapters |
bios_image | ✔ | string | QEMU bios image path |
bios_image_md5sum | ✔ | ['string', 'null'] | QEMU bios image checksum |
boot_priority | ✔ | enum | Possible values: c, d, n, cn, cd, dn, dc, nc, nd |
cdrom_image | ✔ | string | QEMU cdrom image path |
cdrom_image_md5sum | ✔ | ['string', 'null'] | QEMU cdrom image checksum |
command_line | ✔ | string | Last command line used by GNS3 to start QEMU |
console | ✔ | ['integer', 'null'] | Console TCP port |
console_type | ✔ | enum | Possible values: telnet, vnc, spice, spice+agent, none |
cpu_throttling | ✔ | integer | Percentage of CPU allowed for QEMU |
cpus | ✔ | ['integer', 'null'] | Number of vCPUs |
create_config_disk | ✔ | ['boolean', 'null'] | Automatically create a config disk on HDD disk interface (secondary slave) |
hda_disk_image | ✔ | string | QEMU hda disk image path |
hda_disk_image_md5sum | ✔ | ['string', 'null'] | QEMU hda disk image checksum |
hda_disk_interface | ✔ | string | QEMU hda interface |
hdb_disk_image | ✔ | string | QEMU hdb disk image path |
hdb_disk_image_md5sum | ✔ | ['string', 'null'] | QEMU hdb disk image checksum |
hdb_disk_interface | ✔ | string | QEMU hdb interface |
hdc_disk_image | ✔ | string | QEMU hdc disk image path |
hdc_disk_image_md5sum | ✔ | ['string', 'null'] | QEMU hdc disk image checksum |
hdc_disk_interface | ✔ | string | QEMU hdc interface |
hdd_disk_image | ✔ | string | QEMU hdd disk image path |
hdd_disk_image_md5sum | ✔ | ['string', 'null'] | QEMU hdd disk image checksum |
hdd_disk_interface | ✔ | string | QEMU hdd interface |
initrd | ✔ | string | QEMU initrd path |
initrd_md5sum | ✔ | ['string', 'null'] | QEMU initrd path |
kernel_command_line | ✔ | string | QEMU kernel command line |
kernel_image | ✔ | string | QEMU kernel image path |
kernel_image_md5sum | ✔ | ['string', 'null'] | QEMU kernel image checksum |
legacy_networking | ✔ | boolean | Use QEMU legagy networking commands (-net syntax) |
mac_address | ✔ | string | QEMU MAC address |
name | ✔ | string | QEMU VM instance name |
node_directory | ✔ | string | Path to the VM working directory |
node_id | ✔ | string | Node UUID |
on_close | ✔ | enum | Possible values: power_off, shutdown_signal, save_vm_state |
options | ✔ | string | Additional QEMU options |
platform | ✔ | enum | Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null |
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 |
replicate_network_connection_state | ✔ | boolean | Replicate the network connection state for links in Qemu |
save_vm_state | ['boolean', 'null'] | Save VM state support | |
status | ✔ | enum | Possible values: started, stopped, suspended |
tpm | ✔ | boolean | Enable the Trusted Platform Module (TPM) in Qemu |
uefi | ✔ | boolean | Enable the UEFI boot mode in Qemu |
usage | ✔ | string | How to use the QEMU VM |
Sample session¶
curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/93352cad-8f0c-42d6-a4bf-72a48c3d2bff' -d '{"console": 5006, "hdb_disk_image": "linux\u8f7d.img", "name": "test", "ram": 1024}'
PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/93352cad-8f0c-42d6-a4bf-72a48c3d2bff HTTP/1.1
{
"console": 5006,
"hdb_disk_image": "linux\u8f7d.img",
"name": "test",
"ram": 1024
}
HTTP/1.1 200
Connection: close
Content-Length: 1422
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:26:42 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/qemu/nodes/{node_id}
{
"adapter_type": "e1000",
"adapters": 1,
"bios_image": "",
"bios_image_md5sum": null,
"boot_priority": "c",
"cdrom_image": "",
"cdrom_image_md5sum": null,
"command_line": "",
"console": 5006,
"console_type": "telnet",
"cpu_throttling": 0,
"cpus": 1,
"hda_disk_image": "",
"hda_disk_image_md5sum": null,
"hda_disk_interface": "ide",
"hdb_disk_image": "linux\u8f7d.img",
"hdb_disk_image_md5sum": "c4ca4238a0b923820dcc509a6f75849b",
"hdb_disk_interface": "ide",
"hdc_disk_image": "",
"hdc_disk_image_md5sum": null,
"hdc_disk_interface": "ide",
"hdd_disk_image": "",
"hdd_disk_image_md5sum": null,
"hdd_disk_interface": "ide",
"initrd": "",
"initrd_md5sum": null,
"kernel_command_line": "",
"kernel_image": "",
"kernel_image_md5sum": null,
"legacy_networking": false,
"mac_address": "0c:dd:80:2b:ff:00",
"name": "test",
"node_directory": "/tmp/tmp3gc2avyo/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/93352cad-8f0c-42d6-a4bf-72a48c3d2bff",
"node_id": "93352cad-8f0c-42d6-a4bf-72a48c3d2bff",
"on_close": "power_off",
"options": "",
"platform": "x86_64",
"process_priority": "low",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"qemu_path": "/tmp/tmphb4tqqk2/qemu-system-x86_64",
"ram": 1024,
"status": "stopped",
"usage": ""
}
DELETE /v2/compute/projects/{project_id}/qemu/nodes/{node_id}¶
Delete a Qemu VM instance
Parameters¶
project_id: Project UUID
node_id: Node UUID
Response status codes¶
204: Instance deleted
400: Invalid request
404: Instance doesn’t exist
Sample session¶
curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/55307537-62a4-48ab-ac1c-ebd998794120'
DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/55307537-62a4-48ab-ac1c-ebd998794120 HTTP/1.1
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Wed, 08 Jan 2020 02:26:40 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/qemu/nodes/{node_id}