/v2/compute/projects/{project_id}/virtualbox/nodes
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/virtualbox/nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
*******
.. raw:: html
Name | Mandatory | Type | Description |
acpi_shutdown | | boolean | ACPI shutdown |
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 |
node_id | | | VirtualBox VM instance identifier |
ram | | integer | Amount of RAM |
use_any_adapter | | boolean | allow GNS3 to use any VirtualBox adapter |
vmname | ✔ | string | VirtualBox VM name (in VirtualBox itself) |
Output
*******
.. raw:: html
Name | Mandatory | Type | Description |
acpi_shutdown | | boolean | ACPI shutdown |
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 |
node_id | ✔ | string | VirtualBox VM instance UUID |
project_id | ✔ | string | Project UUID |
ram | | integer | Amount of RAM |
use_any_adapter | | boolean | allow GNS3 to use any VirtualBox adapter |
vm_directory | ✔ | ['string', 'null'] | |
vmname | | string | VirtualBox VM name (in VirtualBox itself) |
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvirtualboxnodes.txt