gns3-server/docs/api/virtualbox.rst

/virtualbox

POST /virtualbox

Create a new VirtualBox VM instance

Response status codes

• 400: Invalid project UUID
• 201: Instance created
• 409: Conflict

Input

Name	Mandatory	Type	Description
console		integer	console TCP port
linked_clone	✔	boolean	either the VM is a linked clone or not
name	✔	string	VirtualBox VM instance name
project_uuid	✔	string	Project UUID
uuid		string	VirtualBox VM instance UUID
vbox_id		integer	VirtualBox VM instance ID (for project created before GNS3 1.3)
vmname	✔	string	VirtualBox VM name (in VirtualBox itself)

Output

Name	Mandatory	Type	Description
adapter_start_index		integer	adapter index from which to start using adapters
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
project_uuid	✔	string	Project UUID
uuid	✔	string	VirtualBox VM instance UUID
vmname		string	VirtualBox VM name (in VirtualBox itself)

Sample session

examples/post_virtualbox.txt