gns3-server/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst

/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

../../../examples/compute_get_projectsprojectidqemunodesnodeid.txt

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

../../../examples/compute_put_projectsprojectidqemunodesnodeid.txt

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

../../../examples/compute_delete_projectsprojectidqemunodesnodeid.txt