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

Browse Source
This commit is contained in:
Bernhard Ehlers committed 2018-01-08 09:26:44 +01:00
1 parent 21a7a68875
commit e6d2bd4424
360 files changed
+17598 -896
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/node/projectsprojectidnodes.rst
+13 -1
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
Input
*******
@@ -78,6 +78,12 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodes.txt
GET /v2/projects/**{project_id}**/nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -91,3 +97,9 @@ Response status codes
**********************
- **200**: List of nodes returned
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodes.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+20 -2
View File
@@ -44,6 +44,12 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeid.txt
PUT /v2/projects/**{project_id}**/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -117,6 +123,12 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_put_projectsprojectidnodesnodeid.txt
DELETE /v2/projects/**{project_id}**/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -124,12 +136,18 @@ Delete a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectidnodesnodeid.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeidduplicate.rst
+68
View File
@@ -0,0 +1,68 @@
/v2/projects/{project_id}/nodes/{node_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **201**: Instance duplicated
- **400**: Invalid request
- **404**: Instance doesn't exist
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>x</td> <td>&#10004;</td> <td>integer</td> <td>X position of the node</td> </tr>
<tr><td>y</td> <td>&#10004;</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
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>command_line</td> <td> </td> <td>['null', 'string']</td> <td>Command line use to start the node</td> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Compute identifier</td> </tr>
<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. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: vnc, telnet, http, https, spice, null</td> </tr>
<tr><td>first_port_name</td> <td> </td> <td>['string', 'null']</td> <td>Name of the first port</td> </tr>
<tr><td>height</td> <td> </td> <td>integer</td> <td>Height of the node (Read only)</td> </tr>
<tr><td>label</td> <td> </td> <td>object</td> <td></td> </tr>
<tr><td>name</td> <td>&#10004;</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>
<tr><td>node_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>port_name_format</td> <td> </td> <td>string</td> <td>Formating for port name {0} will be replace by port number</td> </tr>
<tr><td>port_segment_size</td> <td> </td> <td>integer</td> <td>Size of the port segment</td> </tr>
<tr><td>ports</td> <td> </td> <td>array</td> <td>List of node ports READ only</td> </tr>
<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', 'null']</td> <td>Symbol of the node</td> </tr>
<tr><td>width</td> <td> </td> <td>integer</td> <td>Width of the node (Read only)</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
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidduplicate.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsautoidlepc.rst
+8 -2
View File
@@ -9,12 +9,18 @@ Compute the IDLE PC for a Dynamips node
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsautoidlepc.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsidlepcproposals.rst
+8 -2
View File
@@ -9,12 +9,18 @@ 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
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeidfilespath.rst
+4 -4
View File
@@ -9,14 +9,14 @@ Get a file in the node directory
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/files/**{path:.+}**
@@ -25,12 +25,12 @@ Write a file in the node directory
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+8 -2
View File
@@ -9,14 +9,14 @@ Reload a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Output
*******
@@ -49,3 +49,9 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidreload.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+8 -2
View File
@@ -9,14 +9,14 @@ Start a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
Output
*******
@@ -49,3 +49,9 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidstart.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+8 -2
View File
@@ -9,14 +9,14 @@ Stop a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
Output
*******
@@ -49,3 +49,9 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidstop.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+8 -2
View File
@@ -9,14 +9,14 @@ Suspend a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
Output
*******
@@ -49,3 +49,9 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidsuspend.txt
docs/api/v2/controller/node/projectsprojectidnodesreload.rst
+7 -1
View File
@@ -13,9 +13,9 @@ Parameters
Response status codes
**********************
- **204**: All nodes successfully reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully reloaded
Output
*******
@@ -48,3 +48,9 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesreload.txt
docs/api/v2/controller/node/projectsprojectidnodesstart.rst
+7 -1
View File
@@ -13,9 +13,9 @@ Parameters
Response status codes
**********************
- **204**: All nodes successfully started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully started
Output
*******
@@ -48,3 +48,9 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstart.txt
docs/api/v2/controller/node/projectsprojectidnodesstop.rst
+7 -1
View File
@@ -13,9 +13,9 @@ Parameters
Response status codes
**********************
- **204**: All nodes successfully stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully stopped
Output
*******
@@ -48,3 +48,9 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstop.txt
docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
+7 -1
View File
@@ -13,9 +13,9 @@ Parameters
Response status codes
**********************
- **204**: All nodes successfully suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully suspended
Output
*******
@@ -48,3 +48,9 @@ Output
<tr><td>z</td> <td> </td> <td>integer</td> <td>Z position of the node</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodessuspend.txt