mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Rebuild documentation
This commit is contained in:
153 files changed
+55
-5218
No files matched your search
@@ -1,58 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/docker/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/docker/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a new Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td> </td> <td>['string', 'null']</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td>✔</td> <td>integer</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td>✔</td> <td>string</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>container_id</td> <td>✔</td> <td>string</td> <td>Docker container ID</td> </tr>
|
||||
<tr><td>environment</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td>✔</td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>start_command</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/docker/vms/{id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/docker/vms/**{id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Delete a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **id**: ID for the container
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/docker/vms/{id}/reload
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/docker/vms/**{id}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Restart a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **id**: ID of the container
|
||||
- **project_id**: UUID of the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance restarted
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td> </td> <td>['string', 'null']</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td>✔</td> <td>integer</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td>✔</td> <td>string</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>container_id</td> <td>✔</td> <td>string</td> <td>Docker container ID</td> </tr>
|
||||
<tr><td>environment</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td>✔</td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>start_command</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/docker/vms/{id}/start
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/docker/vms/**{id}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **id**: ID of the container
|
||||
- **project_id**: UUID of the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance started
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td> </td> <td>['string', 'null']</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td>✔</td> <td>integer</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td>✔</td> <td>string</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>container_id</td> <td>✔</td> <td>string</td> <td>Docker container ID</td> </tr>
|
||||
<tr><td>environment</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td>✔</td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>start_command</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/docker/vms/{id}/stop
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/docker/vms/**{id}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **id**: ID of the container
|
||||
- **project_id**: UUID of the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td> </td> <td>['string', 'null']</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td>✔</td> <td>integer</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td>✔</td> <td>string</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>container_id</td> <td>✔</td> <td>string</td> <td>Docker container ID</td> </tr>
|
||||
<tr><td>environment</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td>✔</td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>start_command</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/docker/vms/{id}/suspend
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/docker/vms/**{id}**/suspend
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Pause a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **id**: ID of the container
|
||||
- **project_id**: UUID of the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance paused
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td> </td> <td>['string', 'null']</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td> </td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>Docker VM instance identifier</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td>✔</td> <td>integer</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td>✔</td> <td>string</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>container_id</td> <td>✔</td> <td>string</td> <td>Docker container ID</td> </tr>
|
||||
<tr><td>environment</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td>✔</td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>start_command</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -1,64 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/docker/vms/{vm_id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
PUT /v2/compute/projects/**{project_id}**/docker/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Update a Docker instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Instance updated
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td> </td> <td>['string', 'null']</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>environment</td> <td> </td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>start_command</td> <td> </td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapters</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>aux</td> <td>✔</td> <td>integer</td> <td>auxilary TCP port</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_resolution</td> <td>✔</td> <td>string</td> <td>console resolution for VNC</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>container_id</td> <td>✔</td> <td>string</td> <td>Docker container ID</td> </tr>
|
||||
<tr><td>environment</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
|
||||
<tr><td>image</td> <td>✔</td> <td>string</td> <td>Docker image name</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Docker container name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>start_command</td> <td>✔</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_put_projectsprojectiddockervmsvmid.txt
|
||||
|
||||
-52
@@ -1,52 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **id**: ID of the container
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: NIO created
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Remove a NIO from a Docker container
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **id**: ID of the container
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt
|
||||
|
||||
-39
@@ -1,39 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a packet capture on a IOU VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Capture started
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **409**: VM not started
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<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>Capture file name</td> </tr>
|
||||
<tr><td>data_link_type</td> <td> </td> <td>string</td> <td>PCAP data link type</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt
|
||||
|
||||
-29
@@ -1,29 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/docker/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a packet capture on a IOU VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Capture stopped
|
||||
- **409**: VM not started
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt
|
||||
|
||||
@@ -9,8 +9,8 @@ Get a Dynamips device instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
- **device_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -38,8 +38,8 @@ Update a Dynamips device instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
- **device_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -96,8 +96,8 @@ Delete a Dynamips device instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
- **device_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+2
-2
@@ -9,9 +9,9 @@ Add a NIO to a Dynamips device instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
- **port_number**: Port on the device
|
||||
- **device_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -139,9 +139,9 @@ Remove a NIO from a Dynamips device instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
- **port_number**: Port on the device
|
||||
- **device_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -9,9 +9,9 @@ Start a packet capture on a Dynamips device instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
- **port_number**: Port on the device
|
||||
- **device_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
+1
-1
@@ -9,9 +9,9 @@ Stop a packet capture on a Dynamips device instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
- **port_number**: Port on the device
|
||||
- **device_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
/v2/compute/dynamips/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/dynamips/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Retrieve the list of Dynamips VMS
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: List of Dynamips VM retrieved
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
/v2/compute/dynamips/vms/{path}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/dynamips/vms/**{path}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Upload Dynamips image.
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Image uploaded
|
||||
|
||||
@@ -1,125 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/dynamips/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a new Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>auto_delete_disks</td> <td> </td> <td>boolean</td> <td>automatically delete nvram and disk files</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
|
||||
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
|
||||
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet</td> </tr>
|
||||
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
|
||||
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
|
||||
<tr><td>dynamips_id</td> <td> </td> <td>integer</td> <td>ID to use with Dynamips</td> </tr>
|
||||
<tr><td>exec_area</td> <td> </td> <td>integer</td> <td>exec area value</td> </tr>
|
||||
<tr><td>idlemax</td> <td> </td> <td>integer</td> <td>idlemax value</td> </tr>
|
||||
<tr><td>idlepc</td> <td> </td> <td>string</td> <td>Idle-PC value</td> </tr>
|
||||
<tr><td>idlesleep</td> <td> </td> <td>integer</td> <td>idlesleep value</td> </tr>
|
||||
<tr><td>image</td> <td>✔</td> <td>string</td> <td>path to the IOS image</td> </tr>
|
||||
<tr><td>image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>checksum of the IOS image</td> </tr>
|
||||
<tr><td>iomem</td> <td> </td> <td>integer</td> <td>I/O memory percentage</td> </tr>
|
||||
<tr><td>mac_addr</td> <td> </td> <td>string</td> <td>base MAC address</td> </tr>
|
||||
<tr><td>midplane</td> <td> </td> <td>enum</td> <td>Possible values: std, vxr</td> </tr>
|
||||
<tr><td>mmap</td> <td> </td> <td>boolean</td> <td>MMAP feature</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Dynamips VM instance name</td> </tr>
|
||||
<tr><td>npe</td> <td> </td> <td>enum</td> <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td> </tr>
|
||||
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>amount of NVRAM in KB</td> </tr>
|
||||
<tr><td>platform</td> <td>✔</td> <td>string</td> <td>platform</td> </tr>
|
||||
<tr><td>power_supplies</td> <td> </td> <td>array</td> <td>Power supplies status</td> </tr>
|
||||
<tr><td>private_config</td> <td> </td> <td>string</td> <td>path to the IOS private configuration file</td> </tr>
|
||||
<tr><td>private_config_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
|
||||
<tr><td>private_config_content</td> <td> </td> <td>string</td> <td>Content of IOS private configuration file</td> </tr>
|
||||
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>sensors</td> <td> </td> <td>array</td> <td>Temperature sensors</td> </tr>
|
||||
<tr><td>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
|
||||
<tr><td>slot1</td> <td> </td> <td></td> <td>Network module slot 1</td> </tr>
|
||||
<tr><td>slot2</td> <td> </td> <td></td> <td>Network module slot 2</td> </tr>
|
||||
<tr><td>slot3</td> <td> </td> <td></td> <td>Network module slot 3</td> </tr>
|
||||
<tr><td>slot4</td> <td> </td> <td></td> <td>Network module slot 4</td> </tr>
|
||||
<tr><td>slot5</td> <td> </td> <td></td> <td>Network module slot 5</td> </tr>
|
||||
<tr><td>slot6</td> <td> </td> <td></td> <td>Network module slot 6</td> </tr>
|
||||
<tr><td>sparsemem</td> <td> </td> <td>boolean</td> <td>sparse memory feature</td> </tr>
|
||||
<tr><td>startup_config</td> <td> </td> <td>string</td> <td>path to the IOS startup configuration file</td> </tr>
|
||||
<tr><td>startup_config_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</td> </tr>
|
||||
<tr><td>startup_config_content</td> <td> </td> <td>string</td> <td>Content of IOS startup configuration file</td> </tr>
|
||||
<tr><td>system_id</td> <td> </td> <td>string</td> <td>system ID</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td></td> <td>Dynamips VM instance identifier</td> </tr>
|
||||
<tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
<tr><td>wic1</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
<tr><td>wic2</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>auto_delete_disks</td> <td> </td> <td>boolean</td> <td>automatically delete nvram and disk files</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxiliary console TCP port</td> </tr>
|
||||
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
|
||||
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
|
||||
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
|
||||
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
|
||||
<tr><td>dynamips_id</td> <td>✔</td> <td>integer</td> <td>ID to use with Dynamips</td> </tr>
|
||||
<tr><td>exec_area</td> <td> </td> <td>integer</td> <td>exec area value</td> </tr>
|
||||
<tr><td>idlemax</td> <td> </td> <td>integer</td> <td>idlemax value</td> </tr>
|
||||
<tr><td>idlepc</td> <td> </td> <td>string</td> <td>Idle-PC value</td> </tr>
|
||||
<tr><td>idlesleep</td> <td> </td> <td>integer</td> <td>idlesleep value</td> </tr>
|
||||
<tr><td>image</td> <td> </td> <td>string</td> <td>path to the IOS image</td> </tr>
|
||||
<tr><td>image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>checksum of the IOS image</td> </tr>
|
||||
<tr><td>iomem</td> <td> </td> <td>integer</td> <td>I/O memory percentage</td> </tr>
|
||||
<tr><td>mac_addr</td> <td> </td> <td>string</td> <td>base MAC address</td> </tr>
|
||||
<tr><td>midplane</td> <td> </td> <td>enum</td> <td>Possible values: std, vxr</td> </tr>
|
||||
<tr><td>mmap</td> <td> </td> <td>boolean</td> <td>MMAP feature</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Dynamips VM instance name</td> </tr>
|
||||
<tr><td>npe</td> <td> </td> <td>enum</td> <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td> </tr>
|
||||
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>amount of NVRAM in KB</td> </tr>
|
||||
<tr><td>platform</td> <td> </td> <td>string</td> <td>platform</td> </tr>
|
||||
<tr><td>power_supplies</td> <td> </td> <td>array</td> <td>Power supplies status</td> </tr>
|
||||
<tr><td>private_config</td> <td> </td> <td>string</td> <td>path to the IOS private configuration file</td> </tr>
|
||||
<tr><td>private_config_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>sensors</td> <td> </td> <td>array</td> <td>Temperature sensors</td> </tr>
|
||||
<tr><td>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
|
||||
<tr><td>slot1</td> <td> </td> <td></td> <td>Network module slot 1</td> </tr>
|
||||
<tr><td>slot2</td> <td> </td> <td></td> <td>Network module slot 2</td> </tr>
|
||||
<tr><td>slot3</td> <td> </td> <td></td> <td>Network module slot 3</td> </tr>
|
||||
<tr><td>slot4</td> <td> </td> <td></td> <td>Network module slot 4</td> </tr>
|
||||
<tr><td>slot5</td> <td> </td> <td></td> <td>Network module slot 5</td> </tr>
|
||||
<tr><td>slot6</td> <td> </td> <td></td> <td>Network module slot 6</td> </tr>
|
||||
<tr><td>sparsemem</td> <td> </td> <td>boolean</td> <td>sparse memory feature</td> </tr>
|
||||
<tr><td>startup_config</td> <td> </td> <td>string</td> <td>path to the IOS startup configuration file</td> </tr>
|
||||
<tr><td>startup_config_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</td> </tr>
|
||||
<tr><td>system_id</td> <td> </td> <td>string</td> <td>system ID</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>Dynamips router instance UUID</td> </tr>
|
||||
<tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
<tr><td>wic1</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
<tr><td>wic2</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -1,208 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Success
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>auto_delete_disks</td> <td> </td> <td>boolean</td> <td>automatically delete nvram and disk files</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxiliary console TCP port</td> </tr>
|
||||
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
|
||||
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
|
||||
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
|
||||
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
|
||||
<tr><td>dynamips_id</td> <td>✔</td> <td>integer</td> <td>ID to use with Dynamips</td> </tr>
|
||||
<tr><td>exec_area</td> <td> </td> <td>integer</td> <td>exec area value</td> </tr>
|
||||
<tr><td>idlemax</td> <td> </td> <td>integer</td> <td>idlemax value</td> </tr>
|
||||
<tr><td>idlepc</td> <td> </td> <td>string</td> <td>Idle-PC value</td> </tr>
|
||||
<tr><td>idlesleep</td> <td> </td> <td>integer</td> <td>idlesleep value</td> </tr>
|
||||
<tr><td>image</td> <td> </td> <td>string</td> <td>path to the IOS image</td> </tr>
|
||||
<tr><td>image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>checksum of the IOS image</td> </tr>
|
||||
<tr><td>iomem</td> <td> </td> <td>integer</td> <td>I/O memory percentage</td> </tr>
|
||||
<tr><td>mac_addr</td> <td> </td> <td>string</td> <td>base MAC address</td> </tr>
|
||||
<tr><td>midplane</td> <td> </td> <td>enum</td> <td>Possible values: std, vxr</td> </tr>
|
||||
<tr><td>mmap</td> <td> </td> <td>boolean</td> <td>MMAP feature</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Dynamips VM instance name</td> </tr>
|
||||
<tr><td>npe</td> <td> </td> <td>enum</td> <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td> </tr>
|
||||
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>amount of NVRAM in KB</td> </tr>
|
||||
<tr><td>platform</td> <td> </td> <td>string</td> <td>platform</td> </tr>
|
||||
<tr><td>power_supplies</td> <td> </td> <td>array</td> <td>Power supplies status</td> </tr>
|
||||
<tr><td>private_config</td> <td> </td> <td>string</td> <td>path to the IOS private configuration file</td> </tr>
|
||||
<tr><td>private_config_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>sensors</td> <td> </td> <td>array</td> <td>Temperature sensors</td> </tr>
|
||||
<tr><td>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
|
||||
<tr><td>slot1</td> <td> </td> <td></td> <td>Network module slot 1</td> </tr>
|
||||
<tr><td>slot2</td> <td> </td> <td></td> <td>Network module slot 2</td> </tr>
|
||||
<tr><td>slot3</td> <td> </td> <td></td> <td>Network module slot 3</td> </tr>
|
||||
<tr><td>slot4</td> <td> </td> <td></td> <td>Network module slot 4</td> </tr>
|
||||
<tr><td>slot5</td> <td> </td> <td></td> <td>Network module slot 5</td> </tr>
|
||||
<tr><td>slot6</td> <td> </td> <td></td> <td>Network module slot 6</td> </tr>
|
||||
<tr><td>sparsemem</td> <td> </td> <td>boolean</td> <td>sparse memory feature</td> </tr>
|
||||
<tr><td>startup_config</td> <td> </td> <td>string</td> <td>path to the IOS startup configuration file</td> </tr>
|
||||
<tr><td>startup_config_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</td> </tr>
|
||||
<tr><td>system_id</td> <td> </td> <td>string</td> <td>system ID</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>Dynamips router instance UUID</td> </tr>
|
||||
<tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
<tr><td>wic1</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
<tr><td>wic2</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
</table>
|
||||
|
||||
|
||||
PUT /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Update a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Instance updated
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>auto_delete_disks</td> <td> </td> <td>boolean</td> <td>automatically delete nvram and disk files</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
|
||||
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
|
||||
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: telnet</td> </tr>
|
||||
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
|
||||
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
|
||||
<tr><td>exec_area</td> <td> </td> <td>integer</td> <td>exec area value</td> </tr>
|
||||
<tr><td>idlemax</td> <td> </td> <td>integer</td> <td>idlemax value</td> </tr>
|
||||
<tr><td>idlepc</td> <td> </td> <td>string</td> <td>Idle-PC value</td> </tr>
|
||||
<tr><td>idlesleep</td> <td> </td> <td>integer</td> <td>idlesleep value</td> </tr>
|
||||
<tr><td>image</td> <td> </td> <td>string</td> <td>path to the IOS image</td> </tr>
|
||||
<tr><td>image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>checksum of the IOS image</td> </tr>
|
||||
<tr><td>iomem</td> <td> </td> <td>integer</td> <td>I/O memory percentage</td> </tr>
|
||||
<tr><td>mac_addr</td> <td> </td> <td>string</td> <td>base MAC address</td> </tr>
|
||||
<tr><td>midplane</td> <td> </td> <td>enum</td> <td>Possible values: std, vxr</td> </tr>
|
||||
<tr><td>mmap</td> <td> </td> <td>boolean</td> <td>MMAP feature</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>Dynamips VM instance name</td> </tr>
|
||||
<tr><td>npe</td> <td> </td> <td>enum</td> <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td> </tr>
|
||||
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>amount of NVRAM in KB</td> </tr>
|
||||
<tr><td>platform</td> <td> </td> <td>string</td> <td>platform</td> </tr>
|
||||
<tr><td>power_supplies</td> <td> </td> <td>array</td> <td>Power supplies status</td> </tr>
|
||||
<tr><td>private_config_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
|
||||
<tr><td>private_config_content</td> <td> </td> <td>string</td> <td>Content of IOS private configuration file</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>sensors</td> <td> </td> <td>array</td> <td>Temperature sensors</td> </tr>
|
||||
<tr><td>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
|
||||
<tr><td>slot1</td> <td> </td> <td></td> <td>Network module slot 1</td> </tr>
|
||||
<tr><td>slot2</td> <td> </td> <td></td> <td>Network module slot 2</td> </tr>
|
||||
<tr><td>slot3</td> <td> </td> <td></td> <td>Network module slot 3</td> </tr>
|
||||
<tr><td>slot4</td> <td> </td> <td></td> <td>Network module slot 4</td> </tr>
|
||||
<tr><td>slot5</td> <td> </td> <td></td> <td>Network module slot 5</td> </tr>
|
||||
<tr><td>slot6</td> <td> </td> <td></td> <td>Network module slot 6</td> </tr>
|
||||
<tr><td>sparsemem</td> <td> </td> <td>boolean</td> <td>sparse memory feature</td> </tr>
|
||||
<tr><td>startup_config_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</td> </tr>
|
||||
<tr><td>startup_config_content</td> <td> </td> <td>string</td> <td>Content of IOS startup configuration file</td> </tr>
|
||||
<tr><td>system_id</td> <td> </td> <td>string</td> <td>system ID</td> </tr>
|
||||
<tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
<tr><td>wic1</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
<tr><td>wic2</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>auto_delete_disks</td> <td> </td> <td>boolean</td> <td>automatically delete nvram and disk files</td> </tr>
|
||||
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxiliary console TCP port</td> </tr>
|
||||
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
|
||||
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
|
||||
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
|
||||
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
|
||||
<tr><td>dynamips_id</td> <td>✔</td> <td>integer</td> <td>ID to use with Dynamips</td> </tr>
|
||||
<tr><td>exec_area</td> <td> </td> <td>integer</td> <td>exec area value</td> </tr>
|
||||
<tr><td>idlemax</td> <td> </td> <td>integer</td> <td>idlemax value</td> </tr>
|
||||
<tr><td>idlepc</td> <td> </td> <td>string</td> <td>Idle-PC value</td> </tr>
|
||||
<tr><td>idlesleep</td> <td> </td> <td>integer</td> <td>idlesleep value</td> </tr>
|
||||
<tr><td>image</td> <td> </td> <td>string</td> <td>path to the IOS image</td> </tr>
|
||||
<tr><td>image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>checksum of the IOS image</td> </tr>
|
||||
<tr><td>iomem</td> <td> </td> <td>integer</td> <td>I/O memory percentage</td> </tr>
|
||||
<tr><td>mac_addr</td> <td> </td> <td>string</td> <td>base MAC address</td> </tr>
|
||||
<tr><td>midplane</td> <td> </td> <td>enum</td> <td>Possible values: std, vxr</td> </tr>
|
||||
<tr><td>mmap</td> <td> </td> <td>boolean</td> <td>MMAP feature</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>Dynamips VM instance name</td> </tr>
|
||||
<tr><td>npe</td> <td> </td> <td>enum</td> <td>Possible values: npe-100, npe-150, npe-175, npe-200, npe-225, npe-300, npe-400, npe-g2</td> </tr>
|
||||
<tr><td>nvram</td> <td> </td> <td>integer</td> <td>amount of NVRAM in KB</td> </tr>
|
||||
<tr><td>platform</td> <td> </td> <td>string</td> <td>platform</td> </tr>
|
||||
<tr><td>power_supplies</td> <td> </td> <td>array</td> <td>Power supplies status</td> </tr>
|
||||
<tr><td>private_config</td> <td> </td> <td>string</td> <td>path to the IOS private configuration file</td> </tr>
|
||||
<tr><td>private_config_base64</td> <td> </td> <td>string</td> <td>private configuration base64 encoded</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>sensors</td> <td> </td> <td>array</td> <td>Temperature sensors</td> </tr>
|
||||
<tr><td>slot0</td> <td> </td> <td></td> <td>Network module slot 0</td> </tr>
|
||||
<tr><td>slot1</td> <td> </td> <td></td> <td>Network module slot 1</td> </tr>
|
||||
<tr><td>slot2</td> <td> </td> <td></td> <td>Network module slot 2</td> </tr>
|
||||
<tr><td>slot3</td> <td> </td> <td></td> <td>Network module slot 3</td> </tr>
|
||||
<tr><td>slot4</td> <td> </td> <td></td> <td>Network module slot 4</td> </tr>
|
||||
<tr><td>slot5</td> <td> </td> <td></td> <td>Network module slot 5</td> </tr>
|
||||
<tr><td>slot6</td> <td> </td> <td></td> <td>Network module slot 6</td> </tr>
|
||||
<tr><td>sparsemem</td> <td> </td> <td>boolean</td> <td>sparse memory feature</td> </tr>
|
||||
<tr><td>startup_config</td> <td> </td> <td>string</td> <td>path to the IOS startup configuration file</td> </tr>
|
||||
<tr><td>startup_config_base64</td> <td> </td> <td>string</td> <td>startup configuration base64 encoded</td> </tr>
|
||||
<tr><td>system_id</td> <td> </td> <td>string</td> <td>system ID</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>Dynamips router instance UUID</td> </tr>
|
||||
<tr><td>wic0</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
<tr><td>wic1</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
<tr><td>wic2</td> <td> </td> <td></td> <td>Network module WIC slot 0</td> </tr>
|
||||
</table>
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Delete a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
-40
@@ -1,40 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: NIO created
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Remove a NIO from a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter from where the nio should be removed
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
-32
@@ -1,32 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a packet capture on a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Capture started
|
||||
- **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>capture_file_name</td> <td>✔</td> <td>string</td> <td>Capture file name</td> </tr>
|
||||
<tr><td>data_link_type</td> <td> </td> <td>string</td> <td>PCAP data link type</td> </tr>
|
||||
</table>
|
||||
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a packet capture on a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Capture stopped
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/auto_idlepc
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/auto_idlepc
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Retrieve the idlepc proposals
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Best Idle-pc value found
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/configs
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/configs
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Retrieve the startup and private configs content
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Configs retrieved
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>private_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the private configuration file</td> </tr>
|
||||
<tr><td>startup_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the startup configuration file</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/configs/save
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/configs/save
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Save the startup and private configs content
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Configs saved
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/idlepc_proposals
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/idlepc_proposals
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Retrieve the idlepc proposals
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Idle-PCs retrieved
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/reload
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Reload a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/resume
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/resume
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Resume a suspended Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance resumed
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/start
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance started
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/stop
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/dynamips/vms/{vm_id}/suspend
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/dynamips/vms/**{vm_id}**/suspend
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Suspend a Dynamips VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance suspended
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
File
|
||||
-----------------------------
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
file/*
|
||||
@@ -1,24 +0,0 @@
|
||||
/v2/compute/files/stream
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/files/stream
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stream a file from the server
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: File retrieved
|
||||
- **409**: Can't access to file
|
||||
- **404**: File doesn't exist
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>location</td> <td>✔</td> <td>['string']</td> <td>File path</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
/v2/compute/iou/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/iou/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Retrieve the list of IOU VMS
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: List of IOU VM retrieved
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_get_iouvms.txt
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
/v2/compute/iou/vms/{path}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/iou/vms/**{path}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Upload IOU image.
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Image uploaded
|
||||
|
||||
@@ -1,74 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/iou/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a new IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>ethernet_adapters</td> <td> </td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>iourc_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the iourc file. Ignored if Null</td> </tr>
|
||||
<tr><td>l1_keepalives</td> <td> </td> <td>['boolean', 'null']</td> <td>Always up ethernet interface</td> </tr>
|
||||
<tr><td>md5sum</td> <td> </td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
|
||||
<tr><td>nvram</td> <td> </td> <td>['integer', 'null']</td> <td>Allocated NVRAM KB</td> </tr>
|
||||
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
|
||||
<tr><td>private_config</td> <td> </td> <td>['string', 'null']</td> <td>Path to the private-config of IOU</td> </tr>
|
||||
<tr><td>private_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Private-config of IOU</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>Allocated RAM MB</td> </tr>
|
||||
<tr><td>serial_adapters</td> <td> </td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>startup_config</td> <td> </td> <td>['string', 'null']</td> <td>Path to the startup-config of IOU</td> </tr>
|
||||
<tr><td>startup_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Startup-config of IOU</td> </tr>
|
||||
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td></td> <td>IOU VM identifier</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>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>ethernet_adapters</td> <td>✔</td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>iourc_path</td> <td> </td> <td>['string', 'null']</td> <td>Path of the iourc file used by remote servers</td> </tr>
|
||||
<tr><td>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
|
||||
<tr><td>md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
|
||||
<tr><td>nvram</td> <td>✔</td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
|
||||
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
|
||||
<tr><td>private_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the private-config content relative to project directory</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
|
||||
<tr><td>serial_adapters</td> <td>✔</td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>startup_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the startup-config content relative to project directory</td> </tr>
|
||||
<tr><td>use_default_iou_values</td> <td>✔</td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiouvms.txt
|
||||
|
||||
@@ -1,142 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/vms/{vm_id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Success
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
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>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>ethernet_adapters</td> <td>✔</td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>iourc_path</td> <td> </td> <td>['string', 'null']</td> <td>Path of the iourc file used by remote servers</td> </tr>
|
||||
<tr><td>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
|
||||
<tr><td>md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
|
||||
<tr><td>nvram</td> <td>✔</td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
|
||||
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
|
||||
<tr><td>private_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the private-config content relative to project directory</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
|
||||
<tr><td>serial_adapters</td> <td>✔</td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>startup_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the startup-config content relative to project directory</td> </tr>
|
||||
<tr><td>use_default_iou_values</td> <td>✔</td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_get_projectsprojectidiouvmsvmid.txt
|
||||
|
||||
|
||||
PUT /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Update a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Instance updated
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>ethernet_adapters</td> <td> </td> <td>['integer', 'null']</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>iourc_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the iourc file. Ignored if Null</td> </tr>
|
||||
<tr><td>l1_keepalives</td> <td> </td> <td>['boolean', 'null']</td> <td>Always up ethernet interface</td> </tr>
|
||||
<tr><td>md5sum</td> <td> </td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>IOU VM name</td> </tr>
|
||||
<tr><td>nvram</td> <td> </td> <td>['integer', 'null']</td> <td>Allocated NVRAM KB</td> </tr>
|
||||
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Path of iou binary</td> </tr>
|
||||
<tr><td>private_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Private-config of IOU</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>Allocated RAM MB</td> </tr>
|
||||
<tr><td>serial_adapters</td> <td> </td> <td>['integer', 'null']</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>startup_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Startup-config of IOU</td> </tr>
|
||||
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</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>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>ethernet_adapters</td> <td>✔</td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>iourc_path</td> <td> </td> <td>['string', 'null']</td> <td>Path of the iourc file used by remote servers</td> </tr>
|
||||
<tr><td>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
|
||||
<tr><td>md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
|
||||
<tr><td>nvram</td> <td>✔</td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
|
||||
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
|
||||
<tr><td>private_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the private-config content relative to project directory</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
|
||||
<tr><td>serial_adapters</td> <td>✔</td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>startup_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the startup-config content relative to project directory</td> </tr>
|
||||
<tr><td>use_default_iou_values</td> <td>✔</td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_put_projectsprojectidiouvmsvmid.txt
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Delete a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidiouvmsvmid.txt
|
||||
|
||||
-52
@@ -1,52 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port where the nio should be added
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: NIO created
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Remove a NIO from a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port from where the nio should be removed
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
|
||||
|
||||
-39
@@ -1,39 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a packet capture on a IOU VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Capture started
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **409**: VM not started
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<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>Capture file name</td> </tr>
|
||||
<tr><td>data_link_type</td> <td> </td> <td>string</td> <td>PCAP data link type</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt
|
||||
|
||||
-29
@@ -1,29 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a packet capture on a IOU VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Capture stopped
|
||||
- **409**: VM not started
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/vms/{vm_id}/configs
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**/configs
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Retrieve the startup and private configs content
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Configs retrieved
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>private_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the private configuration file</td> </tr>
|
||||
<tr><td>startup_config_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the startup configuration file</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_get_projectsprojectidiouvmsvmidconfigs.txt
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/vms/{vm_id}/configs/save
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**/configs/save
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Save the startup and private configs content
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Configs saved
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/vms/{vm_id}/reload
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Reload a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiouvmsvmidreload.txt
|
||||
|
||||
@@ -1,60 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/vms/{vm_id}/start
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Instance started
|
||||
- **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>iourc_content</td> <td> </td> <td>['string', 'null']</td> <td>Content of the iourc file. Ignored if Null</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>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>ethernet_adapters</td> <td>✔</td> <td>integer</td> <td>How many ethernet adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>iourc_path</td> <td> </td> <td>['string', 'null']</td> <td>Path of the iourc file used by remote servers</td> </tr>
|
||||
<tr><td>l1_keepalives</td> <td>✔</td> <td>boolean</td> <td>Always up ethernet interface</td> </tr>
|
||||
<tr><td>md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>Checksum of iou binary</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>IOU VM name</td> </tr>
|
||||
<tr><td>nvram</td> <td>✔</td> <td>integer</td> <td>Allocated NVRAM KB</td> </tr>
|
||||
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Path of iou binary</td> </tr>
|
||||
<tr><td>private_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the private-config content relative to project directory</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>Allocated RAM MB</td> </tr>
|
||||
<tr><td>serial_adapters</td> <td>✔</td> <td>integer</td> <td>How many serial adapters are connected to the IOU</td> </tr>
|
||||
<tr><td>startup_config</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the startup-config content relative to project directory</td> </tr>
|
||||
<tr><td>use_default_iou_values</td> <td>✔</td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>IOU VM UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiouvmsvmidstart.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/iou/vms/{vm_id}/stop
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/iou/vms/**{vm_id}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidiouvmsvmidstop.txt
|
||||
|
||||
@@ -1,119 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/qemu/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/qemu/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a new Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>['boolean', 'null']</td> <td>ACPI shutdown support</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>['string', 'null']</td> <td>QEMU adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>boot_priority</td> <td> </td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
|
||||
<tr><td>cdrom_image</td> <td> </td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
|
||||
<tr><td>cdrom_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</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: telnet, vnc</td> </tr>
|
||||
<tr><td>cpu_throttling</td> <td> </td> <td>['integer', 'null']</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
|
||||
<tr><td>cpus</td> <td> </td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
|
||||
<tr><td>hda_disk_image</td> <td> </td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
|
||||
<tr><td>hda_disk_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
|
||||
<tr><td>hda_disk_interface</td> <td> </td> <td>string</td> <td>QEMU hda interface</td> </tr>
|
||||
<tr><td>hdb_disk_image</td> <td> </td> <td>string</td> <td>QEMU hdb disk image path</td> </tr>
|
||||
<tr><td>hdb_disk_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdb disk image checksum</td> </tr>
|
||||
<tr><td>hdb_disk_interface</td> <td> </td> <td>string</td> <td>QEMU hdb interface</td> </tr>
|
||||
<tr><td>hdc_disk_image</td> <td> </td> <td>string</td> <td>QEMU hdc disk image path</td> </tr>
|
||||
<tr><td>hdc_disk_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdc disk image checksum</td> </tr>
|
||||
<tr><td>hdc_disk_interface</td> <td> </td> <td>string</td> <td>QEMU hdc interface</td> </tr>
|
||||
<tr><td>hdd_disk_image</td> <td> </td> <td>string</td> <td>QEMU hdd disk image path</td> </tr>
|
||||
<tr><td>hdd_disk_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdd disk image checksum</td> </tr>
|
||||
<tr><td>hdd_disk_interface</td> <td> </td> <td>string</td> <td>QEMU hdd interface</td> </tr>
|
||||
<tr><td>initrd</td> <td> </td> <td>string</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>initrd_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>kernel_command_line</td> <td> </td> <td>['string', 'null']</td> <td>QEMU kernel command line</td> </tr>
|
||||
<tr><td>kernel_image</td> <td> </td> <td>string</td> <td>QEMU kernel image path</td> </tr>
|
||||
<tr><td>kernel_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU kernel image checksum</td> </tr>
|
||||
<tr><td>legacy_networking</td> <td> </td> <td>['boolean', 'null']</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
|
||||
<tr><td>linked_clone</td> <td> </td> <td>boolean</td> <td>either the VM is a linked clone or not</td> </tr>
|
||||
<tr><td>mac_address</td> <td> </td> <td>['string', 'null']</td> <td>QEMU MAC address</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>QEMU VM instance name</td> </tr>
|
||||
<tr><td>options</td> <td> </td> <td>['string', 'null']</td> <td>Additional QEMU options</td> </tr>
|
||||
<tr><td>platform</td> <td> </td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null</td> </tr>
|
||||
<tr><td>process_priority</td> <td> </td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low, null</td> </tr>
|
||||
<tr><td>qemu_path</td> <td> </td> <td>['string', 'null']</td> <td>Path to QEMU</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>usage</td> <td> </td> <td>string</td> <td>How to use the qemu VM</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td></td> <td>QEMU VM identifier</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td>✔</td> <td>boolean</td> <td>ACPI shutdown support</td> </tr>
|
||||
<tr><td>adapter_type</td> <td>✔</td> <td>string</td> <td>QEMU adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td>✔</td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>boot_priority</td> <td>✔</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
|
||||
<tr><td>cdrom_image</td> <td>✔</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
|
||||
<tr><td>cdrom_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
|
||||
<tr><td>command_line</td> <td>✔</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>cpu_throttling</td> <td>✔</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
|
||||
<tr><td>cpus</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
|
||||
<tr><td>hda_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
|
||||
<tr><td>hda_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
|
||||
<tr><td>hda_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hda interface</td> </tr>
|
||||
<tr><td>hdb_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdb disk image path</td> </tr>
|
||||
<tr><td>hdb_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdb disk image checksum</td> </tr>
|
||||
<tr><td>hdb_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdb interface</td> </tr>
|
||||
<tr><td>hdc_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdc disk image path</td> </tr>
|
||||
<tr><td>hdc_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdc disk image checksum</td> </tr>
|
||||
<tr><td>hdc_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdc interface</td> </tr>
|
||||
<tr><td>hdd_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdd disk image path</td> </tr>
|
||||
<tr><td>hdd_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdd disk image checksum</td> </tr>
|
||||
<tr><td>hdd_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdd interface</td> </tr>
|
||||
<tr><td>initrd</td> <td>✔</td> <td>string</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>initrd_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>kernel_command_line</td> <td>✔</td> <td>string</td> <td>QEMU kernel command line</td> </tr>
|
||||
<tr><td>kernel_image</td> <td>✔</td> <td>string</td> <td>QEMU kernel image path</td> </tr>
|
||||
<tr><td>kernel_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU kernel image checksum</td> </tr>
|
||||
<tr><td>legacy_networking</td> <td>✔</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
|
||||
<tr><td>mac_address</td> <td>✔</td> <td>string</td> <td>QEMU MAC address</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>QEMU VM instance name</td> </tr>
|
||||
<tr><td>options</td> <td>✔</td> <td>string</td> <td>Additional QEMU options</td> </tr>
|
||||
<tr><td>platform</td> <td>✔</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
|
||||
<tr><td>process_priority</td> <td>✔</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project uuid</td> </tr>
|
||||
<tr><td>qemu_path</td> <td>✔</td> <td>string</td> <td>path to QEMU</td> </tr>
|
||||
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>usage</td> <td>✔</td> <td>string</td> <td>How to use the qemu VM</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemuvms.txt
|
||||
|
||||
@@ -1,211 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/qemu/vms/{vm_id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/qemu/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Success
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td>✔</td> <td>boolean</td> <td>ACPI shutdown support</td> </tr>
|
||||
<tr><td>adapter_type</td> <td>✔</td> <td>string</td> <td>QEMU adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td>✔</td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>boot_priority</td> <td>✔</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
|
||||
<tr><td>cdrom_image</td> <td>✔</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
|
||||
<tr><td>cdrom_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
|
||||
<tr><td>command_line</td> <td>✔</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>cpu_throttling</td> <td>✔</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
|
||||
<tr><td>cpus</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
|
||||
<tr><td>hda_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
|
||||
<tr><td>hda_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
|
||||
<tr><td>hda_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hda interface</td> </tr>
|
||||
<tr><td>hdb_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdb disk image path</td> </tr>
|
||||
<tr><td>hdb_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdb disk image checksum</td> </tr>
|
||||
<tr><td>hdb_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdb interface</td> </tr>
|
||||
<tr><td>hdc_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdc disk image path</td> </tr>
|
||||
<tr><td>hdc_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdc disk image checksum</td> </tr>
|
||||
<tr><td>hdc_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdc interface</td> </tr>
|
||||
<tr><td>hdd_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdd disk image path</td> </tr>
|
||||
<tr><td>hdd_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdd disk image checksum</td> </tr>
|
||||
<tr><td>hdd_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdd interface</td> </tr>
|
||||
<tr><td>initrd</td> <td>✔</td> <td>string</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>initrd_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>kernel_command_line</td> <td>✔</td> <td>string</td> <td>QEMU kernel command line</td> </tr>
|
||||
<tr><td>kernel_image</td> <td>✔</td> <td>string</td> <td>QEMU kernel image path</td> </tr>
|
||||
<tr><td>kernel_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU kernel image checksum</td> </tr>
|
||||
<tr><td>legacy_networking</td> <td>✔</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
|
||||
<tr><td>mac_address</td> <td>✔</td> <td>string</td> <td>QEMU MAC address</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>QEMU VM instance name</td> </tr>
|
||||
<tr><td>options</td> <td>✔</td> <td>string</td> <td>Additional QEMU options</td> </tr>
|
||||
<tr><td>platform</td> <td>✔</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
|
||||
<tr><td>process_priority</td> <td>✔</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project uuid</td> </tr>
|
||||
<tr><td>qemu_path</td> <td>✔</td> <td>string</td> <td>path to QEMU</td> </tr>
|
||||
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>usage</td> <td>✔</td> <td>string</td> <td>How to use the qemu VM</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_get_projectsprojectidqemuvmsvmid.txt
|
||||
|
||||
|
||||
PUT /v2/compute/projects/**{project_id}**/qemu/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Update a Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Instance updated
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>['boolean', 'null']</td> <td>ACPI shutdown support</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>['string', 'null']</td> <td>QEMU adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>boot_priority</td> <td> </td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
|
||||
<tr><td>cdrom_image</td> <td> </td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
|
||||
<tr><td>cdrom_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</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: telnet, vnc</td> </tr>
|
||||
<tr><td>cpu_throttling</td> <td> </td> <td>['integer', 'null']</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
|
||||
<tr><td>cpus</td> <td> </td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
|
||||
<tr><td>hda_disk_image</td> <td> </td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
|
||||
<tr><td>hda_disk_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
|
||||
<tr><td>hda_disk_interface</td> <td> </td> <td>string</td> <td>QEMU hda interface</td> </tr>
|
||||
<tr><td>hdb_disk_image</td> <td> </td> <td>string</td> <td>QEMU hdb disk image path</td> </tr>
|
||||
<tr><td>hdb_disk_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdb disk image checksum</td> </tr>
|
||||
<tr><td>hdb_disk_interface</td> <td> </td> <td>string</td> <td>QEMU hdb interface</td> </tr>
|
||||
<tr><td>hdc_disk_image</td> <td> </td> <td>string</td> <td>QEMU hdc disk image path</td> </tr>
|
||||
<tr><td>hdc_disk_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdc disk image checksum</td> </tr>
|
||||
<tr><td>hdc_disk_interface</td> <td> </td> <td>string</td> <td>QEMU hdc interface</td> </tr>
|
||||
<tr><td>hdd_disk_image</td> <td> </td> <td>string</td> <td>QEMU hdd disk image path</td> </tr>
|
||||
<tr><td>hdd_disk_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdd disk image checksum</td> </tr>
|
||||
<tr><td>hdd_disk_interface</td> <td> </td> <td>string</td> <td>QEMU hdd interface</td> </tr>
|
||||
<tr><td>initrd</td> <td> </td> <td>string</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>initrd_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>kernel_command_line</td> <td> </td> <td>['string', 'null']</td> <td>QEMU kernel command line</td> </tr>
|
||||
<tr><td>kernel_image</td> <td> </td> <td>string</td> <td>QEMU kernel image path</td> </tr>
|
||||
<tr><td>kernel_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU kernel image checksum</td> </tr>
|
||||
<tr><td>legacy_networking</td> <td> </td> <td>['boolean', 'null']</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
|
||||
<tr><td>mac_address</td> <td> </td> <td>['string', 'null']</td> <td>QEMU MAC address</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>QEMU VM instance name</td> </tr>
|
||||
<tr><td>options</td> <td> </td> <td>['string', 'null']</td> <td>Additional QEMU options</td> </tr>
|
||||
<tr><td>platform</td> <td> </td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb, null</td> </tr>
|
||||
<tr><td>process_priority</td> <td> </td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low, null</td> </tr>
|
||||
<tr><td>qemu_path</td> <td> </td> <td>['string', 'null']</td> <td>Path to QEMU</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>usage</td> <td> </td> <td>string</td> <td>How to use the qemu VM</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td>✔</td> <td>boolean</td> <td>ACPI shutdown support</td> </tr>
|
||||
<tr><td>adapter_type</td> <td>✔</td> <td>string</td> <td>QEMU adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td>✔</td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>boot_priority</td> <td>✔</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
|
||||
<tr><td>cdrom_image</td> <td>✔</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
|
||||
<tr><td>cdrom_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
|
||||
<tr><td>command_line</td> <td>✔</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>cpu_throttling</td> <td>✔</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
|
||||
<tr><td>cpus</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
|
||||
<tr><td>hda_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
|
||||
<tr><td>hda_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
|
||||
<tr><td>hda_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hda interface</td> </tr>
|
||||
<tr><td>hdb_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdb disk image path</td> </tr>
|
||||
<tr><td>hdb_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdb disk image checksum</td> </tr>
|
||||
<tr><td>hdb_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdb interface</td> </tr>
|
||||
<tr><td>hdc_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdc disk image path</td> </tr>
|
||||
<tr><td>hdc_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdc disk image checksum</td> </tr>
|
||||
<tr><td>hdc_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdc interface</td> </tr>
|
||||
<tr><td>hdd_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdd disk image path</td> </tr>
|
||||
<tr><td>hdd_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdd disk image checksum</td> </tr>
|
||||
<tr><td>hdd_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdd interface</td> </tr>
|
||||
<tr><td>initrd</td> <td>✔</td> <td>string</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>initrd_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>kernel_command_line</td> <td>✔</td> <td>string</td> <td>QEMU kernel command line</td> </tr>
|
||||
<tr><td>kernel_image</td> <td>✔</td> <td>string</td> <td>QEMU kernel image path</td> </tr>
|
||||
<tr><td>kernel_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU kernel image checksum</td> </tr>
|
||||
<tr><td>legacy_networking</td> <td>✔</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
|
||||
<tr><td>mac_address</td> <td>✔</td> <td>string</td> <td>QEMU MAC address</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>QEMU VM instance name</td> </tr>
|
||||
<tr><td>options</td> <td>✔</td> <td>string</td> <td>Additional QEMU options</td> </tr>
|
||||
<tr><td>platform</td> <td>✔</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
|
||||
<tr><td>process_priority</td> <td>✔</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project uuid</td> </tr>
|
||||
<tr><td>qemu_path</td> <td>✔</td> <td>string</td> <td>path to QEMU</td> </tr>
|
||||
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>usage</td> <td>✔</td> <td>string</td> <td>How to use the qemu VM</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_put_projectsprojectidqemuvmsvmid.txt
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/qemu/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Delete a Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidqemuvmsvmid.txt
|
||||
|
||||
-52
@@ -1,52 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/qemu/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/qemu/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: NIO created
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/qemu/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Remove a NIO from a Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/qemu/vms/{vm_id}/reload
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/qemu/vms/**{vm_id}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Reload a Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemuvmsvmidreload.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/qemu/vms/{vm_id}/resume
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/qemu/vms/**{vm_id}**/resume
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Resume a Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance resumed
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemuvmsvmidresume.txt
|
||||
|
||||
@@ -1,74 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/qemu/vms/{vm_id}/start
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/qemu/vms/**{vm_id}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Instance started
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td>✔</td> <td>boolean</td> <td>ACPI shutdown support</td> </tr>
|
||||
<tr><td>adapter_type</td> <td>✔</td> <td>string</td> <td>QEMU adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td>✔</td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>boot_priority</td> <td>✔</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
|
||||
<tr><td>cdrom_image</td> <td>✔</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
|
||||
<tr><td>cdrom_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
|
||||
<tr><td>command_line</td> <td>✔</td> <td>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
|
||||
<tr><td>cpu_throttling</td> <td>✔</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
|
||||
<tr><td>cpus</td> <td>✔</td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
|
||||
<tr><td>hda_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
|
||||
<tr><td>hda_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
|
||||
<tr><td>hda_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hda interface</td> </tr>
|
||||
<tr><td>hdb_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdb disk image path</td> </tr>
|
||||
<tr><td>hdb_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdb disk image checksum</td> </tr>
|
||||
<tr><td>hdb_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdb interface</td> </tr>
|
||||
<tr><td>hdc_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdc disk image path</td> </tr>
|
||||
<tr><td>hdc_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdc disk image checksum</td> </tr>
|
||||
<tr><td>hdc_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdc interface</td> </tr>
|
||||
<tr><td>hdd_disk_image</td> <td>✔</td> <td>string</td> <td>QEMU hdd disk image path</td> </tr>
|
||||
<tr><td>hdd_disk_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU hdd disk image checksum</td> </tr>
|
||||
<tr><td>hdd_disk_interface</td> <td>✔</td> <td>string</td> <td>QEMU hdd interface</td> </tr>
|
||||
<tr><td>initrd</td> <td>✔</td> <td>string</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>initrd_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU initrd path</td> </tr>
|
||||
<tr><td>kernel_command_line</td> <td>✔</td> <td>string</td> <td>QEMU kernel command line</td> </tr>
|
||||
<tr><td>kernel_image</td> <td>✔</td> <td>string</td> <td>QEMU kernel image path</td> </tr>
|
||||
<tr><td>kernel_image_md5sum</td> <td>✔</td> <td>['string', 'null']</td> <td>QEMU kernel image checksum</td> </tr>
|
||||
<tr><td>legacy_networking</td> <td>✔</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
|
||||
<tr><td>mac_address</td> <td>✔</td> <td>string</td> <td>QEMU MAC address</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>QEMU VM instance name</td> </tr>
|
||||
<tr><td>options</td> <td>✔</td> <td>string</td> <td>Additional QEMU options</td> </tr>
|
||||
<tr><td>platform</td> <td>✔</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
|
||||
<tr><td>process_priority</td> <td>✔</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project uuid</td> </tr>
|
||||
<tr><td>qemu_path</td> <td>✔</td> <td>string</td> <td>path to QEMU</td> </tr>
|
||||
<tr><td>ram</td> <td>✔</td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
|
||||
<tr><td>usage</td> <td>✔</td> <td>string</td> <td>How to use the qemu VM</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemuvmsvmidstart.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/qemu/vms/{vm_id}/stop
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/qemu/vms/**{vm_id}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemuvmsvmidstop.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/qemu/vms/{vm_id}/suspend
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/qemu/vms/**{vm_id}**/suspend
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Suspend a Qemu VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance suspended
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemuvmsvmidsuspend.txt
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
/v2/compute/qemu/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/qemu/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Retrieve the list of Qemu images
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: List of Qemu images retrieved
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
/v2/compute/qemu/vms/{path:.+}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/qemu/vms/**{path:.+}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Upload Qemu image.
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **204**: Image uploaded
|
||||
|
||||
@@ -1,66 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/virtualbox/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/virtualbox/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a new VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
||||
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
||||
<tr><td>linked_clone</td> <td>✔</td> <td>boolean</td> <td>either the VM is a linked clone or not</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
|
||||
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td></td> <td>VirtualBox VM instance identifier</td> </tr>
|
||||
<tr><td>vmname</td> <td>✔</td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
||||
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
|
||||
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>['string', 'null']</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
|
||||
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvirtualboxvms.txt
|
||||
|
||||
@@ -1,125 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/virtualbox/vms/{vm_id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Success
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
||||
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
|
||||
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>['string', 'null']</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
|
||||
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_get_projectsprojectidvirtualboxvmsvmid.txt
|
||||
|
||||
|
||||
PUT /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Update a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Instance updated
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
||||
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
|
||||
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
|
||||
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
||||
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
|
||||
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
|
||||
<tr><td>vm_directory</td> <td>✔</td> <td>['string', 'null']</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
|
||||
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_put_projectsprojectidvirtualboxvmsvmid.txt
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Delete a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
-52
@@ -1,52 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: NIO created
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Remove a NIO from a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter from where the nio should be removed
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt
|
||||
|
||||
-32
@@ -1,32 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a packet capture on a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Capture started
|
||||
- **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>capture_file_name</td> <td>✔</td> <td>string</td> <td>Capture file name</td> </tr>
|
||||
<tr><td>data_link_type</td> <td> </td> <td>string</td> <td>PCAP data link type</td> </tr>
|
||||
</table>
|
||||
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/virtualbox/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a packet capture on a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Capture stopped
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/virtualbox/vms/{vm_id}/reload
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Reload a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvirtualboxvmsvmidreload.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/virtualbox/vms/{vm_id}/resume
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/resume
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Resume a suspended VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance resumed
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvirtualboxvmsvmidresume.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/virtualbox/vms/{vm_id}/start
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance started
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvirtualboxvmsvmidstart.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/virtualbox/vms/{vm_id}/stop
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvirtualboxvmsvmidstop.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/virtualbox/vms/{vm_id}/suspend
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/virtualbox/vms/**{vm_id}**/suspend
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Suspend a VirtualBox VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance suspended
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvirtualboxvmsvmidsuspend.txt
|
||||
|
||||
@@ -1,60 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vmware/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a new VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VMware adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
||||
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
||||
<tr><td>linked_clone</td> <td>✔</td> <td>boolean</td> <td>either the VM is a linked clone or not</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VMware VM instance name</td> </tr>
|
||||
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VMware adapter</td> </tr>
|
||||
<tr><td>use_ubridge</td> <td> </td> <td>boolean</td> <td>use uBridge for network connections</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>VMware VM instance identifier</td> </tr>
|
||||
<tr><td>vmx_path</td> <td>✔</td> <td>string</td> <td>path to the vmx file</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VMware adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
||||
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VMware VM instance name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VMware adapter</td> </tr>
|
||||
<tr><td>use_ubridge</td> <td> </td> <td>boolean</td> <td>use uBridge for network connections</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>['string', 'null']</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VMware VM instance UUID</td> </tr>
|
||||
<tr><td>vmx_path</td> <td> </td> <td>string</td> <td>path to the vmx file</td> </tr>
|
||||
</table>
|
||||
|
||||
@@ -1,113 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms/{vm_id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Success
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VMware adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
||||
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VMware VM instance name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VMware adapter</td> </tr>
|
||||
<tr><td>use_ubridge</td> <td> </td> <td>boolean</td> <td>use uBridge for network connections</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>['string', 'null']</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VMware VM instance UUID</td> </tr>
|
||||
<tr><td>vmx_path</td> <td> </td> <td>string</td> <td>path to the vmx file</td> </tr>
|
||||
</table>
|
||||
|
||||
|
||||
PUT /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Update a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Instance updated
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VMware adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
||||
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>string</td> <td>VMware VM instance name</td> </tr>
|
||||
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VMware adapter</td> </tr>
|
||||
<tr><td>use_ubridge</td> <td> </td> <td>boolean</td> <td>use uBridge for network connections</td> </tr>
|
||||
<tr><td>vmx_path</td> <td> </td> <td>string</td> <td>path to the vmx file</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VMware adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
|
||||
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VMware VM instance name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VMware adapter</td> </tr>
|
||||
<tr><td>use_ubridge</td> <td> </td> <td>boolean</td> <td>use uBridge for network connections</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>['string', 'null']</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VMware VM instance UUID</td> </tr>
|
||||
<tr><td>vmx_path</td> <td> </td> <td>string</td> <td>path to the vmx file</td> </tr>
|
||||
</table>
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Delete a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
-40
@@ -1,40 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter where the nio should be added
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: NIO created
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Remove a NIO from a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter from where the nio should be removed
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
-32
@@ -1,32 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a packet capture on a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to start a packet capture
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Capture started
|
||||
- **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>capture_file_name</td> <td>✔</td> <td>string</td> <td>Capture file name</td> </tr>
|
||||
<tr><td>data_link_type</td> <td> </td> <td>string</td> <td>PCAP data link type</td> </tr>
|
||||
</table>
|
||||
|
||||
-22
@@ -1,22 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a packet capture on a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Adapter to stop a packet capture
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Capture stopped
|
||||
|
||||
@@ -1,18 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms/{vm_id}/interfaces/vmnet
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**/interfaces/vmnet
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Allocate a VMware VMnet interface on the server
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: The UUID of the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: VMnet interface allocated
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms/{vm_id}/reload
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Reload a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms/{vm_id}/resume
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**/resume
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Resume a suspended VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance resumed
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms/{vm_id}/start
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance started
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms/{vm_id}/stop
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vmware/vms/{vm_id}/suspend
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vmware/vms/**{vm_id}**/suspend
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Suspend a VMware VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance suspended
|
||||
|
||||
@@ -1,56 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vpcs/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vpcs/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a new VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </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: telnet</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VPCS VM name</td> </tr>
|
||||
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td></td> <td>VPCS VM identifier</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>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VPCS VM name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
|
||||
<tr><td>startup_script_path</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</td> </tr>
|
||||
<tr><td>status</td> <td>✔</td> <td>enum</td> <td>Possible values: started, stopped</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VPCS VM UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvpcsvms.txt
|
||||
|
||||
@@ -1,119 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vpcs/vms/{vm_id}
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v2/compute/projects/**{project_id}**/vpcs/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get a VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Success
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
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>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VPCS VM name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
|
||||
<tr><td>startup_script_path</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</td> </tr>
|
||||
<tr><td>status</td> <td>✔</td> <td>enum</td> <td>Possible values: started, stopped</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VPCS VM UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_get_projectsprojectidvpcsvmsvmid.txt
|
||||
|
||||
|
||||
PUT /v2/compute/projects/**{project_id}**/vpcs/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Update a VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Instance updated
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **409**: Conflict
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </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: telnet</td> </tr>
|
||||
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>VPCS VM name</td> </tr>
|
||||
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</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>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VPCS VM name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
|
||||
<tr><td>startup_script_path</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</td> </tr>
|
||||
<tr><td>status</td> <td>✔</td> <td>enum</td> <td>Possible values: started, stopped</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VPCS VM UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_put_projectsprojectidvpcsvmsvmid.txt
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/vpcs/vms/**{vm_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Delete a VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidvpcsvmsvmid.txt
|
||||
|
||||
-52
@@ -1,52 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vpcs/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Add a NIO to a VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port where the nio should be added
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: NIO created
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/vpcs/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Remove a NIO from a VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **adapter_number**: Network adapter where the nio is located
|
||||
- **vm_id**: UUID for the instance
|
||||
- **port_number**: Port from where the nio should be removed
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vpcs/vms/{vm_id}/reload
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vpcs/vms/**{vm_id}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Reload a VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance reloaded
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvpcsvmsvmidreload.txt
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vpcs/vms/{vm_id}/start
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vpcs/vms/**{vm_id}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance 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>string</td> <td>Last command line used by GNS3 to start QEMU</td> </tr>
|
||||
<tr><td>console</td> <td>✔</td> <td>integer</td> <td>console TCP port</td> </tr>
|
||||
<tr><td>console_type</td> <td>✔</td> <td>enum</td> <td>Possible values: telnet</td> </tr>
|
||||
<tr><td>name</td> <td>✔</td> <td>string</td> <td>VPCS VM name</td> </tr>
|
||||
<tr><td>project_id</td> <td>✔</td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
<tr><td>startup_script</td> <td> </td> <td>['string', 'null']</td> <td>Content of the VPCS startup script</td> </tr>
|
||||
<tr><td>startup_script_path</td> <td>✔</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</td> </tr>
|
||||
<tr><td>status</td> <td>✔</td> <td>enum</td> <td>Possible values: started, stopped</td> </tr>
|
||||
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
|
||||
<tr><td>vm_id</td> <td>✔</td> <td>string</td> <td>VPCS VM UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvpcsvmsvmidstart.txt
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
/v2/compute/projects/{project_id}/vpcs/vms/{vm_id}/stop
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/compute/projects/**{project_id}**/vpcs/vms/**{vm_id}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Stop a VPCS instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the instance
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Instance stopped
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_post_projectsprojectidvpcsvmsvmidstop.txt
|
||||
|
||||
@@ -26,7 +26,7 @@ Input
|
||||
<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>vms</td> <td>✔</td> <td>array</td> <td>List of the VMS</td> </tr>
|
||||
<tr><td>nodes</td> <td>✔</td> <td>array</td> <td>List of the VMS</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
@@ -39,7 +39,7 @@ Output
|
||||
<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>vms</td> <td>✔</td> <td>array</td> <td>List of the VMS</td> </tr>
|
||||
<tr><td>nodes</td> <td>✔</td> <td>array</td> <td>List of the VMS</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
|
||||
@@ -9,8 +9,8 @@ Delete a link instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
- **link_id**: UUID of the link
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
|
||||
@@ -51,3 +51,9 @@ Response status codes
|
||||
**********************
|
||||
- **200**: List of projects
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_get_projects.txt
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
Vm
|
||||
-----------------------------
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
vm/*
|
||||
@@ -1,56 +0,0 @@
|
||||
/v2/projects/{project_id}/vms
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/projects/**{project_id}**/vms
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a new VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
|
||||
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>Hypervisor 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>name</td> <td>✔</td> <td>string</td> <td>VM name</td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
|
||||
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>VM identifier</td> </tr>
|
||||
<tr><td>vm_type</td> <td>✔</td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</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>Hypervisor 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>name</td> <td>✔</td> <td>string</td> <td>VM name</td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
|
||||
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>VM identifier</td> </tr>
|
||||
<tr><td>vm_type</td> <td>✔</td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidvms.txt
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
/v2/projects/{project_id}/vms/{vm_id}/reload
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/projects/**{project_id}**/vms/**{vm_id}**/reload
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Reload a VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the VM
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
|
||||
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>Hypervisor 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>name</td> <td>✔</td> <td>string</td> <td>VM name</td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
|
||||
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>VM identifier</td> </tr>
|
||||
<tr><td>vm_type</td> <td>✔</td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidvmsvmidreload.txt
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
/v2/projects/{project_id}/vms/{vm_id}/start
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/projects/**{project_id}**/vms/**{vm_id}**/start
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the VM
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
|
||||
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>Hypervisor 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>name</td> <td>✔</td> <td>string</td> <td>VM name</td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
|
||||
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>VM identifier</td> </tr>
|
||||
<tr><td>vm_type</td> <td>✔</td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidvmsvmidstart.txt
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
/v2/projects/{project_id}/vms/{vm_id}/stop
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/projects/**{project_id}**/vms/**{vm_id}**/stop
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the VM
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
|
||||
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>Hypervisor 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>name</td> <td>✔</td> <td>string</td> <td>VM name</td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
|
||||
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>VM identifier</td> </tr>
|
||||
<tr><td>vm_type</td> <td>✔</td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidvmsvmidstop.txt
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
/v2/projects/{project_id}/vms/{vm_id}/suspend
|
||||
------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v2/projects/**{project_id}**/vms/**{vm_id}**/suspend
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Start a VM instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **vm_id**: UUID for the VM
|
||||
- **project_id**: UUID for the project
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Instance created
|
||||
|
||||
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>Hypervisor 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>name</td> <td>✔</td> <td>string</td> <td>VM name</td> </tr>
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
|
||||
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>VM identifier</td> </tr>
|
||||
<tr><td>vm_type</td> <td>✔</td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidvmsvmidsuspend.txt
|
||||
|
||||
Reference in new issue
Block a user