gns3-server/docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst

/v1/projects/{project_id}/qemu/vms/{vm_id}

GET /v1/projects/{project_id}/qemu/vms/{vm_id}

Get a Qemu VM 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

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
console_type	✔	enum	Possible values: telnet, vnc
cpu_throttling	✔	integer	Percentage of CPU allowed for QEMU
hda_disk_image	✔	string	QEMU hda disk image path
hda_disk_image_md5sum	✔	['string', 'null']	QEMU hda disk image checksum
hdb_disk_image	✔	string	QEMU hdb disk image path
hdb_disk_image_md5sum	✔	['string', 'null']	QEMU hdb disk image checksum
hdc_disk_image	✔	string	QEMU hdc disk image path
hdc_disk_image_md5sum	✔	['string', 'null']	QEMU hdc disk image checksum
hdd_disk_image	✔	string	QEMU hdd disk image path
hdd_disk_image_md5sum	✔	['string', 'null']	QEMU hdd disk image checksum
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
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
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_directory	✔	string
vm_id	✔	string	QEMU VM uuid

Sample session

../../examples/get_projectsprojectidqemuvmsvmid.txt

PUT /v1/projects/{project_id}/qemu/vms/{vm_id}

Update a Qemu VM 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

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
console_type		enum	Possible values: telnet, vnc
cpu_throttling		['integer', 'null']	Percentage of CPU allowed for QEMU
hda_disk_image		string	QEMU hda disk image path
hda_disk_image_md5sum		['string', 'null']	QEMU hda disk image checksum
hdb_disk_image		string	QEMU hdb disk image path
hdb_disk_image_md5sum		['string', 'null']	QEMU hdb disk image checksum
hdc_disk_image		string	QEMU hdc disk image path
hdc_disk_image_md5sum		['string', 'null']	QEMU hdc disk image checksum
hdd_disk_image		string	QEMU hdd disk image path
hdd_disk_image_md5sum		['string', 'null']	QEMU hdd disk image checksum
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)
mac_address		['string', 'null']	QEMU MAC address
name		['string', 'null']	QEMU VM instance name
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
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

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
console_type	✔	enum	Possible values: telnet, vnc
cpu_throttling	✔	integer	Percentage of CPU allowed for QEMU
hda_disk_image	✔	string	QEMU hda disk image path
hda_disk_image_md5sum	✔	['string', 'null']	QEMU hda disk image checksum
hdb_disk_image	✔	string	QEMU hdb disk image path
hdb_disk_image_md5sum	✔	['string', 'null']	QEMU hdb disk image checksum
hdc_disk_image	✔	string	QEMU hdc disk image path
hdc_disk_image_md5sum	✔	['string', 'null']	QEMU hdc disk image checksum
hdd_disk_image	✔	string	QEMU hdd disk image path
hdd_disk_image_md5sum	✔	['string', 'null']	QEMU hdd disk image checksum
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
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
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_directory	✔	string
vm_id	✔	string	QEMU VM uuid

Sample session

../../examples/put_projectsprojectidqemuvmsvmid.txt

DELETE /v1/projects/{project_id}/qemu/vms/{vm_id}

Delete a Qemu VM 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

../../examples/delete_projectsprojectidqemuvmsvmid.txt