2015-01-21 21:08:54 +00:00
|
|
|
/virtualbox
|
|
|
|
|
---------------------------------------------
|
|
|
|
|
|
|
|
|
|
.. contents::
|
|
|
|
|
|
|
|
|
|
POST /virtualbox
|
2015-01-22 09:55:11 +00:00
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2015-01-21 21:08:54 +00:00
|
|
|
Create a new VirtualBox VM instance
|
|
|
|
|
|
|
|
|
|
Response status codes
|
|
|
|
|
**********************
|
|
|
|
|
- **400**: Invalid project UUID
|
2015-01-26 08:36:26 +00:00
|
|
|
- **201**: Instance created
|
2015-01-21 21:08:54 +00:00
|
|
|
- **409**: Conflict
|
|
|
|
|
|
|
|
|
|
Input
|
|
|
|
|
*******
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
<table>
|
|
|
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
2015-01-31 21:34:49 +00:00
|
|
|
<tr><td>adapter_start_index</td> <td> </td> <td>integer</td> <td>adapter index from which to start using adapters</td> </tr>
|
|
|
|
|
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
|
|
|
|
|
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
2015-01-26 08:36:26 +00:00
|
|
|
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
2015-01-31 21:34:49 +00:00
|
|
|
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
|
|
|
|
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
2015-01-22 09:55:11 +00:00
|
|
|
<tr><td>linked_clone</td> <td>✔</td> <td>boolean</td> <td>either the VM is a linked clone or not</td> </tr>
|
2015-01-21 21:08:54 +00:00
|
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
|
2015-01-22 09:55:11 +00:00
|
|
|
<tr><td>project_uuid</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
2015-01-21 21:08:54 +00:00
|
|
|
<tr><td>uuid</td> <td> </td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
|
|
|
|
|
<tr><td>vbox_id</td> <td> </td> <td>integer</td> <td>VirtualBox VM instance ID (for project created before GNS3 1.3)</td> </tr>
|
|
|
|
|
<tr><td>vmname</td> <td>✔</td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
Output
|
|
|
|
|
*******
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
<table>
|
|
|
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
2015-01-23 15:19:17 +00:00
|
|
|
<tr><td>adapter_start_index</td> <td> </td> <td>integer</td> <td>adapter index from which to start using adapters</td> </tr>
|
|
|
|
|
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
|
|
|
|
|
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
2015-01-21 21:08:54 +00:00
|
|
|
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
2015-01-23 15:19:17 +00:00
|
|
|
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
|
|
|
|
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
2015-01-21 21:08:54 +00:00
|
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
|
2015-01-22 09:55:11 +00:00
|
|
|
<tr><td>project_uuid</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
2015-01-21 21:08:54 +00:00
|
|
|
<tr><td>uuid</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
|
2015-01-23 15:19:17 +00:00
|
|
|
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
|
2015-01-21 21:08:54 +00:00
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
Sample session
|
|
|
|
|
***************
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. literalinclude:: examples/post_virtualbox.txt
|
|
|
|
|
|
