mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Rebuild documentation
This commit is contained in:
205 files changed
+801
-881
No files matched your search
@@ -9,8 +9,8 @@ Get an IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -61,8 +61,8 @@ Update an IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -144,8 +144,8 @@ Delete an IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -9,10 +9,10 @@ Add a NIO to a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **port_number**: Port where the nio should be added
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -33,10 +33,10 @@ Remove a NIO from a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **port_number**: Port from where the nio should be removed
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -9,10 +9,10 @@ Start a packet capture on an IOU VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **port_number**: Port on the adapter
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -9,10 +9,10 @@ Stop a packet capture on an IOU VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/nodes/{node_id}/configs
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/configs
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Retrieve the startup and private configs content
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Configs retrieved
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>private_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the private configuration file</td> </tr>
|
||||
<tr><td>startup_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the startup configuration file</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_get_projectsprojectidiounodesnodeidconfigs.txt
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/nodes/{node_id}/configs/save
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/configs/save
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Save the startup and private configs content
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Configs saved
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
@@ -9,8 +9,8 @@ Reload an IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -9,8 +9,8 @@ Start an IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -9,8 +9,8 @@ Stop an IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
Reference in new issue
Block a user