mirror of
https://github.com/GNS3/gns3-server.git
synced 2024-11-18 01:34:50 +02:00
48 lines
2.6 KiB
ReStructuredText
48 lines
2.6 KiB
ReStructuredText
|
/virtualbox
|
||
|
|
---------------------------------------------
|
||
|
|
|
||
|
|
.. contents::
|
||
|
|
|
||
|
|
POST /virtualbox
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
Create a new VirtualBox VM instance
|
||
|
|
|
||
|
|
Response status codes
|
||
|
|
**********************
|
||
|
|
- **400**: Invalid project UUID
|
||
|
|
- **201**: VirtualBox VM instance created
|
||
|
|
- **409**: Conflict
|
||
|
|
|
||
|
|
Input
|
||
|
|
*******
|
||
|
|
.. raw:: html
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||
|
|
<tr><td>linked_clone</td> <td> </td> <td>boolean</td> <td>either the VM is a linked clone or not</td> </tr>
|
||
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
|
||
|
|
<tr><td>project_uuid</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||
|
|
<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>
|
||
|
|
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
|
||
|
|
<tr><td>project_uuid</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||
|
|
<tr><td>uuid</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
Sample session
|
||
|
|
***************
|
||
|
|
|
||
|
|
|
||
|
|
.. literalinclude:: examples/post_virtualbox.txt
|
||
|
|
|