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

Rebuild doc

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-07-14 15:33:09 +02:00
1 parent b745397a3a
commit b5cb625169
210 files changed
+2555 -879
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/docker/projectsprojectiddockernodes.rst
+13 -13
View File
@@ -43,21 +43,21 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>integer</td> <td>Auxiliary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>integer</td> <td>Console TCP port</td> </tr>
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>Auxiliary TCP port</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<tr><td>console_http_path</td> <td> </td> <td>string</td> <td>Path of the web interface</td> </tr>
<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>&#10004;</td> <td>string</td> <td>Console resolution for VNC</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc, http, https</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>console_resolution</td> <td> </td> <td>string</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</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name Read only</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>string</td> <td>Path to the node working directory</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the node working directory Read only</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID Read only</td> </tr>
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeid.rst
+26 -20
View File
@@ -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
**********************
@@ -41,16 +41,22 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>Number of adapters</td> </tr>
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>Auxiliary TCP port</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>Auxiliary TCP port</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<tr><td>console_http_path</td> <td> </td> <td>string</td> <td>Path of the web interface</td> </tr>
<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_resolution</td> <td> </td> <td>string</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>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment variables</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</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name Read only</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the node working directory Read only</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID Read only</td> </tr>
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Output
@@ -59,22 +65,22 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>integer</td> <td>Auxiliary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>integer</td> <td>Console TCP port</td> </tr>
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>Auxiliary TCP port</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<tr><td>console_http_path</td> <td> </td> <td>string</td> <td>Path of the web interface</td> </tr>
<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>&#10004;</td> <td>string</td> <td>Console resolution for VNC</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc, http, https</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>console_resolution</td> <td> </td> <td>string</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</td> </tr>
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name Read only</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>string</td> <td>Path to the node working directory</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>string</td> <td>Path to the node working directory Read only</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID Read only</td> </tr>
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+4 -4
View File
@@ -9,10 +9,10 @@ Add a NIO to a Docker container
Parameters
**********
- **project_id**: Project UUID
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **node_id**: Node UUID
- **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
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **node_id**: Node UUID
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Start a packet capture on a Docker container instance
Parameters
**********
- **project_id**: Project UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a Docker container instance
Parameters
**********
- **project_id**: Project UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidpause.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Pause a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Restart a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidunpause.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Unpause a Docker container
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************