mirror of
https://github.com/GNS3/gns3-server
synced 2024-11-25 09:48:09 +00:00
61 lines
4.6 KiB
ReStructuredText
61 lines
4.6 KiB
ReStructuredText
|
/v2/compute/projects/{project_id}/iou/nodes/{node_id}/start
|
||
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
||
|
|
|
||
|
|
.. contents::
|
||
|
|
|
||
|
|
POST /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/start
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
Start a IOU instance
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
**********
|
||
|
|
- **node_id**: UUID for the instance
|
||
|
|
- **project_id**: UUID for the project
|
||
|
|
|
||
|
|
Response status codes
|
||
|
|
**********************
|
||
|
|
- **200**: Instance started
|
||
|
|
- **400**: Invalid request
|
||
|
|
- **404**: Instance doesn't exist
|
||
|
|
|
||
|
|
Input
|
||
|
|
*******
|
||
|
|
.. raw:: html
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||
|
|
<tr><td>iourc_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the iourc file. Ignored if Null</td> </tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
Output
|
||
|
|
*******
|
||
|
|
.. raw:: html
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||
|
|
<tr><td>command_line</td> <td>✔</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||
|
|
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||
|
|
<tr><td>ethernet_adapters</td> <td>✔</td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
|
||
|
|
<tr><td>iourc_path</td> <td> </td> <td>['string', 'null']</td> <td>Path of the iourc file used by remote servers</td> </tr>
|
||
|
|
<tr><td>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
|
||
|
|
<tr><td>md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
|
||
|
|
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
|
||
|
|
<tr><td>node_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
|
||
|
|
<tr><td>nvram</td> <td>✔</td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
|
||
|
|
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
|
||
|
|
<tr><td>private_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the private-config content relative to project directory</td> </tr>
|
||
|
|
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||
|
|
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
|
||
|
|
<tr><td>serial_adapters</td> <td>✔</td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||
|
|
<tr><td>startup_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the startup-config content relative to project directory</td> </tr>
|
||
|
|
<tr><td>use_default_iou_values</td> <td>✔</td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
|
||
|
|
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
Sample session
|
||
|
|
***************
|
||
|
|
|
||
|
|
|
||
|
|
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiounodesnodeidstart.txt
|
||
|
|
|