NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-03 05:51:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update the documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2017-03-06 14:35:39 +01:00
1 parent 8b7035b185
commit 54131bc9bb
319 files changed
+921 -5755
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/docker/projectsprojectiddockernodes.rst
+1 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeid.rst
+3 -9
View File
@@ -9,14 +9,14 @@ Delete a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
PUT /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**
@@ -25,8 +25,8 @@ Update a Docker instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -83,9 +83,3 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectiddockernodesnodeid.txt
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+6 -18
View File
@@ -9,23 +9,17 @@ Add a NIO to a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -33,20 +27,14 @@ Remove a NIO from a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.txt
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+3 -9
View File
@@ -9,9 +9,9 @@ Start a packet capture on a Docker container instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **node_id**: Node UUID
- **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
@@ -28,12 +28,6 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>capture_file_name</td> <td>&#10004;</td> <td>string</td> <td>Capture file name</td> </tr>
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC</td> </tr>
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+3 -9
View File
@@ -9,21 +9,15 @@ Stop a packet capture on a Docker container instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **node_id**: Node UUID
- **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**: Container not started
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidpause.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Pause a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance paused
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance paused
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidreload.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Restart a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance restarted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance restarted
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstart.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Start a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstop.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Stop a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidunpause.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Unpause a Docker container
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance unpaused
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance unpaused