gns3-server/docs/api/v1projectidvirtualboxvms.rst
2015-02-04 17:48:33 -07:00

4.4 KiB

/v1/{project_id}/virtualbox/vms

POST /v1/{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_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
vm_id string VirtualBox VM instance identifier
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
name string VirtualBox VM instance name
project_id string Project UUID
vm_id string VirtualBox VM instance UUID
vmname string VirtualBox VM name (in VirtualBox itself)