Documentation

docs/api/v2/controller/gns3server.handlers.index.rst

@@ -0,0 +1,8 @@
+Gns3server.handlers.index
+-----------------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   gns3server.handlers.index/*

docs/api/v2/controller/gns3server.handlers.index/.rst

@@ -1,14 +1,13 @@
-/v2/controller/servers/shutdown
+/
 ------------------------------------------------------------------------------------------------------------------------------------------
 
 .. contents::
 
-POST /v2/controller/servers/shutdown
+GET /
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Shutdown the local server
+Home page for GNS3Server
 
 Response status codes
 **********************
-- **201**: Server is shutting down
-- **403**: Server shutdown refused
+- **200**: OK
 

docs/api/v2/controller/gns3server.handlers.index/status.rst

@@ -0,0 +1,13 @@
+/status
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /status
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Ressources used by GNS3Server
+
+Response status codes
+**********************
+- **200**: OK
+

docs/api/v2/controller/gns3server.handlers.index/v1version.rst

@@ -0,0 +1,13 @@
+/v1/version
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v1/version
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Old API
+
+Response status codes
+**********************
+- **200**: OK
+

docs/api/v2/controller/hypervisor.rst

@@ -0,0 +1,8 @@
+Hypervisor
+-----------------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   hypervisor/*

docs/api/v2/controller/hypervisor/s.rst

@@ -1,15 +1,15 @@
-/v2/controller/servers
+/v2/controller/hypervisors
 ------------------------------------------------------------------------------------------------------------------------------------------
 
 .. contents::
 
-POST /v2/controller/servers
+POST /v2/controller/hypervisors
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Register a server
+Register a hypervisor
 
 Response status codes
 **********************
-- **201**: Server added
+- **201**: Hypervisor added
 
 Input
 *******
@@ -18,10 +18,10 @@ Input
     <table>
     <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
     <tr><td>host</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Server host</td>                     </tr>
+    <tr><td>hypervisor_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Server identifier</td>                     </tr>
     <tr><td>password</td>                    <td> </td>                     <td>string</td>                     <td>Password for auth</td>                     </tr>
     <tr><td>port</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Server port</td>                     </tr>
     <tr><td>protocol</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: http, https</td>                     </tr>
-    <tr><td>server_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Server identifier</td>                     </tr>
     <tr><td>user</td>                    <td> </td>                     <td>string</td>                     <td>User for auth</td>                     </tr>
     </table>
 
@@ -31,18 +31,12 @@ Output
 
     <table>
     <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
-    <tr><td>connected</td>                    <td> </td>                     <td>boolean</td>                     <td>True if controller is connected to the server</td>                     </tr>
+    <tr><td>connected</td>                    <td> </td>                     <td>boolean</td>                     <td>True if controller is connected to the hypervisor</td>                     </tr>
     <tr><td>host</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Server host</td>                     </tr>
+    <tr><td>hypervisor_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Server identifier</td>                     </tr>
     <tr><td>port</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Server port</td>                     </tr>
     <tr><td>protocol</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: http, https</td>                     </tr>
-    <tr><td>server_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Server identifier</td>                     </tr>
     <tr><td>user</td>                    <td> </td>                     <td>string</td>                     <td>User for auth</td>                     </tr>
-    <tr><td>version</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Version of the GNS3 remote server</td>                     </tr>
+    <tr><td>version</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Version of the GNS3 remote hypervisor</td>                     </tr>
     </table>
 
-Sample session
-***************
-
-
-.. literalinclude:: ../../../examples/controller_post_servers.txt
-

docs/api/v2/controller/hypervisor/sshutdown.rst

@@ -0,0 +1,14 @@
+/v2/controller/hypervisors/shutdown
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v2/controller/hypervisors/shutdown
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Shutdown the local hypervisor
+
+Response status codes
+**********************
+- **201**: Hypervisor is shutting down
+- **403**: Hypervisor shutdown refused
+

docs/api/v2/controller/project.rst

@@ -0,0 +1,8 @@
+Project
+-----------------------------
+
+.. toctree::
+   :glob:
+   :maxdepth: 2
+
+   project/*

docs/api/v2/controller/project/projects.rst

@@ -0,0 +1,44 @@
+/v2/controller/projects
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v2/controller/projects
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Create a new project on the server
+
+Response status codes
+**********************
+- **201**: Project created
+- **409**: Project already created
+
+Input
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>name</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project name</td>                     </tr>
+    <tr><td>path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project directory</td>                     </tr>
+    <tr><td>project_id</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>temporary</td>                    <td> </td>                     <td>boolean</td>                     <td>If project is a temporary project</td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>name</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project name</td>                     </tr>
+    <tr><td>path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project directory</td>                     </tr>
+    <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>temporary</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>If project is a temporary project</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projects.txt
+

docs/api/v2/controller/project/projectsprojectid.rst

@@ -0,0 +1,24 @@
+/v2/controller/projects/{project_id}
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+DELETE /v2/controller/projects/**{project_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Delete a project from disk
+
+Parameters
+**********
+- **project_id**: The UUID of the project
+
+Response status codes
+**********************
+- **404**: The project doesn't exist
+- **204**: Changes have been written on disk
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_delete_projectsprojectid.txt
+

docs/api/v2/controller/project/projectsprojectidclose.rst

@@ -0,0 +1,24 @@
+/v2/controller/projects/{project_id}/close
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v2/controller/projects/**{project_id}**/close
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Close a project
+
+Parameters
+**********
+- **project_id**: The UUID of the project
+
+Response status codes
+**********************
+- **404**: The project doesn't exist
+- **204**: The project has been closed
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidclose.txt
+

