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

57 lines
4.2 KiB
ReStructuredText
Raw Normal View History

2016-04-18 14:58:06 +00:00
/v2/computes
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/computes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Register a compute
2016-04-18 14:58:06 +00:00
Response status codes
**********************
- **201**: Compute added
2016-04-18 14:58:06 +00:00
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Server identifier</td> </tr>
2017-06-29 15:14:09 +00:00
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>name</td> <td> </td> <td>string</td> <td>Server name</td> </tr>
<tr><td>password</td> <td> </td> <td>['string', 'null']</td> <td>Password for authentication</td> </tr>
2017-06-29 15:14:09 +00:00
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>user</td> <td> </td> <td>['string', 'null']</td> <td>User for authentication</td> </tr>
2016-04-18 14:58:06 +00:00
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
2016-08-29 13:58:29 +00:00
<tr><td>capabilities</td> <td> </td> <td>object</td> <td>Get what a server support</td> </tr>
2016-04-18 14:58:06 +00:00
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute or not</td> </tr>
2016-07-11 13:37:57 +00:00
<tr><td>cpu_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>CPU usage of the compute. Read only</td> </tr>
2016-04-18 14:58:06 +00:00
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>last_error</td> <td> </td> <td>['string', 'null']</td> <td>Last error on the compute</td> </tr>
2016-07-11 13:37:57 +00:00
<tr><td>memory_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>RAM usage of the compute. Read only</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Server name</td> </tr>
2016-04-18 14:58:06 +00:00
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
2016-06-04 08:40:39 +00:00
<tr><td>user</td> <td> </td> <td>['string', 'null']</td> <td>User for authentication</td> </tr>
2016-04-18 14:58:06 +00:00
</table>
GET /v2/computes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List of computes
Response status codes
**********************
- **200**: Computes list returned