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 docs

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-06-06 14:24:13 +02:00
1 parent 65bfb4b907
commit e80dd40121
264 files changed
+3544 -1582
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/node/projectsprojectidnodes.rst
+19 -11
View File
@@ -9,7 +9,7 @@ Create a new node instance
Parameters
**********
- **project_id**: UUID for the project
- **project_id**: Project UUID
Response status codes
**********************
@@ -22,14 +22,18 @@ Input
<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> </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_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</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>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</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> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Output
@@ -38,14 +42,18 @@ Output
<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> </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_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</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>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</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> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Sample session
@@ -61,11 +69,11 @@ List nodes of a project
Parameters
**********
- **project_id**: UUID for the project
- **project_id**: Project UUID
Response status codes
**********************
- **200**: List of nodes
- **200**: List of nodes returned
Sample session
***************
docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+22 -12
View File
@@ -9,8 +9,9 @@ Update a node instance
Response status codes
**********************
- **200**: Instance updated
- **400**: Invalid request
- **201**: Instance created
- **404**: Instance doesn't exist
Input
*******
@@ -18,14 +19,18 @@ Input
<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> </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_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</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>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</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> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Output
@@ -34,14 +39,18 @@ Output
<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> </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_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</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>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</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> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Sample session
@@ -57,13 +66,14 @@ Delete a node instance
Parameters
**********
- **node_id**: UUID for the node
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance deleted
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsautoidlepc.rst
+26
View File
@@ -0,0 +1,26 @@
/v2/projects/{project_id}/nodes/{node_id}/dynamips/auto_idlepc
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/projects/**{project_id}**/nodes/**{node_id}**/dynamips/auto_idlepc
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Compute the IDLE PC for a Dynamips node
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **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
+26
View File
@@ -0,0 +1,26 @@
/v2/projects/{project_id}/nodes/{node_id}/dynamips/idlepc_proposals
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/projects/**{project_id}**/nodes/**{node_id}**/dynamips/idlepc_proposals
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Compute a list of potential idle PC for a node
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt
docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+12 -7
View File
@@ -9,13 +9,14 @@ Reload a node instance
Parameters
**********
- **node_id**: UUID for the node
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Output
*******
@@ -23,14 +24,18 @@ Output
<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> </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_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</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>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</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> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+12 -7
View File
@@ -9,13 +9,14 @@ Start a node instance
Parameters
**********
- **node_id**: UUID for the node
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **404**: Instance doesn't exist
- **204**: Instance started
Output
*******
@@ -23,14 +24,18 @@ Output
<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> </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_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</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>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</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> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+13 -8
View File
@@ -5,17 +5,18 @@
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/stop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a node instance
Stop a node instance
Parameters
**********
- **node_id**: UUID for the node
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **404**: Instance doesn't exist
- **204**: Instance stopped
Output
*******
@@ -23,14 +24,18 @@ Output
<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> </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_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</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>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</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> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+13 -8
View File
@@ -5,17 +5,18 @@
POST /v2/projects/**{project_id}**/nodes/**{node_id}**/suspend
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a node instance
Suspend a node instance
Parameters
**********
- **node_id**: UUID for the node
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **404**: Instance doesn't exist
- **204**: Instance suspended
Output
*******
@@ -23,14 +24,18 @@ Output
<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> </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_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</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>name</td> <td> </td> <td>string</td> <td>Node name</td> </tr>
<tr><td>node_id</td> <td> </td> <td>string</td> <td>Node identifier</td> </tr>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</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> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Sample session
docs/api/v2/controller/node/projectsprojectidnodesreload.rst
+45
View File
@@ -0,0 +1,45 @@
/v2/projects/{project_id}/nodes/reload
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes/reload
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Reload all nodes belonging to the project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully reloaded
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> </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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesreload.txt
docs/api/v2/controller/node/projectsprojectidnodesstart.rst
+45
View File
@@ -0,0 +1,45 @@
/v2/projects/{project_id}/nodes/start
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes/start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start all nodes belonging to the project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully started
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> </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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstart.txt
docs/api/v2/controller/node/projectsprojectidnodesstop.rst
+45
View File
@@ -0,0 +1,45 @@
/v2/projects/{project_id}/nodes/stop
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes/stop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop all nodes belonging to the project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully stopped
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> </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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstop.txt
docs/api/v2/controller/node/projectsprojectidnodessuspend.rst
+45
View File
@@ -0,0 +1,45 @@
/v2/projects/{project_id}/nodes/suspend
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/nodes/suspend
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Suspend all nodes belonging to the project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: All nodes successfully suspended
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> </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</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet, null</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>
<tr><td>node_type</td> <td> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</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>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodessuspend.txt