Fix tests and build documentation

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst

@@ -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
 **********************
@@ -95,8 +95,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
 **********************

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst

@@ -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
+- **port_number**: Port on the device
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -128,9 +128,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
+- **port_number**: Port on the device
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst

@@ -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
+- **port_number**: Port on the device
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst

@@ -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
+- **port_number**: Port on the device
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/dynamipsvms.rst

@@ -0,0 +1,13 @@
+/v1/dynamips/vms
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/dynamips/vms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieve the list of Dynamips VMS
+
+Response status codes
+**********************
+- **200**: List of Dynamips VM retrieved
+

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst

@@ -9,8 +9,8 @@ Get a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -74,8 +74,8 @@ Update a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -110,7 +110,6 @@ Input
     <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>
@@ -123,7 +122,6 @@ Input
     <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>
@@ -188,8 +186,8 @@ Delete a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -9,10 +9,10 @@ Add a NIO to a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Adapter where the nio should be added
 - **port_number**: Port on the adapter
 - **vm_id**: UUID for the instance
+- **adapter_number**: Adapter where the nio should be added
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -27,10 +27,10 @@ Remove a NIO from a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Adapter from where the nio should be removed
 - **port_number**: Port on the adapter
 - **vm_id**: UUID for the instance
+- **adapter_number**: Adapter from where the nio should be removed
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

@@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Adapter to start a packet capture
 - **port_number**: Port on the adapter
 - **vm_id**: UUID for the instance
+- **adapter_number**: Adapter to start a packet capture
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

@@ -9,10 +9,10 @@ Stop a packet capture on a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Adapter to stop a packet capture
 - **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
+- **adapter_number**: Adapter to stop a packet capture
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst

@@ -9,8 +9,8 @@ Reload a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst

@@ -9,8 +9,8 @@ Resume a suspended Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst

@@ -9,8 +9,8 @@ Start a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst

@@ -9,8 +9,8 @@ Stop a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst

@@ -9,8 +9,8 @@ Suspend a Dynamips VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/file.rst

@@ -0,0 +1,8 @@
+File
+---------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   file/*

docs/api/v1/file/filesstream.rst

@@ -0,0 +1,24 @@
+/v1/files/stream
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/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>&#10004;</td>                     <td>['string']</td>                     <td>File path</td>                     </tr>
+    </table>
+

docs/api/v1/iou/iouvms.rst

@@ -0,0 +1,13 @@
+/v1/iou/vms
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/iou/vms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieve the list of IOU VMS
+
+Response status codes
+**********************
+- **200**: List of IOU VM retrieved
+

docs/api/v1/iou/projectsprojectidiouvms.rst

@@ -25,7 +25,8 @@ Input
     <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>initial_config_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Initial configuration of the IOU</td>                     </tr>
+    <tr><td>initial_config</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Path to the initial configuration of IOU</td>                     </tr>
+    <tr><td>initial_config_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Initial configuration of IOU</td>                     </tr>
     <tr><td>iourc_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the iourc file, if a file exist on servers this variable is ignored. It's mostly for compatibility with < 1.3 releases</td>                     </tr>
     <tr><td>l1_keepalives</td>                    <td> </td>                     <td>['boolean', 'null']</td>                     <td>Always up ethernet interface</td>                     </tr>
     <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM name</td>                     </tr>

docs/api/v1/iou/projectsprojectidiouvmsvmid.rst

@@ -9,8 +9,8 @@ Get a IOU instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -52,8 +52,8 @@ Update a IOU instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -70,7 +70,7 @@ Input
     <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>initial_config_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Initial configuration of the IOU</td>                     </tr>
+    <tr><td>initial_config_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Initial configuration of IOU</td>                     </tr>
     <tr><td>iourc_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the iourc file, if a file exist on servers this variable is ignored. It's mostly for compatibility with < 1.3 releases</td>                     </tr>
     <tr><td>l1_keepalives</td>                    <td> </td>                     <td>['boolean', 'null']</td>                     <td>Always up ethernet interface</td>                     </tr>
     <tr><td>name</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>IOU VM name</td>                     </tr>
@@ -115,8 +115,8 @@ Delete a IOU instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -9,10 +9,10 @@ Add a NIO to a IOU instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Network adapter where the nio is located
 - **port_number**: Port where the nio should be added
 - **vm_id**: UUID for the instance
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -33,10 +33,10 @@ Remove a NIO from a IOU instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Network adapter where the nio is located
 - **port_number**: Port from where the nio should be removed
 - **vm_id**: UUID for the instance
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

@@ -9,10 +9,10 @@ Start a packet capture on a IOU VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Adapter to start a packet capture
 - **port_number**: Port on the adapter
 - **vm_id**: UUID for the instance
+- **adapter_number**: Adapter to start a packet capture
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

@@ -9,10 +9,10 @@ Stop a packet capture on a IOU VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Adapter to stop a packet capture
 - **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
+- **adapter_number**: Adapter to stop a packet capture
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/iou/projectsprojectidiouvmsvmidreload.rst

@@ -9,8 +9,8 @@ Reload a IOU instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/iou/projectsprojectidiouvmsvmidstart.rst

@@ -9,8 +9,8 @@ Start a IOU instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/iou/projectsprojectidiouvmsvmidstop.rst

@@ -9,8 +9,8 @@ Stop a IOU instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/qemu/projectsprojectidqemuvms.rst

@@ -5,7 +5,7 @@
 
 POST /v1/projects/**{project_id}**/qemu/vms
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Create a new Qemu.instance
+Create a new Qemu VM instance
 
 Parameters
 **********

docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst

@@ -5,12 +5,12 @@
 
 GET /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Get a Qemu.instance
+Get a Qemu VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -54,12 +54,12 @@ Sample session
 
 PUT /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Update a Qemu.instance
+Update a Qemu VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -129,12 +129,12 @@ Sample session
 
 DELETE /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Delete a Qemu.instance
+Delete a Qemu VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -5,14 +5,14 @@
 
 POST /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Add a NIO to a Qemu.instance
+Add a NIO to a Qemu VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Network adapter where the nio is located
 - **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -29,14 +29,14 @@ Sample session
 
 DELETE /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Remove a NIO from a Qemu.instance
+Remove a NIO from a Qemu VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Network adapter where the nio is located
 - **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/qemu/projectsprojectidqemuvmsvmidreload.rst

@@ -5,12 +5,12 @@
 
 POST /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/reload
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Reload a Qemu.instance
+Reload a Qemu VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst

@@ -5,12 +5,12 @@
 
 POST /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/resume
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Resume a Qemu.instance
+Resume a Qemu VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst

@@ -5,12 +5,12 @@
 
 POST /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/start
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Start a Qemu.instance
+Start a Qemu VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/qemu/projectsprojectidqemuvmsvmidstop.rst

@@ -5,12 +5,12 @@
 
 POST /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/stop
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Stop a Qemu.instance
+Stop a Qemu VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/qemu/projectsprojectidqemuvmsvmidsuspend.rst

@@ -5,12 +5,12 @@
 
 POST /v1/projects/**{project_id}**/qemu/vms/**{vm_id}**/suspend
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Suspend a Qemu.instance
+Suspend a Qemu VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/qemu/qemuvms.rst

@@ -0,0 +1,13 @@
+/v1/qemu/vms
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/qemu/vms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieve the list of Qemu images
+
+Response status codes
+**********************
+- **200**: List of Qemu images retrieved
+

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst

@@ -9,8 +9,8 @@ Get a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -50,8 +50,8 @@ Update a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -109,8 +109,8 @@ Delete a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Adapter where the nio should be added
 - **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
+- **adapter_number**: Adapter where the nio should be added
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -33,10 +33,10 @@ Remove a NIO from a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Adapter from where the nio should be removed
 - **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
