mirror of https://github.com/GNS3/gns3-server
parent
504a4af4ab
commit
d979f08c93
@ -1,47 +1,55 @@
|
||||
curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7b21f651-636f-40e3-9556-631b64ce6a0f'
|
||||
curl -i -X GET 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/a5c7b71e-03a5-4fe8-a7c5-ec5bd6e60a62'
|
||||
|
||||
GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7b21f651-636f-40e3-9556-631b64ce6a0f HTTP/1.1
|
||||
GET /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/a5c7b71e-03a5-4fe8-a7c5-ec5bd6e60a62 HTTP/1.1
|
||||
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
ACCESS-CONTROL-ALLOW-ORIGIN: *
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 1108
|
||||
CONTENT-LENGTH: 1336
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.4.0dev3
|
||||
SERVER: Python/3.4 GNS3/1.4.0.dev9
|
||||
X-ROUTE: /v1/projects/{project_id}/qemu/vms/{vm_id}
|
||||
|
||||
{
|
||||
"acpi_shutdown": false,
|
||||
"adapter_type": "e1000",
|
||||
"adapters": 1,
|
||||
"boot_priority": "c",
|
||||
"cdrom_image": "",
|
||||
"cdrom_image_md5sum": null,
|
||||
"console": 2000,
|
||||
"console_type": "telnet",
|
||||
"cpu_throttling": 0,
|
||||
"cpus": 1,
|
||||
"hda_disk_image": "",
|
||||
"hda_disk_image_md5sum": null,
|
||||
"hda_disk_interface": "ide",
|
||||
"hdb_disk_image": "",
|
||||
"hdb_disk_image_md5sum": null,
|
||||
"hdb_disk_interface": "ide",
|
||||
"hdc_disk_image": "",
|
||||
"hdc_disk_image_md5sum": null,
|
||||
"hdc_disk_interface": "ide",
|
||||
"hdd_disk_image": "",
|
||||
"hdd_disk_image_md5sum": null,
|
||||
"hdd_disk_interface": "ide",
|
||||
"initrd": "",
|
||||
"initrd_md5sum": null,
|
||||
"kernel_command_line": "",
|
||||
"kernel_image": "",
|
||||
"kernel_image_md5sum": null,
|
||||
"legacy_networking": false,
|
||||
"mac_address": "00:00:ab:6a:0f:00",
|
||||
"mac_address": "00:00:ab:0a:62:00",
|
||||
"name": "PC TEST 1",
|
||||
"options": "",
|
||||
"platform": "x86_64",
|
||||
"process_priority": "low",
|
||||
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
|
||||
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmprq6c6gsq/qemu-system-x86_64",
|
||||
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp3zzynydr/qemu-system-x86_64",
|
||||
"ram": 256,
|
||||
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpjtnbwbkt/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/7b21f651-636f-40e3-9556-631b64ce6a0f",
|
||||
"vm_id": "7b21f651-636f-40e3-9556-631b64ce6a0f"
|
||||
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpbbmb6tc1/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/a5c7b71e-03a5-4fe8-a7c5-ec5bd6e60a62",
|
||||
"vm_id": "a5c7b71e-03a5-4fe8-a7c5-ec5bd6e60a62"
|
||||
}
|
||||
|
@ -0,0 +1,23 @@
|
||||
curl -i -X POST 'http://localhost:8000/v1/qemu/img' -d '{"cluster_size": 64, "format": "qcow2", "lazy_refcounts": "off", "path": "/tmp/hda.qcow2", "preallocation": "metadata", "qemu_img": "/tmp/qemu-img", "refcount_bits": 12, "size": 100}'
|
||||
|
||||
POST /v1/qemu/img HTTP/1.1
|
||||
{
|
||||
"cluster_size": 64,
|
||||
"format": "qcow2",
|
||||
"lazy_refcounts": "off",
|
||||
"path": "/tmp/hda.qcow2",
|
||||
"preallocation": "metadata",
|
||||
"qemu_img": "/tmp/qemu-img",
|
||||
"refcount_bits": 12,
|
||||
"size": 100
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 201
|
||||
ACCESS-CONTROL-ALLOW-ORIGIN: *
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 0
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.4.0.dev9
|
||||
X-ROUTE: /v1/qemu/img
|
||||
|
@ -1,20 +1,20 @@
|
||||
curl -i -X POST 'http://localhost:8000/v1/version' -d '{"version": "1.4.0dev3"}'
|
||||
curl -i -X POST 'http://localhost:8000/v1/version' -d '{"version": "1.4.0.dev9"}'
|
||||
|
||||
POST /v1/version HTTP/1.1
|
||||
{
|
||||
"version": "1.4.0dev3"
|
||||
"version": "1.4.0.dev9"
|
||||
}
|
||||
|
||||
|
||||
HTTP/1.1 200
|
||||
ACCESS-CONTROL-ALLOW-ORIGIN: *
|
||||
CONNECTION: keep-alive
|
||||
CONTENT-LENGTH: 30
|
||||
CONTENT-LENGTH: 31
|
||||
CONTENT-TYPE: application/json
|
||||
DATE: Thu, 08 Jan 2015 16:09:15 GMT
|
||||
SERVER: Python/3.4 GNS3/1.4.0dev3
|
||||
SERVER: Python/3.4 GNS3/1.4.0.dev9
|
||||
X-ROUTE: /v1/version
|
||||
|
||||
{
|
||||
"version": "1.4.0dev3"
|
||||
"version": "1.4.0.dev9"
|
||||
}
|
||||
|
@ -0,0 +1,8 @@
|
||||
Docker
|
||||
---------------------
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
docker/*
|
@ -0,0 +1,13 @@
|
||||
/v1/docker/images
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
GET /v1/docker/images
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Get all available Docker images
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **200**: Success
|
||||
|
@ -0,0 +1,49 @@
|
||||
/v1/projects/{project_id}/docker/images
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/projects/**{project_id}**/docker/images
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
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>adapter_type</td> <td> </td> <td>string</td> <td>Docker 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>string</td> <td>console name</td> </tr>
|
||||
<tr><td>imagename</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>startcmd</td> <td> </td> <td>string</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td></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>adapter_type</td> <td> </td> <td>string</td> <td>Docker adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>cid</td> <td> </td> <td>string</td> <td>Docker container ID</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>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
@ -0,0 +1,20 @@
|
||||
/v1/projects/{project_id}/docker/images/{id}
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
DELETE /v1/projects/**{project_id}**/docker/images/**{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
|
||||
|
@ -0,0 +1,40 @@
|
||||
/v1/projects/{project_id}/docker/images/{id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/projects/**{project_id}**/docker/images/**{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
|
||||
- **project_id**: UUID for the project
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: NIO created
|
||||
- **404**: Instance doesn't exist
|
||||
|
||||
|
||||
DELETE /v1/projects/**{project_id}**/docker/images/**{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
|
||||
- **project_id**: UUID for the project
|
||||
- **port_number**: Port on the adapter
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: NIO deleted
|
||||
|
@ -0,0 +1,50 @@
|
||||
/v1/projects/{project_id}/docker/images/{id}/reload
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/projects/**{project_id}**/docker/images/**{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>adapter_type</td> <td> </td> <td>string</td> <td>Docker 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>string</td> <td>console name</td> </tr>
|
||||
<tr><td>imagename</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>startcmd</td> <td> </td> <td>string</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td></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>adapter_type</td> <td> </td> <td>string</td> <td>Docker adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>cid</td> <td> </td> <td>string</td> <td>Docker container ID</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>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
@ -0,0 +1,50 @@
|
||||
/v1/projects/{project_id}/docker/images/{id}/start
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/projects/**{project_id}**/docker/images/**{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>adapter_type</td> <td> </td> <td>string</td> <td>Docker 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>string</td> <td>console name</td> </tr>
|
||||
<tr><td>imagename</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>startcmd</td> <td> </td> <td>string</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td></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>adapter_type</td> <td> </td> <td>string</td> <td>Docker adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>cid</td> <td> </td> <td>string</td> <td>Docker container ID</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>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
@ -0,0 +1,50 @@
|
||||
/v1/projects/{project_id}/docker/images/{id}/stop
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/projects/**{project_id}**/docker/images/**{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>adapter_type</td> <td> </td> <td>string</td> <td>Docker 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>string</td> <td>console name</td> </tr>
|
||||
<tr><td>imagename</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>startcmd</td> <td> </td> <td>string</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td></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>adapter_type</td> <td> </td> <td>string</td> <td>Docker adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>cid</td> <td> </td> <td>string</td> <td>Docker container ID</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>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
@ -0,0 +1,50 @@
|
||||
/v1/projects/{project_id}/docker/images/{id}/suspend
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/projects/**{project_id}**/docker/images/**{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>adapter_type</td> <td> </td> <td>string</td> <td>Docker 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>string</td> <td>console name</td> </tr>
|
||||
<tr><td>imagename</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>startcmd</td> <td> </td> <td>string</td> <td>Docker CMD entry</td> </tr>
|
||||
<tr><td>vm_id</td> <td> </td> <td></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>adapter_type</td> <td> </td> <td>string</td> <td>Docker adapter type</td> </tr>
|
||||
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
|
||||
<tr><td>cid</td> <td> </td> <td>string</td> <td>Docker container ID</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>vm_id</td> <td>✔</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
|
||||
</table>
|
||||
|
@ -1,9 +1,9 @@
|
||||
/v1/dynamips/vms/{filename}
|
||||
/v1/dynamips/vms/{path}
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/dynamips/vms/**{filename}**
|
||||
POST /v1/dynamips/vms/**{path}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Upload Dynamips image.
|
||||
|
@ -1,9 +1,9 @@
|
||||
/v1/iou/vms/{filename}
|
||||
/v1/iou/vms/{path}
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/iou/vms/**{filename}**
|
||||
POST /v1/iou/vms/**{path}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Upload IOU image.
|
||||
|
@ -0,0 +1,39 @@
|
||||
/v1/qemu/img
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/qemu/img
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Create a Qemu image
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: Image created
|
||||
|
||||
Input
|
||||
*******
|
||||
.. raw:: html
|
||||
|
||||
<table>
|
||||
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
|
||||
<tr><td>adapter_type</td> <td> </td> <td>enum</td> <td>Possible values: ide, lsilogic, buslogic, legacyESX</td> </tr>
|
||||
<tr><td>cluster_size</td> <td> </td> <td>integer</td> <td></td> </tr>
|
||||
<tr><td>format</td> <td>✔</td> <td>enum</td> <td>Possible values: qcow2, qcow, vpc, vdi, vmdk, raw</td> </tr>
|
||||
<tr><td>lazy_refcounts</td> <td> </td> <td>enum</td> <td>Possible values: on, off</td> </tr>
|
||||
<tr><td>path</td> <td>✔</td> <td>string</td> <td>Absolute or relative path of the image</td> </tr>
|
||||
<tr><td>preallocation</td> <td> </td> <td>enum</td> <td>Possible values: off, metadata, falloc, full</td> </tr>
|
||||
<tr><td>qemu_img</td> <td>✔</td> <td>string</td> <td>Path to the qemu-img binary</td> </tr>
|
||||
<tr><td>refcount_bits</td> <td> </td> <td>integer</td> <td></td> </tr>
|
||||
<tr><td>size</td> <td>✔</td> <td>integer</td> <td>Image size in M</td> </tr>
|
||||
<tr><td>static</td> <td> </td> <td>enum</td> <td>Possible values: on, off</td> </tr>
|
||||
<tr><td>subformat</td> <td> </td> <td>enum</td> <td>Possible values: dynamic, fixed, streamOptimized, twoGbMaxExtentSparse, twoGbMaxExtentFlat, monolithicSparse, monolithicFlat</td> </tr>
|
||||
<tr><td>zeroed_grain</td> <td> </td> <td>enum</td> <td>Possible values: on, off</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../examples/post_qemuimg.txt
|
||||
|
@ -1,9 +1,9 @@
|
||||
/v1/qemu/vms/{filename}
|
||||
/v1/qemu/vms/{path:.+}
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/qemu/vms/**{filename}**
|
||||
POST /v1/qemu/vms/**{path:.+}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Upload Qemu image.
|
||||
|
@ -0,0 +1,31 @@
|
||||
/v1/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/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
|
||||
- **project_id**: UUID for the project
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **vm_id**: UUID for the instance
|
||||
|
||||
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>
|
||||
</table>
|
||||
|
@ -0,0 +1,22 @@
|
||||
/v1/projects/{project_id}/vmware/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/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
|
||||
- **project_id**: UUID for the project
|
||||
- **port_number**: Port on the adapter (always 0)
|
||||
- **vm_id**: UUID for the instance
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **404**: Instance doesn't exist
|
||||
- **204**: Capture stopped
|
||||
|
@ -0,0 +1,18 @@
|
||||
/v1/projects/{project_id}/vmware/vms/{vm_id}/interfaces/vmnet
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
.. contents::
|
||||
|
||||
POST /v1/projects/**{project_id}**/vmware/vms/**{vm_id}**/interfaces/vmnet
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Allocate a VMware VMnet interface on the server
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **project_id**: The UUID of the project
|
||||
- **vm_id**: UUID for the instance
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **201**: VMnet interface allocated
|
||||
|
Loading…
Reference in new issue