/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
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_id 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
name string VirtualBox VM instance name
project_id string Project UUID
uuid string VirtualBox VM instance UUID
vmname string VirtualBox VM name (in VirtualBox itself)

Sample session

curl -i -X POST 'http://localhost:8000/virtualbox' -d '{"linked_clone": false, "name": "VM1", "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80", "vmname": "VM1"}'

POST /virtualbox HTTP/1.1
{
    "linked_clone": false,
    "name": "VM1",
    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
    "vmname": "VM1"
}


HTTP/1.1 201
CONNECTION: close
CONTENT-LENGTH: 340
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.4 aiohttp/0.13.1
X-ROUTE: /virtualbox

{
    "adapter_start_index": 0,
    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
    "adapters": 0,
    "console": 2000,
    "enable_remote_console": false,
    "headless": false,
    "name": "VM1",
    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
    "uuid": "210fbbba-4025-4286-81dc-1f07cc494cc9",
    "vmname": "VM1"
}

Table Of Contents

Previous topic

/version

Next topic

/virtualbox/list