/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**: Project UUID
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 | Whether the VM is a linked clone or not |
name | ✔ | string | VirtualBox VM instance name |
node_id | | | Node UUID |
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 |
linked_clone | | boolean | Whether the VM is a linked clone or not |
name | | string | VirtualBox VM instance name |
node_directory | | ['string', 'null'] | |
node_id | | string | Node UUID |
project_id | | string | Project UUID |
ram | | integer | Amount of RAM |
status | | enum | Possible values: started, stopped, suspended |
use_any_adapter | | boolean | Allow GNS3 to use any VirtualBox adapter |
vmname | | string | VirtualBox VM name (in VirtualBox itself) |
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvirtualboxnodes.txt