+- **adapter_number**: Adapter from where the nio should be removed
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

@@ -9,10 +9,10 @@ Start a packet capture on a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Adapter to start a packet capture
 - **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
+- **adapter_number**: Adapter to start a packet capture
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

@@ -9,10 +9,10 @@ Stop a packet capture on a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Adapter to stop a packet capture
 - **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
+- **adapter_number**: Adapter to stop a packet capture
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidreload.rst

@@ -9,8 +9,8 @@ Reload a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst

@@ -9,8 +9,8 @@ Resume a suspended VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst

@@ -9,8 +9,8 @@ Start a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst

@@ -9,8 +9,8 @@ Stop a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst

@@ -9,8 +9,8 @@ Suspend a VirtualBox VM instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/vmware.rst

@@ -0,0 +1,8 @@
+Vmware
+---------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   vmware/*

docs/api/v1/vmware/projectsprojectidvmwarevms.rst

@@ -0,0 +1,49 @@
+/v1/projects/{project_id}/vmware/vms
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/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>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>&#10004;</td>                     <td>boolean</td>                     <td>either the VM is a linked clone or not</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>VMware VM instance name</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>&#10004;</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>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>&#10004;</td>                     <td>string</td>                     <td>VMware VM instance name</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</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>
+

docs/api/v1/vmware/projectsprojectidvmwarevmsvmid.rst

@@ -0,0 +1,96 @@
+/v1/projects/{project_id}/vmware/vms/{vm_id}
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/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>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>&#10004;</td>                     <td>string</td>                     <td>VMware VM instance name</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</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 /v1/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>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>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>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>&#10004;</td>                     <td>string</td>                     <td>VMware VM instance name</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</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 /v1/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
+

docs/api/v1/vmware/projectsprojectidvmwarevmsvmidreload.rst

@@ -0,0 +1,20 @@
+/v1/projects/{project_id}/vmware/vms/{vm_id}/reload
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/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
+

docs/api/v1/vmware/projectsprojectidvmwarevmsvmidresume.rst

@@ -0,0 +1,20 @@
+/v1/projects/{project_id}/vmware/vms/{vm_id}/resume
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/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
+

docs/api/v1/vmware/projectsprojectidvmwarevmsvmidstart.rst

@@ -0,0 +1,20 @@
+/v1/projects/{project_id}/vmware/vms/{vm_id}/start
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/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
+

docs/api/v1/vmware/projectsprojectidvmwarevmsvmidstop.rst

@@ -0,0 +1,20 @@
+/v1/projects/{project_id}/vmware/vms/{vm_id}/stop
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/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
+

docs/api/v1/vmware/projectsprojectidvmwarevmsvmidsuspend.rst

@@ -0,0 +1,20 @@
+/v1/projects/{project_id}/vmware/vms/{vm_id}/suspend
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/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
+

docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst

@@ -9,8 +9,8 @@ Get a VPCS instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -45,8 +45,8 @@ Update a VPCS instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -93,8 +93,8 @@ Delete a VPCS instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -9,10 +9,10 @@ Add a NIO to a VPCS instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Network adapter where the nio is located
 - **port_number**: Port where the nio should be added
 - **vm_id**: UUID for the instance
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -33,10 +33,10 @@ Remove a NIO from a VPCS instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
-- **adapter_number**: Network adapter where the nio is located
 - **port_number**: Port from where the nio should be removed
 - **vm_id**: UUID for the instance
+- **adapter_number**: Network adapter where the nio is located
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidreload.rst

@@ -9,8 +9,8 @@ Reload a VPCS instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst

@@ -9,8 +9,8 @@ Start a VPCS instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstop.rst

@@ -9,8 +9,8 @@ Stop a VPCS instance
 
 Parameters
 **********
-- **project_id**: UUID for the project
 - **vm_id**: UUID for the instance
+- **project_id**: UUID for the project
 
 Response status codes
 **********************