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

Update the documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2017-03-06 14:35:39 +01:00
1 parent 8b7035b185
commit 54131bc9bb
319 files changed
+921 -5755
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/qemu/projectsprojectidqemunodes.rst
+6 -8
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -26,6 +26,8 @@ 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>bios_image</td> <td> </td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU bios image checksum</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>
@@ -72,6 +74,8 @@ Output
<tr><td>acpi_shutdown</td> <td>&#10004;</td> <td>boolean</td> <td>ACPI shutdown support</td> </tr>
<tr><td>adapter_type</td> <td>&#10004;</td> <td>string</td> <td>QEMU adapter type</td> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>bios_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU bios image checksum</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>cdrom_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
@@ -100,7 +104,7 @@ Output
<tr><td>legacy_networking</td> <td>&#10004;</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
<tr><td>mac_address</td> <td>&#10004;</td> <td>string</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>node_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>string</td> <td>Path to the VM working directory</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
@@ -112,9 +116,3 @@ Output
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodes.txt
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst
+12 -24
View File
@@ -9,8 +9,8 @@ Get a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -27,6 +27,8 @@ Output
<tr><td>acpi_shutdown</td> <td>&#10004;</td> <td>boolean</td> <td>ACPI shutdown support</td> </tr>
<tr><td>adapter_type</td> <td>&#10004;</td> <td>string</td> <td>QEMU adapter type</td> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>bios_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU bios image checksum</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>cdrom_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
@@ -55,7 +57,7 @@ Output
<tr><td>legacy_networking</td> <td>&#10004;</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
<tr><td>mac_address</td> <td>&#10004;</td> <td>string</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>node_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>string</td> <td>Path to the VM working directory</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
@@ -67,12 +69,6 @@ Output
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectidqemunodesnodeid.txt
PUT /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -80,8 +76,8 @@ Update a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -99,6 +95,8 @@ 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>bios_image</td> <td> </td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU bios image checksum</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>
@@ -144,6 +142,8 @@ Output
<tr><td>acpi_shutdown</td> <td>&#10004;</td> <td>boolean</td> <td>ACPI shutdown support</td> </tr>
<tr><td>adapter_type</td> <td>&#10004;</td> <td>string</td> <td>QEMU adapter type</td> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>bios_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU bios image checksum</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>cdrom_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
@@ -172,7 +172,7 @@ Output
<tr><td>legacy_networking</td> <td>&#10004;</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
<tr><td>mac_address</td> <td>&#10004;</td> <td>string</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>node_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>string</td> <td>Path to the VM working directory</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
@@ -184,12 +184,6 @@ Output
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidqemunodesnodeid.txt
DELETE /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -197,18 +191,12 @@ Delete a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidqemunodesnodeid.txt
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+6 -18
View File
@@ -9,23 +9,17 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt
DELETE /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -33,20 +27,14 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.txt
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+3 -3
View File
@@ -9,9 +9,9 @@ Start a packet capture on a Qemu VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
@@ -27,6 +27,6 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>capture_file_name</td> <td>&#10004;</td> <td>string</td> <td>Capture file name</td> </tr>
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC</td> </tr>
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL</td> </tr>
</table>
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+3 -3
View File
@@ -9,14 +9,14 @@ Stop a packet capture on a Qemu VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidreload.rst
+2 -8
View File
@@ -9,18 +9,12 @@ Reload a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance reloaded
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance reloaded
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidreload.txt
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidresume.rst
+2 -8
View File
@@ -9,18 +9,12 @@ Resume a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance resumed
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance resumed
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidresume.txt
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstart.rst
+4 -8
View File
@@ -9,8 +9,8 @@ Start a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@@ -27,6 +27,8 @@ Output
<tr><td>acpi_shutdown</td> <td>&#10004;</td> <td>boolean</td> <td>ACPI shutdown support</td> </tr>
<tr><td>adapter_type</td> <td>&#10004;</td> <td>string</td> <td>QEMU adapter type</td> </tr>
<tr><td>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>bios_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU bios image path</td> </tr>
<tr><td>bios_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU bios image checksum</td> </tr>
<tr><td>boot_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: c, d, n, cn, cd</td> </tr>
<tr><td>cdrom_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU cdrom image path</td> </tr>
<tr><td>cdrom_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU cdrom image checksum</td> </tr>
@@ -55,7 +57,7 @@ Output
<tr><td>legacy_networking</td> <td>&#10004;</td> <td>boolean</td> <td>Use QEMU legagy networking commands (-net syntax)</td> </tr>
<tr><td>mac_address</td> <td>&#10004;</td> <td>string</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>node_directory</td> <td>&#10004;</td> <td>string</td> <td></td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>string</td> <td>Path to the VM working directory</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</td> </tr>
<tr><td>options</td> <td>&#10004;</td> <td>string</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: aarch64, alpha, arm, cris, i386, lm32, m68k, microblaze, microblazeel, mips, mips64, mips64el, mipsel, moxie, or32, ppc, ppc64, ppcemb, s390x, sh4, sh4eb, sparc, sparc64, tricore, unicore32, x86_64, xtensa, xtensaeb</td> </tr>
@@ -67,9 +69,3 @@ Output
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidstart.txt
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstop.rst
+2 -8
View File
@@ -9,18 +9,12 @@ Stop a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidstop.txt
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidsuspend.rst
+2 -8
View File
@@ -9,18 +9,12 @@ Suspend a Qemu VM instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidqemunodesnodeidsuspend.txt
docs/api/v2/compute/qemu/qemubinaries.rst
-6
View File
@@ -22,9 +22,3 @@ Input
<tr><td>archs</td> <td> </td> <td>array</td> <td>Architectures to filter binaries with</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_qemubinaries.txt
docs/api/v2/compute/qemu/qemucapabilities.rst
-6
View File
@@ -20,9 +20,3 @@ Output
<tr><td>kvm</td> <td> </td> <td>array</td> <td>Architectures that KVM is enabled for</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_qemucapabilities.txt
docs/api/v2/compute/qemu/qemuimg.rst
-6
View File
@@ -31,9 +31,3 @@ Input
<tr><td>zeroed_grain</td> <td> </td> <td>enum</td> <td>Possible values: on, off</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_qemuimg.txt