ExternalVendorCode/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2024-12-24 23:16:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
4ffb2c8c20
gns3-server/docs/api/virtualbox/v1projectsprojectidvirtualboxvms.rst
Julien Duponchelle 57348d0508 Better organisation of the API documentation
2015-02-17 10:37:09 +01:00

4.5 KiB
Raw Blame History

/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
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
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
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
use_any_adapter boolean allow GNS3 to use any VirtualBox adapter
vm_id ✔ string VirtualBox VM instance UUID
vmname string VirtualBox VM name (in VirtualBox itself)