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 API documentation

Browse Source
This commit is contained in:
grossmj committed 2019-10-23 22:00:00 +08:00
1 parent df9b40c1dc
commit c8f7d789f7
208 files changed
+11627 -11333
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/docker/projectsprojectiddockernodes.rst
+2
View File
@@ -34,6 +34,7 @@ Input
<tr><td>custom_adapters</td> <td> </td> <td>array</td> <td></td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment variables</td> </tr>
<tr><td>extra_hosts</td> <td> </td> <td>['string', 'null']</td> <td>Docker extra hosts (added to /etc/hosts)</td> </tr>
<tr><td>extra_volumes</td> <td> </td> <td>array</td> <td>Additional directories to make persistent</td> </tr>
<tr><td>image</td> <td>&#10004;</td> <td>string</td> <td>Docker image name</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Docker container name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -58,6 +59,7 @@ Output
<tr><td>custom_adapters</td> <td> </td> <td>array</td> <td></td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>extra_hosts</td> <td> </td> <td>['string', 'null']</td> <td>Docker extra hosts (added to /etc/hosts)</td> </tr>
<tr><td>extra_volumes</td> <td> </td> <td>array</td> <td>Additional directories to make persistent</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>
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeid.rst
+2
View File
@@ -52,6 +52,7 @@ Input
<tr><td>custom_adapters</td> <td> </td> <td>array</td> <td></td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>extra_hosts</td> <td> </td> <td>['string', 'null']</td> <td>Docker extra hosts (added to /etc/hosts)</td> </tr>
<tr><td>extra_volumes</td> <td> </td> <td>array</td> <td>Additional directories to make persistent</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>
@@ -79,6 +80,7 @@ Output
<tr><td>custom_adapters</td> <td> </td> <td>array</td> <td></td> </tr>
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>extra_hosts</td> <td> </td> <td>['string', 'null']</td> <td>Docker extra hosts (added to /etc/hosts)</td> </tr>
<tr><td>extra_volumes</td> <td> </td> <td>array</td> <td>Additional directories to make persistent</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>
docs/api/v2/compute/iou/projectsprojectidiounodes.rst
+1 -1
View File
@@ -25,7 +25,7 @@ Input
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>application_id</td> <td> </td> <td>['integer', 'null']</td> <td>Application ID for running IOU image</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, none, null</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, none</td> </tr>
<tr><td>ethernet_adapters</td> <td> </td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
<tr><td>l1_keepalives</td> <td> </td> <td>['boolean', 'null']</td> <td>Always up ethernet interface</td> </tr>
<tr><td>md5sum</td> <td> </td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>