docs/api/v2/controller/project/projectsprojectidcommit.rst

@@ -0,0 +1,24 @@
+/v2/controller/projects/{project_id}/commit
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v2/controller/projects/**{project_id}**/commit
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Write changes on disk
+
+Parameters
+**********
+- **project_id**: The UUID of the project
+
+Response status codes
+**********************
+- **404**: The project doesn't exist
+- **204**: Changes have been written on disk
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidcommit.txt
+

docs/api/v2/controller/vm.rst

@@ -1,8 +1,8 @@
-Server
+Vm
 -----------------------------
 
 .. toctree::
    :glob:
    :maxdepth: 2
 
-   server/*
+   vm/*

docs/api/v2/controller/vm/projectsprojectidvms.rst

@@ -0,0 +1,56 @@
+/v2/controller/projects/{project_id}/vms
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v2/controller/projects/**{project_id}**/vms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Create a new VM instance
+
+Parameters
+**********
+- **project_id**: UUID for the project
+
+Response status codes
+**********************
+- **400**: Invalid request
+- **201**: Instance created
+
+Input
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>console</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Console TCP port</td>                     </tr>
+    <tr><td>console_type</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: serial, vnc, telnet</td>                     </tr>
+    <tr><td>hypervisor_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Hypervisor identifier</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>VM name</td>                     </tr>
+    <tr><td>project_id</td>                    <td> </td>                     <td>string</td>                     <td>Project identifier</td>                     </tr>
+    <tr><td>properties</td>                    <td> </td>                     <td>object</td>                     <td>Properties specific to an emulator</td>                     </tr>
+    <tr><td>vm_id</td>                    <td> </td>                     <td>string</td>                     <td>VM identifier</td>                     </tr>
+    <tr><td>vm_type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>console</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Console TCP port</td>                     </tr>
+    <tr><td>console_type</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: serial, vnc, telnet</td>                     </tr>
+    <tr><td>hypervisor_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Hypervisor identifier</td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>VM name</td>                     </tr>
+    <tr><td>project_id</td>                    <td> </td>                     <td>string</td>                     <td>Project identifier</td>                     </tr>
+    <tr><td>properties</td>                    <td> </td>                     <td>object</td>                     <td>Properties specific to an emulator</td>                     </tr>
+    <tr><td>vm_id</td>                    <td> </td>                     <td>string</td>                     <td>VM identifier</td>                     </tr>
+    <tr><td>vm_type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidvms.txt
+

docs/api/v2/hypervisor/docker/projectsprojectiddockervmsid.rst

@@ -9,8 +9,8 @@ Delete a Docker container
 
 Parameters
 **********
-- **id**: ID for the container
 - **project_id**: UUID for the project
+- **id**: ID for the container
 
 Response status codes
 **********************

docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidreload.rst

@@ -9,8 +9,8 @@ Restart a Docker container
 
 Parameters
 **********
-- **id**: ID of the container
 - **project_id**: UUID of the project
+- **id**: ID of the container
 
 Response status codes
 **********************

docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstart.rst

@@ -9,8 +9,8 @@ Start a Docker container
 
 Parameters
 **********
-- **id**: ID of the container
 - **project_id**: UUID of the project
+- **id**: ID of the container
 
 Response status codes
 **********************

docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstop.rst

@@ -9,8 +9,8 @@ Stop a Docker container
 
 Parameters
 **********
-- **id**: ID of the container
 - **project_id**: UUID of the project
+- **id**: ID of the container
 
 Response status codes
 **********************

docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidsuspend.rst

@@ -9,8 +9,8 @@ Pause a Docker container
 
 Parameters
 **********
-- **id**: ID of the container
 - **project_id**: UUID of the project
+- **id**: ID of the container
 
 Response status codes
 **********************

docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmid.rst

@@ -9,8 +9,8 @@ Update a Docker 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/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -9,9 +9,9 @@ Add a NIO to a Docker container
 
 Parameters
 **********
+- **project_id**: UUID for the project
 - **id**: ID of the container
 - **port_number**: Port on the adapter
-- **project_id**: UUID for the project
 - **adapter_number**: Adapter where the nio should be added
 
 Response status codes
@@ -33,9 +33,9 @@ Remove a NIO from a Docker container
 
 Parameters
 **********
+- **project_id**: UUID for the project
 - **id**: ID of the container
 - **port_number**: Port on the adapter
-- **project_id**: UUID for the project
 - **adapter_number**: Adapter where the nio should be added
 
 Response status codes

docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

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

docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

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

docs/api/v2/hypervisor/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
 **********************
@@ -96,8 +96,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/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst

@@ -9,9 +9,9 @@ Add a NIO to a Dynamips device instance
 
 Parameters
 **********
+- **project_id**: UUID for the project
 - **device_id**: UUID for the instance
 - **port_number**: Port on the device
-- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -139,9 +139,9 @@ Remove a NIO from a Dynamips device instance
 
 Parameters
 **********
+- **project_id**: UUID for the project
 - **device_id**: UUID for the instance
 - **port_number**: Port on the device
-- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst

@@ -9,9 +9,9 @@ Start a packet capture on a Dynamips device instance
 
 Parameters
 **********
+- **project_id**: UUID for the project
 - **device_id**: UUID for the instance
 - **port_number**: Port on the device
-- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst

@@ -9,9 +9,9 @@ Stop a packet capture on a Dynamips device instance
 
 Parameters
 **********
+- **project_id**: UUID for the project
 - **device_id**: UUID for the instance
 - **port_number**: Port on the device
-- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v2/hypervisor/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
 **********************
@@ -77,8 +77,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
 **********************
@@ -194,8 +194,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/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst

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

docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

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

docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

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

docs/api/v2/hypervisor/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/v2/hypervisor/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/v2/hypervisor/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/v2/hypervisor/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/v2/hypervisor/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/v2/hypervisor/iou/projectsprojectidiouvmsvmid.rst

