mirror of
https://github.com/GNS3/gns3-server
synced 2024-11-25 01:38:08 +00:00
42 lines
2.3 KiB
ReStructuredText
42 lines
2.3 KiB
ReStructuredText
|
/v2/projects/{project_id}/vms/{vm_id}/start
|
||
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
.. contents::
|
||
|
|
|
||
|
|
POST /v2/projects/**{project_id}**/vms/**{vm_id}**/start
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
Start a VM instance
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
**********
|
||
|
|
- **vm_id**: UUID for the VM
|
||
|
|
- **project_id**: UUID for the project
|
||
|
|
|
||
|
|
Response status codes
|
||
|
|
**********************
|
||
|
|
- **400**: Invalid request
|
||
|
|
- **201**: Instance created
|
||
|
|
|
||
|
|
Output
|
||
|
|
*******
|
||
|
|
.. raw:: html
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||
|
|
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Hypervisor identifier</td> </tr>
|
||
|
|
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
|
||
|
|
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
|
||
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VM name</td> </tr>
|
||
|
|
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
|
||
|
|
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
|
||
|
|
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>VM identifier</td> </tr>
|
||
|
|
<tr><td>vm_type</td> <td>✔</td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td> </tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
Sample session
|
||
|
|
***************
|
||
|
|
|
||
|
|
|
||
|
|
.. literalinclude:: ../../../examples/controller_post_projectsprojectidvmsvmidstart.txt
|
||
|
|
|