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

Update documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-07-11 15:37:57 +02:00
1 parent 91ec61b88d
commit 27269fb13a
142 files changed
+1072 -796
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/node/projectsprojectidnodes.rst
+10 -6
View File
@@ -27,6 +27,7 @@ Input
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -36,9 +37,10 @@ Input
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Output
@@ -52,6 +54,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -61,9 +64,10 @@ Output
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+10 -6
View File
@@ -24,6 +24,7 @@ Input
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -33,9 +34,10 @@ Input
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Output
@@ -49,6 +51,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -58,9 +61,10 @@ Output
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+5 -3
View File
@@ -29,6 +29,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -38,9 +39,10 @@ Output
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+5 -3
View File
@@ -29,6 +29,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -38,9 +39,10 @@ Output
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+5 -3
View File
@@ -29,6 +29,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -38,9 +39,10 @@ Output
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+5 -3
View File
@@ -29,6 +29,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -38,9 +39,10 @@ Output
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesreload.rst
+5 -3
View File
@@ -28,6 +28,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -37,9 +38,10 @@ Output
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesstart.rst
+5 -3
View File
@@ -28,6 +28,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -37,9 +38,10 @@ Output
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesstop.rst
+5 -3
View File
@@ -28,6 +28,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -37,9 +38,10 @@ Output
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
+5 -3
View File
@@ -28,6 +28,7 @@ Output
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_host</td> <td> </td> <td>string</td> <td>Console host</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_directory</td> <td> </td> <td>['null', 'string']</td> <td>Working directory of the node. Read only</td> </tr>
@@ -37,9 +38,10 @@ Output
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: stopped, started, suspended</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>number</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>number</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>number</td> <td>Z position of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node</td> </tr>
<tr><td>x</td> <td> </td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td> </td> <td>integer</td> <td>Y position of the node</td> </tr>
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session