Fix missing IOU documentation

Fix #143

docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst

@@ -9,8 +9,8 @@ Get a Dynamips device instance
 
 Parameters
 **********
-- **device_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **device_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -38,8 +38,8 @@ Update a Dynamips device instance
 
 Parameters
 **********
-- **device_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **device_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -95,8 +95,8 @@ Delete a Dynamips device instance
 
 Parameters
 **********
-- **device_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **device_id**: UUID for the instance
 
 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
-- **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
-- **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
-- **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
-- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst

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

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst

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

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst

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

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst

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

docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst

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

docs/api/v1/iou.rst

@@ -0,0 +1,8 @@
+Iou
+---------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   iou/*

docs/api/v1/iou/projectsprojectidiouvms.rst

@@ -0,0 +1,66 @@
+/v1/projects/{project_id}/iou/vms
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Create a new IOU instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **201**: Instance created
+- **409**: Conflict
+
+Input
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>console</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>ethernet_adapters</td>                    <td> </td>                     <td>integer</td>                     <td>How many ethernet adapters are connected to the IOU</td>                     </tr>
+    <tr><td>initial_config_content</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Initial configuration of the 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>
+    <tr><td>nvram</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Allocated NVRAM KB</td>                     </tr>
+    <tr><td>path</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Path of iou binary</td>                     </tr>
+    <tr><td>ram</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Allocated RAM MB</td>                     </tr>
+    <tr><td>serial_adapters</td>                    <td> </td>                     <td>integer</td>                     <td>How many serial adapters are connected to the IOU</td>                     </tr>
+    <tr><td>use_default_iou_values</td>                    <td> </td>                     <td>['boolean', 'null']</td>                     <td>Use default IOU values</td>                     </tr>
+    <tr><td>vm_id</td>                    <td> </td>                     <td></td>                     <td>IOU VM identifier</td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>console</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>ethernet_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many ethernet adapters are connected to the IOU</td>                     </tr>
+    <tr><td>initial_config</td>                    <td>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Path of the initial config content relative to project directory</td>                     </tr>
+    <tr><td>iourc_path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Path of the iourc file used by remote servers</td>                     </tr>
+    <tr><td>l1_keepalives</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>Always up ethernet interface</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM name</td>                     </tr>
+    <tr><td>nvram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated NVRAM KB</td>                     </tr>
+    <tr><td>path</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Path of iou binary</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>ram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated RAM MB</td>                     </tr>
+    <tr><td>serial_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many serial adapters are connected to the IOU</td>                     </tr>
+    <tr><td>use_default_iou_values</td>                    <td>&#10004;</td>                     <td>['boolean', 'null']</td>                     <td>Use default IOU values</td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM UUID</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvms.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmid.rst

@@ -0,0 +1,132 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Get a IOU instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+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>&#10004;</td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>ethernet_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many ethernet adapters are connected to the IOU</td>                     </tr>
+    <tr><td>initial_config</td>                    <td>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Path of the initial config content relative to project directory</td>                     </tr>
+    <tr><td>iourc_path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Path of the iourc file used by remote servers</td>                     </tr>
+    <tr><td>l1_keepalives</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>Always up ethernet interface</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM name</td>                     </tr>
+    <tr><td>nvram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated NVRAM KB</td>                     </tr>
+    <tr><td>path</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Path of iou binary</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>ram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated RAM MB</td>                     </tr>
+    <tr><td>serial_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many serial adapters are connected to the IOU</td>                     </tr>
+    <tr><td>use_default_iou_values</td>                    <td>&#10004;</td>                     <td>['boolean', 'null']</td>                     <td>Use default IOU values</td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM UUID</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/get_projectsprojectidiouvmsvmid.txt
+
+
+PUT /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Update a IOU 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>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>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>
+    <tr><td>nvram</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Allocated NVRAM KB</td>                     </tr>
+    <tr><td>path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Path of iou binary</td>                     </tr>
+    <tr><td>ram</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Allocated RAM MB</td>                     </tr>
+    <tr><td>serial_adapters</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>How many serial adapters are connected to the IOU</td>                     </tr>
+    <tr><td>use_default_iou_values</td>                    <td> </td>                     <td>['boolean', 'null']</td>                     <td>Use default IOU values</td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>console</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>ethernet_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many ethernet adapters are connected to the IOU</td>                     </tr>
+    <tr><td>initial_config</td>                    <td>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Path of the initial config content relative to project directory</td>                     </tr>
+    <tr><td>iourc_path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Path of the iourc file used by remote servers</td>                     </tr>
+    <tr><td>l1_keepalives</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>Always up ethernet interface</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM name</td>                     </tr>
+    <tr><td>nvram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated NVRAM KB</td>                     </tr>
+    <tr><td>path</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Path of iou binary</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>ram</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Allocated RAM MB</td>                     </tr>
+    <tr><td>serial_adapters</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>How many serial adapters are connected to the IOU</td>                     </tr>
+    <tr><td>use_default_iou_values</td>                    <td>&#10004;</td>                     <td>['boolean', 'null']</td>                     <td>Use default IOU values</td>                     </tr>
+    <tr><td>vm_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>IOU VM UUID</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/put_projectsprojectidiouvmsvmid.txt
+
+
+DELETE /v1/projects/**{project_id}**/iou/vms/**{vm_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Delete a IOU instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance deleted
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/delete_projectsprojectidiouvmsvmid.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -0,0 +1,52 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+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
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **201**: NIO created
+- **404**: Instance doesn't exist
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
+
+
+DELETE /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+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
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: NIO deleted
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

@@ -0,0 +1,39 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/start_capture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Start a packet capture on a IOU VM instance
+
+Parameters
+**********
+- **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
+
+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>&#10004;</td>                     <td>string</td>                     <td>PCAP data link type</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

@@ -0,0 +1,29 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/stop_capture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Stop a packet capture on a IOU VM instance
+
+Parameters
+**********
+- **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
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Capture stopped
+- **409**: VM not started
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidinitialconfig.rst

@@ -0,0 +1,30 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/initial_config
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/initial_config
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieve the initial config content
+
+Response status codes
+**********************
+- **200**: Initial config retrieved
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>content</td>                    <td>&#10004;</td>                     <td>['string', 'null']</td>                     <td>Content of the initial configuration file</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/get_projectsprojectidiouvmsvmidinitialconfig.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidreload.rst

@@ -0,0 +1,26 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/reload
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/reload
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Reload a IOU instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance reloaded
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidreload.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidstart.rst

@@ -0,0 +1,26 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/start
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/start
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Start a IOU instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance started
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidstart.txt
+

docs/api/v1/iou/projectsprojectidiouvmsvmidstop.rst

@@ -0,0 +1,26 @@
+/v1/projects/{project_id}/iou/vms/{vm_id}/stop
+----------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v1/projects/**{project_id}**/iou/vms/**{vm_id}**/stop
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Stop a IOU instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+- **204**: Instance stopped
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../examples/post_projectsprojectidiouvmsvmidstop.txt
+

docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst

@@ -9,8 +9,8 @@ Get a Qemu.instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -58,8 +58,8 @@ Update a Qemu.instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -133,8 +133,8 @@ Delete a Qemu.instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************

docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -9,10 +9,10 @@ Add a NIO to a Qemu.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
-- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -33,10 +33,10 @@ Remove a NIO from a Qemu.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
-- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/qemu/projectsprojectidqemuvmsvmidreload.rst

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

docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst

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

docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst

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

docs/api/v1/qemu/projectsprojectidqemuvmsvmidstop.rst

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

docs/api/v1/qemu/projectsprojectidqemuvmsvmidsuspend.rst

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

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst

@@ -9,8 +9,8 @@ Get a VirtualBox VM instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -50,8 +50,8 @@ Update a VirtualBox VM instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -109,8 +109,8 @@ Delete a VirtualBox VM instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 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
-- **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
-- **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
-- **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
-- **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
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst

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

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst

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

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst

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

docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst

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

docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst

@@ -9,8 +9,8 @@ Get a VPCS instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -45,8 +45,8 @@ Update a VPCS instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -93,8 +93,8 @@ Delete a VPCS instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 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
-- **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
-- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidreload.rst

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

docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst

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

docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstop.rst

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