1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-04 22:28:12 +00:00
gns3-server/docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstart.rst

45 lines
2.8 KiB
ReStructuredText
Raw Normal View History

2016-03-07 16:57:12 +00:00
/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/start
------------------------------------------------------------------------------------------------------------------------------------------
2015-02-05 00:48:33 +00:00
.. contents::
2016-03-07 16:57:12 +00:00
POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016-03-04 16:50:17 +00:00
Start a VPCS instance
2015-02-05 00:48:33 +00:00
Parameters
**********
2016-03-11 14:21:21 +00:00
- **vm_id**: UUID for the instance
2016-03-11 14:28:45 +00:00
- **project_id**: UUID for the project
2015-02-05 00:48:33 +00:00
Response status codes
**********************
- **400**: Invalid request
2016-03-04 16:50:17 +00:00
- **404**: Instance doesn't exist
- **204**: Instance started
2015-02-05 00:48:33 +00:00
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-03-04 16:50:17 +00:00
<tr><td>command_line</td> <td>&#10004;</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
2015-02-05 00:48:33 +00:00
<tr><td>console</td> <td>&#10004;</td> <td>integer</td> <td>console TCP port</td> </tr>
2016-03-11 14:21:21 +00:00
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
2015-02-05 00:48:33 +00:00
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
2015-02-27 17:39:20 +00:00
<tr><td>startup_script_path</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</td> </tr>
2015-06-10 12:35:53 +00:00
<tr><td>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped</td> </tr>
2015-07-09 14:16:43 +00:00
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
2015-02-05 00:48:33 +00:00
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM UUID</td> </tr>
</table>
2015-02-24 10:38:57 +00:00
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvmsvmidstart.txt
2015-02-24 10:38:57 +00:00