mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Update docs
This commit is contained in:
264 files changed
+3544
-1582
No files matched your search
@@ -5,11 +5,11 @@
|
||||
|
||||
POST /v2/computes
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Register a compute
|
||||
Register a compute server
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: Compute added
|
||||
- **201**: Compute server added
|
||||
|
||||
Input
|
||||
*******
|
||||
@@ -17,12 +17,13 @@ Input
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Server identifier</td> </tr>
|
||||
<tr><td>host</td> <td>✔</td> <td>string</td> <td>Server host</td> </tr>
|
||||
<tr><td>password</td> <td> </td> <td>string</td> <td>Password for auth</td> </tr>
|
||||
<tr><td>port</td> <td>✔</td> <td>integer</td> <td>Server port</td> </tr>
|
||||
<tr><td>protocol</td> <td>✔</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
|
||||
<tr><td>user</td> <td> </td> <td>string</td> <td>User for auth</td> </tr>
|
||||
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Server identifier</td> </tr>
|
||||
<tr><td>host</td> <td> </td> <td>string</td> <td>Server host</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Server name</td> </tr>
|
||||
<tr><td>password</td> <td> </td> <td>['string', 'null']</td> <td>Password for authentication</td> </tr>
|
||||
<tr><td>port</td> <td> </td> <td>integer</td> <td>Server port</td> </tr>
|
||||
<tr><td>protocol</td> <td> </td> <td>enum</td> <td>Possible values: http, https</td> </tr>
|
||||
<tr><td>user</td> <td> </td> <td>['string', 'null']</td> <td>User for authentication</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
@@ -32,20 +33,21 @@ Output
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Server identifier</td> </tr>
|
||||
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>True if controller is connected to the compute</td> </tr>
|
||||
<tr><td>connected</td> <td>✔</td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
|
||||
<tr><td>host</td> <td>✔</td> <td>string</td> <td>Server host</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Server name</td> </tr>
|
||||
<tr><td>port</td> <td>✔</td> <td>integer</td> <td>Server port</td> </tr>
|
||||
<tr><td>protocol</td> <td>✔</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
|
||||
<tr><td>user</td> <td> </td> <td>string</td> <td>User for auth</td> </tr>
|
||||
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote compute</td> </tr>
|
||||
<tr><td>user</td> <td> </td> <td>['string', 'null']</td> <td>User for authentication</td> </tr>
|
||||
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote compute server</td> </tr>
|
||||
</table>
|
||||
|
||||
|
||||
GET /v2/computes
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
List compute nodes
|
||||
List of compute servers
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Compute list
|
||||
- **200**: Compute servers list returned
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
/v2/computes/{compute_id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
PUT /v2/computes/**{compute_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a compute server information
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Compute server updated
|
||||
- **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>compute_id</td> <td> </td> <td>string</td> <td>Server identifier</td> </tr>
|
||||
<tr><td>host</td> <td> </td> <td>string</td> <td>Server host</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Server name</td> </tr>
|
||||
<tr><td>password</td> <td> </td> <td>['string', 'null']</td> <td>Password for authentication</td> </tr>
|
||||
<tr><td>port</td> <td> </td> <td>integer</td> <td>Server port</td> </tr>
|
||||
<tr><td>protocol</td> <td> </td> <td>enum</td> <td>Possible values: http, https</td> </tr>
|
||||
<tr><td>user</td> <td> </td> <td>['string', 'null']</td> <td>User for authentication</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Server identifier</td> </tr>
|
||||
<tr><td>connected</td> <td>✔</td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
|
||||
<tr><td>host</td> <td>✔</td> <td>string</td> <td>Server host</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Server name</td> </tr>
|
||||
<tr><td>port</td> <td>✔</td> <td>integer</td> <td>Server port</td> </tr>
|
||||
<tr><td>protocol</td> <td>✔</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
|
||||
<tr><td>user</td> <td> </td> <td>['string', 'null']</td> <td>User for authentication</td> </tr>
|
||||
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote compute server</td> </tr>
|
||||
</table>
|
||||
|
||||
|
||||
GET /v2/computes/**{compute_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a compute server information
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Compute server information returned
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>compute_id</td> <td>✔</td> <td>string</td> <td>Server identifier</td> </tr>
|
||||
<tr><td>connected</td> <td>✔</td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
|
||||
<tr><td>host</td> <td>✔</td> <td>string</td> <td>Server host</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Server name</td> </tr>
|
||||
<tr><td>port</td> <td>✔</td> <td>integer</td> <td>Server port</td> </tr>
|
||||
<tr><td>protocol</td> <td>✔</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
|
||||
<tr><td>user</td> <td> </td> <td>['string', 'null']</td> <td>User for authentication</td> </tr>
|
||||
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote compute server</td> </tr>
|
||||
</table>
|
||||
|
||||
|
||||
DELETE /v2/computes/**{compute_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Delete a compute instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **compute_id**: Compute UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
/v2/computes/{compute_id}/{emulator}/{action}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/computes/**{compute_id}**/**{emulator}**/**{action}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Forward call specific to compute node. Read the full compute API for available actions
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **compute_id**: Compute UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: OK
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
@@ -3,13 +3,32 @@
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/projects/**{project_id}**/links
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
List links of a project
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: List of links returned
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_get_projectsprojectidlinks.txt
|
||||
|
||||
|
||||
POST /v2/projects/**{project_id}**/links
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a new link instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -22,11 +41,12 @@ Input
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only propertie. The name of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only propertie. The full path of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only propertie. True if a capture running on the link</td> </tr>
|
||||
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link identifier</td> </tr>
|
||||
<tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The name of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The full path of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only property. True if a capture running on the link</td> </tr>
|
||||
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr>
|
||||
<tr><td>nodes</td> <td>✔</td> <td>array</td> <td>List of the VMS</td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
@@ -35,11 +55,12 @@ Output
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only propertie. The name of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only propertie. The full path of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only propertie. True if a capture running on the link</td> </tr>
|
||||
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link identifier</td> </tr>
|
||||
<tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The name of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The full path of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only property. True if a capture running on the link</td> </tr>
|
||||
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr>
|
||||
<tr><td>nodes</td> <td>✔</td> <td>array</td> <td>List of the VMS</td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
|
||||
@@ -9,8 +9,8 @@ Delete a link instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **link_id**: UUID of the link
|
||||
- **project_id**: UUID for the project
|
||||
- **link_id**: Link UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -5,16 +5,16 @@
|
||||
|
||||
GET /v2/projects/**{project_id}**/links/**{link_id}**/pcap
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get the pcap from the capture
|
||||
Steam the pcap capture file
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **link_id**: UUID of the link
|
||||
- **project_id**: UUID for the project
|
||||
- **link_id**: Link UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Return the file
|
||||
- **200**: File returned
|
||||
- **403**: Permission denied
|
||||
- **404**: The file doesn't exist
|
||||
|
||||
@@ -5,12 +5,12 @@
|
||||
|
||||
POST /v2/projects/**{project_id}**/links/**{link_id}**/start_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start capture on a link instance. By default we consider it as an ethernet link
|
||||
Start capture on a link instance. By default we consider it as an Ethernet link
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **link_id**: UUID of the link
|
||||
- **project_id**: UUID for the project
|
||||
- **link_id**: Link UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -23,7 +23,7 @@ Input
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>capture_file_name</td> <td> </td> <td>string</td> <td>Read only propertie. The name of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capture_file_name</td> <td> </td> <td>string</td> <td>Read only property. The name of the capture file if capture is running</td> </tr>
|
||||
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -33,11 +33,12 @@ Output
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only propertie. The name of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only propertie. The full path of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only propertie. True if a capture running on the link</td> </tr>
|
||||
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link identifier</td> </tr>
|
||||
<tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The name of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The full path of the capture file if capture is running</td> </tr>
|
||||
<tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only property. True if a capture running on the link</td> </tr>
|
||||
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr>
|
||||
<tr><td>nodes</td> <td>✔</td> <td>array</td> <td>List of the VMS</td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
|
||||
@@ -9,8 +9,8 @@ Stop capture on a link instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **link_id**: UUID of the link
|
||||
- **project_id**: UUID for the project
|
||||
- **link_id**: Link UUID
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -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
|
||||
***************
|
||||
|
||||
@@ -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
|
||||
***************
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -21,7 +21,6 @@ Input
|
||||
<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> </td> <td>['string', 'null']</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>temporary</td> <td> </td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
@@ -33,7 +32,6 @@ Output
|
||||
<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>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>temporary</td> <td>✔</td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
|
||||
@@ -5,15 +5,15 @@
|
||||
|
||||
GET /v2/projects/**{project_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get the project
|
||||
Get a project
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: The UUID of the project
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: The project exist
|
||||
- **200**: Project information returned
|
||||
- **404**: The project doesn't exist
|
||||
|
||||
Sample session
|
||||
@@ -29,7 +29,7 @@ Delete a project from disk
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: The UUID of the project
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -9,7 +9,7 @@ Close a project
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: The UUID of the project
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -9,7 +9,7 @@ Write changes on disk
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: The UUID of the project
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -5,11 +5,11 @@
|
||||
|
||||
GET /v2/projects/**{project_id}**/notifications
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Receive notifications about the projects
|
||||
Receive notifications about projects
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: The UUID of the project
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -5,11 +5,11 @@
|
||||
|
||||
GET /v2/projects/**{project_id}**/notifications/ws
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Receive notifications about the projects via Websocket
|
||||
Receive notifications about projects from a Websocket
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: The UUID of the project
|
||||
- **project_id**: Project UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
Version
|
||||
Server
|
||||
-----------------------------
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
version/*
|
||||
server/*
|
||||
+11
-5
@@ -1,14 +1,20 @@
|
||||
/v2/computes/shutdown
|
||||
/v2/shutdown
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/computes/shutdown
|
||||
POST /v2/shutdown
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Shutdown the local compute
|
||||
Shutdown the local server
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: Compute is shutting down
|
||||
- **403**: Compute shutdown refused
|
||||
- **201**: Server is shutting down
|
||||
- **403**: Server shutdown refused
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_shutdown.txt
|
||||
|
||||
+6
-6
@@ -17,8 +17,8 @@ Output
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Either this is a local server</td> </tr>
|
||||
<tr><td>version</td> <td>✔</td> <td>string</td> <td>Version number human readable</td> </tr>
|
||||
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Whether this is a local server or not</td> </tr>
|
||||
<tr><td>version</td> <td>✔</td> <td>string</td> <td>Version number</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
@@ -43,8 +43,8 @@ Input
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Either this is a local server</td> </tr>
|
||||
<tr><td>version</td> <td>✔</td> <td>string</td> <td>Version number human readable</td> </tr>
|
||||
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Whether this is a local server or not</td> </tr>
|
||||
<tr><td>version</td> <td>✔</td> <td>string</td> <td>Version number</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
@@ -53,8 +53,8 @@ Output
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Either this is a local server</td> </tr>
|
||||
<tr><td>version</td> <td>✔</td> <td>string</td> <td>Version number human readable</td> </tr>
|
||||
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Whether this is a local server or not</td> </tr>
|
||||
<tr><td>version</td> <td>✔</td> <td>string</td> <td>Version number</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
Reference in new issue
Block a user