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

API documentation update

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-01-04 17:04:15 +01:00
1 parent e73f81c9a3
commit afb5b6d6e8
80 files changed
+341 -527
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v1/docker/projectsprojectiddockerimagesidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Add a NIO to a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **id**: ID of the container
- **adapter_number**: Adapter where the nio should be added
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
@@ -27,8 +27,8 @@ Remove a NIO from a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **id**: ID of the container
- **adapter_number**: Adapter where the nio should be added
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -10,8 +10,8 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
@@ -28,8 +28,8 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -10,8 +10,8 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -10,8 +10,8 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -10,8 +10,8 @@ Add a NIO to a IOU instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
- **port_number**: Port where the nio should be added
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
@@ -34,8 +34,8 @@ Remove a NIO from a IOU instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
- **port_number**: Port from where the nio should be removed
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -10,8 +10,8 @@ Start a packet capture on a IOU VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -10,8 +10,8 @@ Stop a packet capture on a IOU VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/project/projects.rst
+1 -1
View File
@@ -46,7 +46,7 @@ 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</td> <td>Project name</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>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>
docs/api/v1/project/projectsprojectid.rst
+2 -2
View File
@@ -23,7 +23,7 @@ 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</td> <td>Project name</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>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>
@@ -68,7 +68,7 @@ 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</td> <td>Project name</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>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>
docs/api/v1/qemu/projectsprojectidqemuvms.rst
+4 -1
View File
@@ -26,7 +26,7 @@ Input
<tr><td>acpi_shutdown</td> <td> </td> <td>['boolean', 'null']</td> <td>ACPI shutdown support</td> </tr>
<tr><td>adapter_type</td> <td> </td> <td>['string', 'null']</td> <td>QEMU adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>['integer', 'null']</td> <td>number of adapters</td> </tr>
<tr><td>boot_priority</td> <td> </td> <td>enum</td> <td>Possible values: c, d</td> </tr>
<tr><td>boot_priority</td> <td> </td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>cdrom_image</td> <td> </td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>console TCP port</td> </tr>
@@ -51,6 +51,7 @@ Input
<tr><td>kernel_image</td> <td> </td> <td>string</td> <td>QEMU kernel image path</td> </tr>
<tr><td>kernel_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU kernel image checksum</td> </tr>
<tr><td>legacy_networking</td> <td> </td> <td>['boolean', 'null']</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
<tr><td>linked_clone</td> <td> </td> <td>boolean</td> <td>either the VM is a linked clone or not</td> </tr>
<tr><td>mac_address</td> <td> </td> <td>['string', 'null']</td> <td>QEMU MAC address</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM instance name</td> </tr>
<tr><td>options</td> <td> </td> <td>['string', 'null']</td> <td>Additional QEMU options</td> </tr>
@@ -58,6 +59,7 @@ Input
<tr><td>process_priority</td> <td> </td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low, null</td> </tr>
<tr><td>qemu_path</td> <td> </td> <td>['string', 'null']</td> <td>Path to QEMU</td> </tr>
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>amount of RAM in MB</td> </tr>
<tr><td>usage</td> <td> </td> <td>string</td> <td>How to use the qemu VM</td> </tr>
<tr><td>vm_id</td> <td> </td> <td></td> <td>QEMU VM identifier</td> </tr>
</table>
@@ -103,6 +105,7 @@ Output
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project uuid</td> </tr>
<tr><td>qemu_path</td> <td>&#10004;</td> <td>string</td> <td>path to QEMU</td> </tr>
<tr><td>ram</td> <td>&#10004;</td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the qemu VM</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
</table>
docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst
+3
View File
@@ -60,6 +60,7 @@ Output
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project uuid</td> </tr>
<tr><td>qemu_path</td> <td>&#10004;</td> <td>string</td> <td>path to QEMU</td> </tr>
<tr><td>ram</td> <td>&#10004;</td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the qemu VM</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
</table>
@@ -128,6 +129,7 @@ Input
<tr><td>process_priority</td> <td> </td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low, null</td> </tr>
<tr><td>qemu_path</td> <td> </td> <td>['string', 'null']</td> <td>Path to QEMU</td> </tr>
<tr><td>ram</td> <td> </td> <td>['integer', 'null']</td> <td>amount of RAM in MB</td> </tr>
<tr><td>usage</td> <td> </td> <td>string</td> <td>How to use the qemu VM</td> </tr>
</table>
Output
@@ -172,6 +174,7 @@ Output
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project uuid</td> </tr>
<tr><td>qemu_path</td> <td>&#10004;</td> <td>string</td> <td>path to QEMU</td> </tr>
<tr><td>ram</td> <td>&#10004;</td> <td>integer</td> <td>amount of RAM in MB</td> </tr>
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the qemu VM</td> </tr>
<tr><td>vm_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
</table>
docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -10,8 +10,8 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
@@ -34,8 +34,8 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/qemu/qemubinaries.rst
+9
View File
@@ -13,6 +13,15 @@ Response status codes
- **400**: Invalid request
- **404**: Instance doesn't exist
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>archs</td> <td> </td> <td>array</td> <td>Architectures to filter binaries by</td> </tr>
</table>
Sample session
***************
docs/api/v1/qemu/qemucapabilities.rst
+28
View File
@@ -0,0 +1,28 @@
/v1/qemu/capabilities
----------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v1/qemu/capabilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a list of Qemu capabilities on this server
Response status codes
**********************
- **200**: Success
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>kvm</td> <td> </td> <td>array</td> <td>Architectures that KVM is enabled for</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../examples/get_qemucapabilities.txt
docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -10,8 +10,8 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
@@ -34,8 +34,8 @@ Remove a NIO from a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -10,8 +10,8 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -10,8 +10,8 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -10,8 +10,8 @@ Add a NIO to a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
@@ -28,8 +28,8 @@ Remove a NIO from a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter from where the nio should be removed
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
+1 -1
View File
@@ -10,8 +10,8 @@ Start a packet capture on a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/vmware/projectsprojectidvmwarevmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
+1 -1
View File
@@ -10,8 +10,8 @@ Stop a packet capture on a VMware VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+2 -2
View File
@@ -10,8 +10,8 @@ Add a NIO to a VPCS instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
- **port_number**: Port where the nio should be added
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
@@ -34,8 +34,8 @@ Remove a NIO from a VPCS instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: UUID for the project
- **port_number**: Port from where the nio should be removed
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes