mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Make sure nothing is named "compute server".
This commit is contained in:
1 parent
b4a2bc5b47
commit
a17fa821bd
14 files changed
+44
-44
No files matched your search
@@ -5,11 +5,11 @@
|
||||
|
||||
POST /v2/computes
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Register a compute server
|
||||
Register a compute
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: Compute server added
|
||||
- **201**: Compute added
|
||||
|
||||
Input
|
||||
*******
|
||||
@@ -34,7 +34,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>capabilities</td> <td> </td> <td>object</td> <td>Get what a server support</td> </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>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute 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>
|
||||
<tr><td>host</td> <td>✔</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>
|
||||
@@ -48,9 +48,9 @@ Output
|
||||
|
||||
GET /v2/computes
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
List of compute servers
|
||||
List of computes
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Compute servers list returned
|
||||
- **200**: Compute list returned
|
||||
|
||||
@@ -5,11 +5,11 @@
|
||||
|
||||
PUT /v2/computes/**{compute_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Update a compute server
|
||||
Update a compute
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Compute server updated
|
||||
- **200**: Compute
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
@@ -36,7 +36,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>capabilities</td> <td> </td> <td>object</td> <td>Get what a server support</td> </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>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute 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>
|
||||
<tr><td>host</td> <td>✔</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>
|
||||
@@ -50,11 +50,11 @@ Output
|
||||
|
||||
GET /v2/computes/**{compute_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a compute server information
|
||||
Get a compute information
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Compute server information returned
|
||||
- **200**: Compute information returned
|
||||
|
||||
Output
|
||||
*******
|
||||
@@ -64,7 +64,7 @@ Output
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>capabilities</td> <td> </td> <td>object</td> <td>Get what a server support</td> </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>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute 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>
|
||||
<tr><td>host</td> <td>✔</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>
|
||||
|
||||
+2
-2
@@ -28,7 +28,7 @@ Check the server version with a simple curl command:
|
||||
List computes
|
||||
##############
|
||||
|
||||
List all the compute servers:
|
||||
List all the computes:
|
||||
|
||||
.. code-block:: shell-session
|
||||
|
||||
@@ -45,7 +45,7 @@ List all the compute servers:
|
||||
}
|
||||
]
|
||||
|
||||
There is only one compute server where nodes can be run in this example.
|
||||
There is only one compute where nodes can be run in this example.
|
||||
This compute as a special id: local, this is the local server which is embedded in the GNS3 controller.
|
||||
|
||||
Create a project
|
||||
|
||||
+1
-1
@@ -11,7 +11,7 @@ Controller endpoints
|
||||
|
||||
The controller manages everything, it is the central decision point
|
||||
and has a complete view of your network topologies, what nodes run on
|
||||
which compute server, the links between them etc.
|
||||
which compute, the links between them etc.
|
||||
|
||||
This is the high level API which can be used by users to manually control
|
||||
the GNS3 backend. The controller will call the compute endpoints when needed.
|
||||
|
||||
+1
-1
@@ -154,7 +154,7 @@
|
||||
]
|
||||
},
|
||||
"connected": {
|
||||
"description": "Whether the controller is connected to the compute server or not",
|
||||
"description": "Whether the controller is connected to the compute or not",
|
||||
"type": "boolean"
|
||||
},
|
||||
"cpu_usage_percent": {
|
||||
|
||||
Reference in new issue
Block a user