/v1/projects/{project_id}/virtualbox/vms¶
Contents
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 |
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 |
---|---|---|---|
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_id | ✔ | string | VirtualBox VM instance UUID |
vmname | string | VirtualBox VM name (in VirtualBox itself) |
Sample session¶
curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms' -d '{"linked_clone": false, "name": "VM1", "vmname": "VM1"}'
POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms HTTP/1.1
{
"linked_clone": false,
"name": "VM1",
"vmname": "VM1"
}
HTTP/1.1 201
CONNECTION: keep-alive
CONTENT-LENGTH: 355
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.4 GNS3/1.3.1.rc2
X-ROUTE: /v1/projects/{project_id}/virtualbox/vms
{
"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",
"ram": 0,
"use_any_adapter": false,
"vm_id": "fd208626-81e5-449e-b145-fd6993f5097c",
"vmname": "VM1"
}