2016-04-18 14:58:06 +00:00
|
|
|
/v2/computes
|
|
|
|
|
------------------------------------------------------------------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
.. contents::
|
|
|
|
|
|
|
|
|
|
POST /v2/computes
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-06-04 08:40:39 +00:00
|
|
|
Register a compute server
|
2016-04-18 14:58:06 +00:00
|
|
|
|
|
|
|
|
Response status codes
|
|
|
|
|
**********************
|
2016-06-04 08:40:39 +00:00
|
|
|
- **201**: Compute server 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>
|
|
|
|
|
<tr><td>host</td> <td> </td> <td>string</td> <td>Server host</td> </tr>
|
|
|
|
|
<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>
|
|
|
|
|
<tr><td>port</td> <td> </td> <td>integer</td> <td>Server port</td> </tr>
|
|
|
|
|
<tr><td>protocol</td> <td> </td> <td>enum</td> <td>Possible values: http, https</td> </tr>
|
|
|
|
|
<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>
|
|
|
|
|
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Server identifier</td> </tr>
|
2016-07-11 13:37:57 +00:00
|
|
|
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
|
|
|
|
|
<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>✔</td> <td>string</td> <td>Server host</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>✔</td> <td>string</td> <td>Server name</td> </tr>
|
2016-04-18 14:58:06 +00:00
|
|
|
<tr><td>port</td> <td>✔</td> <td>integer</td> <td>Server port</td> </tr>
|
|
|
|
|
<tr><td>protocol</td> <td>✔</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>
|
|
|
|
|
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote compute server</td> </tr>
|
2016-04-18 14:58:06 +00:00
|
|
|
</table>
|
|
|
|
|
|
2016-05-11 17:35:36 +00:00
|
|
|
|
|
|
|
|
GET /v2/computes
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2016-06-04 08:40:39 +00:00
|
|
|
List of compute servers
|
2016-05-11 17:35:36 +00:00
|
|
|
|
|
|
|
|
Response status codes
|
|
|
|
|
**********************
|
2016-06-04 08:40:39 +00:00
|
|
|
- **200**: Compute servers list returned
|
2016-05-11 17:35:36 +00:00
|
|
|
|