@@ -9,8 +9,8 @@ Get a IOU instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -56,8 +56,8 @@ Update a IOU instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -125,8 +125,8 @@ Delete a IOU 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/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst

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

docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

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

docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

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

docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidreload.rst

@@ -9,8 +9,8 @@ Reload a IOU 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/v2/hypervisor/iou/projectsprojectidiouvmsvmidstart.rst

@@ -9,8 +9,8 @@ Start a IOU 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/v2/hypervisor/iou/projectsprojectidiouvmsvmidstop.rst

@@ -9,8 +9,8 @@ Stop a IOU 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/v2/hypervisor/project/projects.rst

@@ -45,9 +45,8 @@ Output
 
     <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>Base directory where the project should be created on remote server</td>                     </tr>
     <tr><td>name</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project name</td>                     </tr>
-    <tr><td>path</td>                    <td> </td>                     <td>string</td>                     <td>Directory of the project on the server</td>                     </tr>
+    <tr><td>path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project directory</td>                     </tr>
     <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
     <tr><td>temporary</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>If project is a temporary project</td>                     </tr>
     </table>

docs/api/v2/hypervisor/project/projectsprojectid.rst

@@ -22,9 +22,8 @@ Output
 
     <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>Base directory where the project should be created on remote server</td>                     </tr>
     <tr><td>name</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project name</td>                     </tr>
-    <tr><td>path</td>                    <td> </td>                     <td>string</td>                     <td>Directory of the project on the server</td>                     </tr>
+    <tr><td>path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project directory</td>                     </tr>
     <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
     <tr><td>temporary</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>If project is a temporary project</td>                     </tr>
     </table>
@@ -67,9 +66,8 @@ Output
 
     <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>Base directory where the project should be created on remote server</td>                     </tr>
     <tr><td>name</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project name</td>                     </tr>
-    <tr><td>path</td>                    <td> </td>                     <td>string</td>                     <td>Directory of the project on the server</td>                     </tr>
+    <tr><td>path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Project directory</td>                     </tr>
     <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
     <tr><td>temporary</td>                    <td>&#10004;</td>                     <td>boolean</td>                     <td>If project is a temporary project</td>                     </tr>
     </table>

docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmid.rst

@@ -9,8 +9,8 @@ Get a Qemu VM instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -79,8 +79,8 @@ Update a Qemu VM instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -194,8 +194,8 @@ Delete a Qemu 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/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst

@@ -9,10 +9,10 @@ Add a NIO to a Qemu VM instance
 
 Parameters
 **********
+- **project_id**: UUID for the project
+- **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
 - **adapter_number**: Network adapter where the nio is located
-- **port_number**: Port on the adapter (always 0)
-- **project_id**: UUID for the project
 
 Response status codes
 **********************
@@ -33,10 +33,10 @@ Remove a NIO from a Qemu VM instance
 
 Parameters
 **********
+- **project_id**: UUID for the project
+- **port_number**: Port on the adapter (always 0)
 - **vm_id**: UUID for the instance
 - **adapter_number**: Network adapter where the nio is located
-- **port_number**: Port on the adapter (always 0)
-- **project_id**: UUID for the project
 
 Response status codes
 **********************

docs/api/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidreload.rst

@@ -9,8 +9,8 @@ Reload a Qemu 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/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidresume.rst

@@ -9,8 +9,8 @@ Resume a Qemu 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/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidstart.rst

@@ -9,8 +9,8 @@ Start a Qemu 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/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidstop.rst

@@ -9,8 +9,8 @@ Stop a Qemu 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/v2/hypervisor/qemu/projectsprojectidqemuvmsvmidsuspend.rst

@@ -9,8 +9,8 @@ Suspend a Qemu 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/v2/hypervisor/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
 **********************
@@ -52,8 +52,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
 **********************
@@ -114,8 +114,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/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst

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

docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

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

docs/api/v2/hypervisor/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

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

