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 documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-06-14 10:24:55 +02:00
1 parent 3255be0ae2
commit 27624acd06
177 files changed
+516 -750
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/project/projectsprojectidcommit.rst → docs/api/v2/controller/compute/sidemulatorimages.rst
+6 -12
View File
@@ -1,24 +1,18 @@
/v2/projects/{project_id}/commit
/v2/computes/{compute_id}/{emulator}/images
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/commit
GET /v2/computes/**{compute_id}**/**{emulator}**/images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Write changes on disk
Return the list of images available on compute and controller for this emulator type
Parameters
**********
- **project_id**: Project UUID
- **compute_id**: Compute UUID
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: Changes have been written on disk
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidcommit.txt
- **200**: OK
- **404**: Instance doesn't exist
docs/api/v2/controller/node/projectsprojectidnodes.rst
+10
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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -34,6 +35,10 @@ Input
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Output
@@ -47,6 +52,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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -54,6 +60,10 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+11 -1
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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -31,6 +32,10 @@ Input
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Output
@@ -44,6 +49,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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -51,6 +57,10 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Sample session
@@ -66,8 +76,8 @@ Delete a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsautoidlepc.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Compute the IDLE PC for a Dynamips node
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsidlepcproposals.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Compute a list of potential idle PC for a node
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+6 -1
View File
@@ -9,8 +9,8 @@ Reload a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -36,6 +37,10 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+6 -1
View File
@@ -9,8 +9,8 @@ Start a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -36,6 +37,10 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+6 -1
View File
@@ -9,8 +9,8 @@ Stop a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -36,6 +37,10 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+6 -1
View File
@@ -9,8 +9,8 @@ Suspend a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -36,6 +37,10 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesreload.rst
+5
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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -35,6 +36,10 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesstart.rst
+5
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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -35,6 +36,10 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesstop.rst
+5
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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -35,6 +36,10 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
+5
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>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>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node UUID</td> </tr>
@@ -35,6 +36,10 @@ Output
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<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>
</table>
Sample session