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

Fix missing /v1 in api documentation

Browse Source 
Fix #116
This commit is contained in:
Julien Duponchelle committed 2015-03-30 11:05:54 +02:00
1 parent ee8362d89a
commit da00aa030a
103 files changed
+455 -325
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v1/config.rst
+8
View File
@@ -0,0 +1,8 @@
Config
---------------------
.. toctree::
:glob:
:maxdepth: 2
config/*
docs/api/v1/network/portsudp.rst → docs/api/v1/config/configreload.rst
+6 -5
View File
@@ -1,19 +1,20 @@
/v1/ports/udp
/v1/config/reload
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/ports/udp
POST /v1/config/reload
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Allocate an UDP port on the server
Check if version is the same as the server
Response status codes
**********************
- **201**: UDP port allocated
- **201**: Config reload
- **403**: Config reload refused
Sample session
***************
.. literalinclude:: ../../examples/post_portsudp.txt
.. literalinclude:: ../../examples/post_configreload.txt
docs/api/v1/dynamips_device/projectsprojectiddynamipsdevices.rst
+1 -1
View File
@@ -23,7 +23,7 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>device_id</td> <td> </td> <td>string</td> <td>Dynamips device instance identifier</td> </tr>
<tr><td>device_id</td> <td> </td> <td></td> <td>Dynamips device instance identifier</td> </tr>
<tr><td>device_type</td> <td>&#10004;</td> <td>string</td> <td>Dynamips device type</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Dynamips device name</td> </tr>
</table>
docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -38,8 +38,8 @@ Update a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -95,8 +95,8 @@ Delete a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst
+4 -4
View File
@@ -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
- **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
- **device_id**: UUID for the instance
- **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
+2 -2
View File
@@ -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
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst
+2 -2
View File
@@ -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
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvms.rst
+1 -3
View File
@@ -26,7 +26,6 @@ Input
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
<tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
@@ -74,10 +73,9 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
<tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst
+5 -8
View File
@@ -9,8 +9,8 @@ Get a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -24,10 +24,9 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
<tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
@@ -75,8 +74,8 @@ Update a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -94,7 +93,6 @@ Input
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
<tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
@@ -140,10 +138,9 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>aux</td> <td> </td> <td>integer</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>aux</td> <td> </td> <td>['integer', 'null']</td> <td>auxiliary console TCP port</td> </tr>
<tr><td>chassis</td> <td> </td> <td>string</td> <td>router chassis model</td> </tr>
<tr><td>clock_divisor</td> <td> </td> <td>integer</td> <td>clock divisor</td> </tr>
<tr><td>confreg</td> <td> </td> <td>string</td> <td>configuration register</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<tr><td>disk0</td> <td> </td> <td>integer</td> <td>disk0 size in MB</td> </tr>
<tr><td>disk1</td> <td> </td> <td>integer</td> <td>disk1 size in MB</td> </tr>
@@ -191,8 +188,8 @@ Delete a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+4 -4
View File
@@ -9,10 +9,10 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **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
- **vm_id**: UUID for the instance
- **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
+2 -2
View File
@@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **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
+2 -2
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **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/projectsprojectiddynamipsvmsvmidconfigssave.rst
+15
View File
@@ -0,0 +1,15 @@
/v1/projects/{project_id}/dynamips/vms/{vm_id}/configs/save
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/projects/**{project_id}**/dynamips/vms/**{vm_id}**/configs/save
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Save the startup and private configs content
Response status codes
**********************
- **200**: Configs saved
- **400**: Invalid request
- **404**: Instance doesn't exist
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Resume a suspended Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/network/projectsprojectidportsudp.rst
+24
View File
@@ -0,0 +1,24 @@
/v1/projects/{project_id}/ports/udp
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/projects/**{project_id}**/ports/udp
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Allocate an UDP port on the server
Parameters
**********
- **project_id**: The UUID of the project
Response status codes
**********************
- **201**: UDP port allocated
- **404**: The project doesn't exist
Sample session
***************
.. literalinclude:: ../../examples/post_projectsprojectidportsudp.txt
docs/api/v1/project/projects.rst
+2
View File
@@ -18,6 +18,7 @@ Input
<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>
@@ -30,6 +31,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>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
+3
View File
@@ -23,6 +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>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>
@@ -55,6 +56,7 @@ Input
<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>Path of the project on the server (work only with --local)</td> </tr>
<tr><td>temporary</td> <td> </td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
</table>
@@ -66,6 +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>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
+5 -3
View File
@@ -29,17 +29,18 @@ Input
<tr><td>cpu_throttling</td> <td> </td> <td>['integer', 'null']</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>hda_disk_image</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hdb_disk_image</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdb disk image path</td> </tr>
<tr><td>hdc_disk_image</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdc disk image path</td> </tr>
<tr><td>hdd_disk_image</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdd disk image path</td> </tr>
<tr><td>initrd</td> <td> </td> <td>['string', 'null']</td> <td>QEMU initrd path</td> </tr>
<tr><td>kernel_command_line</td> <td> </td> <td>['string', 'null']</td> <td>QEMU kernel command line</td> </tr>
<tr><td>kernel_image</td> <td> </td> <td>['string', 'null']</td> <td>QEMU kernel image path</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>monitor</td> <td> </td> <td>['integer', 'null']</td> <td>monitor TCP port</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>
<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>&#10004;</td> <td>string</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>vm_id</td> <td> </td> <td>['string', 'null']</td> <td>QEMU VM UUID</td> </tr>
<tr><td>vm_id</td> <td> </td> <td></td> <td>QEMU VM identifier</td> </tr>
</table>
Output
@@ -54,11 +55,12 @@ Output
<tr><td>cpu_throttling</td> <td>&#10004;</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>hda_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hdb_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hdb disk image path</td> </tr>
<tr><td>hdc_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hdc disk image path</td> </tr>
<tr><td>hdd_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hdd disk image path</td> </tr>
<tr><td>initrd</td> <td>&#10004;</td> <td>string</td> <td>QEMU initrd path</td> </tr>
<tr><td>kernel_command_line</td> <td>&#10004;</td> <td>string</td> <td>QEMU kernel command line</td> </tr>
<tr><td>kernel_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU kernel image path</td> </tr>
<tr><td>legacy_networking</td> <td>&#10004;</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
<tr><td>monitor</td> <td>&#10004;</td> <td>integer</td> <td>monitor TCP port</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM instance name</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
docs/api/v1/qemu/projectsprojectidqemuvmsvmid.rst
+9 -6
View File
@@ -9,8 +9,8 @@ Get a Qemu.instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -30,11 +30,12 @@ Output
<tr><td>cpu_throttling</td> <td>&#10004;</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>hda_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hdb_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hdb disk image path</td> </tr>
<tr><td>hdc_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hdc disk image path</td> </tr>
<tr><td>hdd_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hdd disk image path</td> </tr>
<tr><td>initrd</td> <td>&#10004;</td> <td>string</td> <td>QEMU initrd path</td> </tr>
<tr><td>kernel_command_line</td> <td>&#10004;</td> <td>string</td> <td>QEMU kernel command line</td> </tr>
<tr><td>kernel_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU kernel image path</td> </tr>
<tr><td>legacy_networking</td> <td>&#10004;</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
<tr><td>monitor</td> <td>&#10004;</td> <td>integer</td> <td>monitor TCP port</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM instance name</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
@@ -57,8 +58,8 @@ Update a Qemu.instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -79,11 +80,12 @@ Input
<tr><td>cpu_throttling</td> <td> </td> <td>['integer', 'null']</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>hda_disk_image</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hdb_disk_image</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdb disk image path</td> </tr>
<tr><td>hdc_disk_image</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdc disk image path</td> </tr>
<tr><td>hdd_disk_image</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hdd disk image path</td> </tr>
<tr><td>initrd</td> <td> </td> <td>['string', 'null']</td> <td>QEMU initrd path</td> </tr>
<tr><td>kernel_command_line</td> <td> </td> <td>['string', 'null']</td> <td>QEMU kernel command line</td> </tr>
<tr><td>kernel_image</td> <td> </td> <td>['string', 'null']</td> <td>QEMU kernel image path</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>monitor</td> <td> </td> <td>['integer', 'null']</td> <td>monitor TCP port</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>QEMU VM instance name</td> </tr>
<tr><td>options</td> <td> </td> <td>['string', 'null']</td> <td>Additional QEMU options</td> </tr>
<tr><td>process_priority</td> <td> </td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low, null</td> </tr>
@@ -103,11 +105,12 @@ Output
<tr><td>cpu_throttling</td> <td>&#10004;</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>hda_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hdb_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hdb disk image path</td> </tr>
<tr><td>hdc_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hdc disk image path</td> </tr>
<tr><td>hdd_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hdd disk image path</td> </tr>
<tr><td>initrd</td> <td>&#10004;</td> <td>string</td> <td>QEMU initrd path</td> </tr>
<tr><td>kernel_command_line</td> <td>&#10004;</td> <td>string</td> <td>QEMU kernel command line</td> </tr>
<tr><td>kernel_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU kernel image path</td> </tr>
<tr><td>legacy_networking</td> <td>&#10004;</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
<tr><td>monitor</td> <td>&#10004;</td> <td>integer</td> <td>monitor TCP port</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM instance name</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
@@ -130,8 +133,8 @@ Delete a Qemu.instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/qemu/projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+6 -6
View File
@@ -9,10 +9,10 @@ Add a NIO to a Qemu.instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port 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 Qemu.instance
Parameters
**********
- **project_id**: UUID for the project
- **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
- **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
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a Qemu.instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/qemu/projectsprojectidqemuvmsvmidresume.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Resume a Qemu.instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/qemu/projectsprojectidqemuvmsvmidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a Qemu.instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/qemu/projectsprojectidqemuvmsvmidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a Qemu.instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/qemu/projectsprojectidqemuvmsvmidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a Qemu.instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/server.rst
+8
View File
@@ -0,0 +1,8 @@
Server
---------------------
.. toctree::
:glob:
:maxdepth: 2
server/*
docs/api/v1/server/servershutdown.rst
+14
View File
@@ -0,0 +1,14 @@
/v1/server/shutdown
----------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v1/server/shutdown
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Shutdown the local server
Response status codes
**********************
- **201**: Server is shutting down
- **403**: Server shutdown refused
docs/api/v1/version/version.rst
+3
View File
@@ -17,6 +17,7 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Either this is a local server</td> </tr>
<tr><td>version</td> <td>&#10004;</td> <td>string</td> <td>Version number human readable</td> </tr>
</table>
@@ -42,6 +43,7 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Either this is a local server</td> </tr>
<tr><td>version</td> <td>&#10004;</td> <td>string</td> <td>Version number human readable</td> </tr>
</table>
@@ -51,6 +53,7 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>local</td> <td> </td> <td>boolean</td> <td>Either this is a local server</td> </tr>
<tr><td>version</td> <td>&#10004;</td> <td>string</td> <td>Version number human readable</td> </tr>
</table>
docs/api/v1/virtualbox/projectsprojectidvirtualboxvms.rst
+2
View File
@@ -30,6 +30,7 @@ Input
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
<tr><td>linked_clone</td> <td>&#10004;</td> <td>boolean</td> <td>either the VM is a linked clone or not</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
<tr><td>vm_id</td> <td> </td> <td></td> <td>VirtualBox VM instance identifier</td> </tr>
<tr><td>vmname</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
@@ -48,6 +49,7 @@ Output
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmid.rst
+6 -3
View File
@@ -9,8 +9,8 @@ Get a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -31,6 +31,7 @@ Output
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
@@ -49,8 +50,8 @@ Update a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -71,6 +72,7 @@ Input
<tr><td>enable_remote_console</td> <td> </td> <td>boolean</td> <td>enable the remote console</td> </tr>
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
</table>
@@ -88,6 +90,7 @@ Output
<tr><td>headless</td> <td> </td> <td>boolean</td> <td>headless mode</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>ram</td> <td> </td> <td>integer</td> <td>Amount of RAM</td> </tr>
<tr><td>use_any_adapter</td> <td> </td> <td>boolean</td> <td>allow GNS3 to use any VirtualBox adapter</td> </tr>
<tr><td>vm_id</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
<tr><td>vmname</td> <td> </td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
@@ -106,8 +109,8 @@ Delete a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+5 -5
View File
@@ -9,10 +9,10 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **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
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter (always)
- **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
+2 -2
View File
@@ -9,10 +9,10 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **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
+2 -2
View File
@@ -9,10 +9,10 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **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
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidresume.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Resume a suspended VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/virtualbox/projectsprojectidvirtualboxvmsvmidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/vpcs/projectsprojectidvpcsvmsvmid.rst
+3 -3
View File
@@ -9,8 +9,8 @@ Get a VPCS instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -45,8 +45,8 @@ Update a VPCS instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
@@ -93,8 +93,8 @@ Delete a VPCS instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.rst
+4 -4
View File
@@ -9,10 +9,10 @@ Add a NIO to a VPCS instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **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
- **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
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a VPCS instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a VPCS instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************
docs/api/v1/vpcs/projectsprojectidvpcsvmsvmidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a VPCS instance
Parameters
**********
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
Response status codes
**********************