Build doc support controller

This commit is contained in:
Julien Duponchelle committed 2016-03-04 17:50:17 +01:00
1 parent 0921df520c
commit e4b12f49d1
194 files changed
+1259 -724

No files matched your search

@@ -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,56 @@
/v1/projects/{project_id}/docker/vms
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/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_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>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</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>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>
@@ -0,0 +1,20 @@
/v1/projects/{project_id}/docker/vms/{id}
----------------------------------------------------------------------------------------------------------------------
.. contents::
DELETE /v1/projects/**{project_id}**/docker/vms/**{id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a Docker container
Parameters
**********
- **project_id**: UUID for the project
- **id**: ID for the container
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
@@ -0,0 +1,57 @@
/v1/projects/{project_id}/docker/vms/{id}/reload
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/projects/**{project_id}**/docker/vms/**{id}**/reload
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Restart a Docker container
Parameters
**********
- **project_id**: UUID of the project
- **id**: ID of the container
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_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>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</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>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>
@@ -0,0 +1,57 @@
/v1/projects/{project_id}/docker/vms/{id}/start
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/projects/**{project_id}**/docker/vms/**{id}**/start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a Docker container
Parameters
**********
- **project_id**: UUID of the project
- **id**: ID of the container
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_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>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</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>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>
@@ -0,0 +1,57 @@
/v1/projects/{project_id}/docker/vms/{id}/stop
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/projects/**{project_id}**/docker/vms/**{id}**/stop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop a Docker container
Parameters
**********
- **project_id**: UUID of the project
- **id**: ID of the container
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_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>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</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>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>
@@ -0,0 +1,57 @@
/v1/projects/{project_id}/docker/vms/{id}/suspend
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/projects/**{project_id}**/docker/vms/**{id}**/suspend
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Pause a Docker container
Parameters
**********
- **project_id**: UUID of the project
- **id**: ID of the container
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_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>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</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>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>
@@ -0,0 +1,62 @@
/v1/projects/{project_id}/docker/vms/{vm_id}
----------------------------------------------------------------------------------------------------------------------
.. contents::
PUT /v1/projects/**{project_id}**/docker/vms/**{vm_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a Docker instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
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_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>&#10004;</td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>aux</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>auxilary TCP port</td> </tr>
<tr><td>console</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
<tr><td>console_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: telnet, vnc</td> </tr>
<tr><td>container_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container ID</td> </tr>
<tr><td>environment</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker environment</td> </tr>
<tr><td>image</td> <td>&#10004;</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>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>start_command</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Docker CMD entry</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>Docker container instance UUID</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/put_projectsprojectiddockervmsvmid.txt
@@ -0,0 +1,52 @@
/v1/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/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
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **id**: ID of the container
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v1/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
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **id**: ID of the container
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
.. literalinclude:: ../../../examples/delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt
@@ -0,0 +1,39 @@
/v1/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/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
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter
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>&#10004;</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/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt
@@ -0,0 +1,29 @@
/v1/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/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
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
- **409**: VM not started
Sample session
***************
.. literalinclude:: ../../../examples/post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt