mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Update docs
This commit is contained in:
264 files changed
+3544
-1582
No files matched your search
@@ -5,11 +5,11 @@
|
||||
|
||||
POST /v2/computes
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Register a compute
|
||||
Register a compute server
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: Compute added
|
||||
- **201**: Compute server added
|
||||
|
||||
Input
|
||||
*******
|
||||
@@ -17,12 +17,13 @@ Input
|
||||
|
||||
<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>
|
||||
<tr><td>host</td> <td>✔</td> <td>string</td> <td>Server host</td> </tr>
|
||||
<tr><td>password</td> <td> </td> <td>string</td> <td>Password for auth</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</td> <td>User for auth</td> </tr>
|
||||
<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>
|
||||
</table>
|
||||
|
||||
Output
|
||||
@@ -32,20 +33,21 @@ Output
|
||||
<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>
|
||||
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>True if controller is connected to the compute</td> </tr>
|
||||
<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>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>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</td> <td>User for auth</td> </tr>
|
||||
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote compute</td> </tr>
|
||||
<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>
|
||||
</table>
|
||||
|
||||
|
||||
GET /v2/computes
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
List compute nodes
|
||||
List of compute servers
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Compute list
|
||||
- **200**: Compute servers list returned
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
/v2/computes/{compute_id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
PUT /v2/computes/**{compute_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a compute server information
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Compute server updated
|
||||
- **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>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>
|
||||
</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>
|
||||
<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>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>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>
|
||||
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote compute server</td> </tr>
|
||||
</table>
|
||||
|
||||
|
||||
GET /v2/computes/**{compute_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a compute server information
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Compute server information returned
|
||||
|
||||
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>
|
||||
<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>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>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>
|
||||
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote compute server</td> </tr>
|
||||
</table>
|
||||
|
||||
|
||||
DELETE /v2/computes/**{compute_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Delete a compute instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **compute_id**: Compute UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
+9
-5
@@ -1,14 +1,18 @@
|
||||
/v2/computes/shutdown
|
||||
/v2/computes/{compute_id}/{emulator}/{action}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/computes/shutdown
|
||||
GET /v2/computes/**{compute_id}**/**{emulator}**/**{action}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Shutdown the local compute
|
||||
Forward call specific to compute node. Read the full compute API for available actions
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **compute_id**: Compute UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: Compute is shutting down
|
||||
- **403**: Compute shutdown refused
|
||||
- **200**: OK
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Reference in new issue
Block a user