mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Update documentation
This commit is contained in:
211 files changed
+999
-717
No files matched your search
@@ -30,6 +30,7 @@ Input
|
||||
<tr><td>console_http_port</td> <td> </td> <td>integer</td> <td>Internal port in the container for the HTTP server</td> </tr>
|
||||
<tr><td>console_resolution</td> <td> </td> <td>['string', 'null']</td> <td>Console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc, http, https</td> </tr>
|
||||
<tr><td>container_id</td> <td> </td> <td>string</td> <td>Docker container ID Read only</td> </tr>
|
||||
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment variables</td> </tr>
|
||||
<tr><td>image</td> <td>✔</td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
|
||||
@@ -9,8 +9,8 @@ Delete a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -25,8 +25,8 @@ Update a Docker instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -9,10 +9,10 @@ Add a NIO to a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **port_number**: Port on the adapter
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -33,10 +33,10 @@ Remove a NIO from a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **port_number**: Port on the adapter
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -9,10 +9,10 @@ Start a packet capture on a Docker container instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **port_number**: Port on the adapter
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -9,10 +9,10 @@ Stop a packet capture on a Docker container instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -9,8 +9,8 @@ Pause a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -9,8 +9,8 @@ Restart a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -9,8 +9,8 @@ Start a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -9,8 +9,8 @@ Stop a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -9,8 +9,8 @@ Unpause a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
Reference in new issue
Block a user