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-17 11:12:22 +02:00
1 parent ba05ca029e
commit 6dff8af235
183 files changed
+686 -348
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+1 -1
View File
@@ -76,8 +76,8 @@ Delete a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node 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
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node 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
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/project/projects.rst
+2
View File
@@ -29,9 +29,11 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
</table>
Sample session
docs/api/v2/controller/project/projectsprojectidclose.rst
+13
View File
@@ -16,6 +16,19 @@ Response status codes
- **404**: The project doesn't exist
- **204**: The project has been closed
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
</table>
Sample session
***************