/v2/compute/projects/{project_id}/virtualbox/nodes

POST /v2/compute/projects/{project_id}/virtualbox/nodes

Create a new VirtualBox VM instance

Parameters

• project_id: Project UUID

Response status codes

• 201: Instance created

• 400: Invalid request

• 409: Conflict

Input

Name	Mandatory	Type	Description
adapter_type		string	VirtualBox adapter type
adapters		integer	Number of adapters
console		['integer', 'null']	Console TCP port
console_type		enum	Possible values: telnet, none
custom_adapters		array
headless		boolean	Headless mode
linked_clone		boolean	Whether the VM is a linked clone or not
name	✔	string	VirtualBox VM instance name
node_id			Node UUID
on_close		enum	Possible values: power_off, shutdown_signal, save_vm_state
ram		integer	Amount of RAM
usage		string	How to use the VirtualBox VM
use_any_adapter		boolean	Allow GNS3 to use any VirtualBox adapter
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', 'null']	Console TCP port
console_type		enum	Possible values: telnet, none
custom_adapters		array
headless		boolean	Headless mode
linked_clone		boolean	Whether the VM is a linked clone or not
name		string	VirtualBox VM instance name
node_directory		['string', 'null']	Path to the VM working directory
node_id		string	Node UUID
on_close		enum	Possible values: power_off, shutdown_signal, save_vm_state
project_id		string	Project UUID
ram		integer	Amount of RAM
status		enum	Possible values: started, stopped, suspended
usage		string	How to use the VirtualBox VM
use_any_adapter		boolean	Allow GNS3 to use any VirtualBox adapter
vmname		string	VirtualBox VM name (in VirtualBox itself)

Sample session

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

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


HTTP/1.1 201
Connection: close
Content-Length: 477
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:27:27 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/virtualbox/nodes

{
    "adapter_type": "Intel PRO/1000 MT Desktop (82540EM)",
    "adapters": 0,
    "console": 5004,
    "console_type": "telnet",
    "headless": false,
    "linked_clone": false,
    "name": "VM1",
    "node_directory": null,
    "node_id": "e7a8f831-0fb0-4946-a188-d3ac4112e097",
    "on_close": "power_off",
    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
    "ram": 0,
    "status": "stopped",
    "usage": "",
    "use_any_adapter": false,
    "vmname": "VM1"
}