NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-03 22:11:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

API V2

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-03-07 17:57:12 +01:00
1 parent 664cec97ba
commit b2ce7ee8d7
200 files changed
+867 -625
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvms.rst
+54
View File
@@ -0,0 +1,54 @@
/v2/hypervisor/projects/{project_id}/vpcs/vms
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new VPCS 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>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>
</table>
Output
*******
.. raw:: html
<table>
<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>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>
<tr><td>startup_script_path</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</td> </tr>
<tr><td>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped</td> </tr>
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM UUID</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvms.txt
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmid.rst
+116
View File
@@ -0,0 +1,116 @@
/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
- **200**: Success
- **400**: Invalid request
- **404**: Instance doesn't exist
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>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>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>
<tr><td>startup_script_path</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</td> </tr>
<tr><td>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped</td> </tr>
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM UUID</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_get_projectsprojectidvpcsvmsvmid.txt
PUT /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
- **200**: Instance updated
- **400**: Invalid request
- **404**: Instance doesn't exist
- **409**: Conflict
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</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>
Output
*******
.. raw:: html
<table>
<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>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>
<tr><td>startup_script_path</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</td> </tr>
<tr><td>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped</td> </tr>
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM UUID</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_put_projectsprojectidvpcsvmsvmid.txt
DELETE /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidvpcsvmsvmid.txt
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+52
View File
@@ -0,0 +1,52 @@
/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add a NIO to a VPCS instance
Parameters
**********
- **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
**********************
- **400**: Invalid request
- **201**: NIO created
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Remove a NIO from a VPCS instance
Parameters
**********
- **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
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidreload.rst
+26
View File
@@ -0,0 +1,26 @@
/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/reload
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/reload
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Reload a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvmsvmidreload.txt
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstart.rst
+43
View File
@@ -0,0 +1,43 @@
/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/start
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Start a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
Output
*******
.. raw:: html
<table>
<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>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>
<tr><td>startup_script_path</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Path of the VPCS startup script relative to project directory</td> </tr>
<tr><td>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped</td> </tr>
<tr><td>vm_directory</td> <td> </td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>VPCS VM UUID</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvmsvmidstart.txt
docs/api/v2/hypervisor/vpcs/projectsprojectidvpcsvmsvmidstop.rst
+26
View File
@@ -0,0 +1,26 @@
/v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/stop
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/hypervisor/projects/**{project_id}**/vpcs/vms/**{vm_id}**/stop
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stop a VPCS instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
Sample session
***************
.. literalinclude:: ../../../examples/hypervisor_post_projectsprojectidvpcsvmsvmidstop.txt