docs/api/v2/hypervisor/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/v2/hypervisor/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/v2/hypervisor/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/v2/hypervisor/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/v2/hypervisor/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/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmid.rst

@@ -9,8 +9,8 @@ Get a VMware VM instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -46,8 +46,8 @@ Update a VMware VM instance
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: UUID for the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************
@@ -102,8 +102,8 @@ Delete a VMware 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/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst

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

docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst

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

docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst

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

docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidinterfacesvmnet.rst

@@ -9,8 +9,8 @@ Allocate a VMware VMnet interface on the server
 
 Parameters
 **********
-- **vm_id**: UUID for the instance
 - **project_id**: The UUID of the project
+- **vm_id**: UUID for the instance
 
 Response status codes
 **********************

docs/api/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidreload.rst

@@ -9,8 +9,8 @@ Reload a VMware 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/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidresume.rst

@@ -9,8 +9,8 @@ Resume a suspended VMware 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/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidstart.rst

@@ -9,8 +9,8 @@ Start a VMware 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/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidstop.rst

@@ -9,8 +9,8 @@ Stop a VMware 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/v2/hypervisor/vmware/projectsprojectidvmwarevmsvmidsuspend.rst

@@ -9,8 +9,8 @@ Suspend a VMware 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/v2/hypervisor/vpcs/projectsprojectidvpcsvms.rst

@@ -24,6 +24,7 @@ Input
     <table>
     <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
     <tr><td>console</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>console_type</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: telnet</td>                     </tr>
     <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>VPCS VM name</td>                     </tr>
     <tr><td>startup_script</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the VPCS startup script</td>                     </tr>
     <tr><td>vm_id</td>                    <td> </td>                     <td></td>                     <td>VPCS VM identifier</td>                     </tr>
@@ -37,6 +38,7 @@ Output
     <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
     <tr><td>command_line</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Last command line used by GNS3 to start QEMU</td>                     </tr>
     <tr><td>console</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>console_type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: telnet</td>                     </tr>
     <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>VPCS VM name</td>                     </tr>
     <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
     <tr><td>startup_script</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the VPCS startup script</td>                     </tr>

docs/api/v2/hypervisor/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
 **********************
@@ -26,6 +26,7 @@ Output
     <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
     <tr><td>command_line</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Last command line used by GNS3 to start QEMU</td>                     </tr>
     <tr><td>console</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>console_type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: telnet</td>                     </tr>
     <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>VPCS VM name</td>                     </tr>
     <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
     <tr><td>startup_script</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the VPCS startup script</td>                     </tr>
@@ -48,8 +49,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
 **********************
@@ -65,6 +66,7 @@ Input
     <table>
     <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
     <tr><td>console</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>console_type</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: telnet</td>                     </tr>
     <tr><td>name</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>VPCS VM name</td>                     </tr>
     <tr><td>startup_script</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the VPCS startup script</td>                     </tr>
     </table>
@@ -77,6 +79,7 @@ Output
     <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
     <tr><td>command_line</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Last command line used by GNS3 to start QEMU</td>                     </tr>
     <tr><td>console</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>console_type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: telnet</td>                     </tr>
     <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>VPCS VM name</td>                     </tr>
     <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
     <tr><td>startup_script</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the VPCS startup script</td>                     </tr>
@@ -99,8 +102,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/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst

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

docs/api/v2/hypervisor/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/v2/hypervisor/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
 **********************
@@ -26,6 +26,7 @@ Output
     <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
     <tr><td>command_line</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Last command line used by GNS3 to start QEMU</td>                     </tr>
     <tr><td>console</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>console TCP port</td>                     </tr>
+    <tr><td>console_type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: telnet</td>                     </tr>
     <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>VPCS VM name</td>                     </tr>
     <tr><td>project_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
     <tr><td>startup_script</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Content of the VPCS startup script</td>                     </tr>

docs/api/v2/hypervisor/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
 **********************