mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Update API documentation for appliance endpoints. Ref https://github.com/GNS3/gns3-gui/issues/2630
This commit is contained in:
1 parent
e5950674f8
commit
ff5ba3742e
343 files changed
+12431
-11199
No files matched your search
@@ -13,8 +13,8 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
- **400**: Invalid request
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
|
||||
@@ -134,9 +134,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance deleted
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
+7
-7
@@ -9,15 +9,15 @@ Add a NIO to a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **port_number**: Port where the nio should be added
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: NIO created
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
@@ -29,19 +29,19 @@ Sample session
|
||||
|
||||
PUT /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Update a NIO from a IOU instance
|
||||
Update a NIO on an IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **port_number**: Port where the nio should be added
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: NIO updated
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
@@ -57,16 +57,16 @@ Remove a NIO from a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **port_number**: Port from where the nio should be removed
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: NIO deleted
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
+1
-1
@@ -9,9 +9,9 @@ Start a packet capture on an IOU VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
|
||||
+2
-2
@@ -9,16 +9,16 @@ Stop a packet capture on an IOU VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Capture stopped
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Capture stopped
|
||||
- **409**: VM not started
|
||||
|
||||
Sample session
|
||||
|
||||
@@ -14,9 +14,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance reloaded
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
@@ -25,6 +25,7 @@ Input
|
||||
<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>
|
||||
<tr><td>license_check</td> <td> </td> <td>boolean</td> <td>Whether the license should be checked</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
|
||||
@@ -14,9 +14,9 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance stopped
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
@@ -14,7 +14,7 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Instance suspended
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance suspended
|
||||
|
||||
Reference in new issue
Block a user