gns3-server/docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst

/v1/projects/{project_id}/virtualbox/vms

POST /v1/projects/{project_id}/virtualbox/vms

Create a new VirtualBox VM instance

Parameters

• project_id: UUID for the project

Response status codes

• 400: Invalid request
• 201: Instance created
• 409: Conflict

Input

Name	Mandatory	Type	Description
acpi_shutdown		boolean	ACPI shutdown
adapter_type		string	VirtualBox adapter type
adapters		integer	number of adapters
console		integer	console TCP port
enable_remote_console		boolean	enable the remote console
headless		boolean	headless mode
linked_clone	✔	boolean	either the VM is a linked clone or not
name	✔	string	VirtualBox VM instance name
ram		integer	Amount of RAM
use_any_adapter		boolean	allow GNS3 to use any VirtualBox adapter
vm_id			VirtualBox VM instance identifier
vmname	✔	string	VirtualBox VM name (in VirtualBox itself)

Output

Name	Mandatory	Type	Description
acpi_shutdown		boolean	ACPI shutdown
adapter_type		string	VirtualBox adapter type
adapters		integer	number of adapters
console		integer	console TCP port
enable_remote_console		boolean	enable the remote console
headless		boolean	headless mode
name	✔	string	VirtualBox VM instance name
project_id	✔	string	Project UUID
ram		integer	Amount of RAM
use_any_adapter		boolean	allow GNS3 to use any VirtualBox adapter
vm_directory	✔	['string', 'null']
vm_id	✔	string	VirtualBox VM instance UUID
vmname		string	VirtualBox VM name (in VirtualBox itself)

Sample session

../../examples/post_projectsprojectidvirtualboxvms.txt