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

Update docs

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-06-06 14:24:13 +02:00
1 parent 65bfb4b907
commit e80dd40121
264 files changed
+3544 -1582
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/qemu/projectsprojectidqemunodes.rst
+17 -16
View File
@@ -9,7 +9,7 @@ Create a new Qemu VM instance
Parameters
**********
- **project_id**: UUID for the project
- **project_id**: Project UUID
Response status codes
**********************
@@ -25,14 +25,14 @@ Input
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<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>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, 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>
<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, vnc</td> </tr>
<tr><td>cpu_throttling</td> <td> </td> <td>['integer', 'null']</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>cpus</td> <td> </td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
<tr><td>cpus</td> <td> </td> <td>['integer', 'null']</td> <td>Number of vCPUs</td> </tr>
<tr><td>hda_disk_image</td> <td> </td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hda_disk_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
<tr><td>hda_disk_interface</td> <td> </td> <td>string</td> <td>QEMU hda interface</td> </tr>
@@ -51,15 +51,15 @@ 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>linked_clone</td> <td> </td> <td>boolean</td> <td>Whether 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>node_id</td> <td> </td> <td></td> <td>QEMU VM identifier</td> </tr>
<tr><td>node_id</td> <td> </td> <td></td> <td>Node UUID</td> </tr>
<tr><td>options</td> <td> </td> <td>['string', 'null']</td> <td>Additional QEMU options</td> </tr>
<tr><td>platform</td> <td> </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, null</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> </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>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>
@@ -71,15 +71,15 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<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>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</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>
<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</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, vnc</td> </tr>
<tr><td>cpu_throttling</td> <td>&#10004;</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>cpus</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
<tr><td>cpus</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>Number of vCPUs</td> </tr>
<tr><td>hda_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hda_disk_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
<tr><td>hda_disk_interface</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda interface</td> </tr>
@@ -100,15 +100,16 @@ 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_id</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>string</td> <td></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>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
<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>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>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeid.rst
+31 -29
View File
@@ -9,8 +9,8 @@ Get a Qemu VM instance
Parameters
**********
- **node_id**: UUID for the instance
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -26,15 +26,15 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<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>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</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>
<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</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, vnc</td> </tr>
<tr><td>cpu_throttling</td> <td>&#10004;</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>cpus</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
<tr><td>cpus</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>Number of vCPUs</td> </tr>
<tr><td>hda_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hda_disk_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
<tr><td>hda_disk_interface</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda interface</td> </tr>
@@ -55,15 +55,16 @@ 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_id</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>string</td> <td></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>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
<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>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>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
@@ -79,8 +80,8 @@ Update a Qemu VM instance
Parameters
**********
- **node_id**: UUID for the instance
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -97,14 +98,14 @@ Input
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<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>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, 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>
<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, vnc</td> </tr>
<tr><td>cpu_throttling</td> <td> </td> <td>['integer', 'null']</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>cpus</td> <td> </td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
<tr><td>cpus</td> <td> </td> <td>['integer', 'null']</td> <td>Number of vCPUs</td> </tr>
<tr><td>hda_disk_image</td> <td> </td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hda_disk_image_md5sum</td> <td> </td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
<tr><td>hda_disk_interface</td> <td> </td> <td>string</td> <td>QEMU hda interface</td> </tr>
@@ -129,8 +130,8 @@ Input
<tr><td>platform</td> <td> </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, null</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> </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>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
@@ -141,15 +142,15 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<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>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</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>
<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</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, vnc</td> </tr>
<tr><td>cpu_throttling</td> <td>&#10004;</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>cpus</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
<tr><td>cpus</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>Number of vCPUs</td> </tr>
<tr><td>hda_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hda_disk_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
<tr><td>hda_disk_interface</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda interface</td> </tr>
@@ -170,15 +171,16 @@ 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_id</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>string</td> <td></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>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
<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>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>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
@@ -194,8 +196,8 @@ Delete a Qemu VM instance
Parameters
**********
- **node_id**: UUID for the instance
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+4 -4
View File
@@ -10,9 +10,9 @@ Add a NIO to a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **node_id**: UUID for the instance
- **project_id**: UUID for the project
- **project_id**: Project UUID
Response status codes
**********************
@@ -34,9 +34,9 @@ Remove a NIO from a Qemu VM instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **node_id**: Node UUID
- **port_number**: Port on the adapter (always 0)
- **node_id**: UUID for the instance
- **project_id**: UUID for the project
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidreload.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Reload a Qemu VM instance
Parameters
**********
- **node_id**: UUID for the instance
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidresume.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Resume a Qemu VM instance
Parameters
**********
- **node_id**: UUID for the instance
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstart.rst
+12 -11
View File
@@ -9,8 +9,8 @@ Start a Qemu VM instance
Parameters
**********
- **node_id**: UUID for the instance
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -26,15 +26,15 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<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>adapters</td> <td>&#10004;</td> <td>integer</td> <td>Number of adapters</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>
<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</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, vnc</td> </tr>
<tr><td>cpu_throttling</td> <td>&#10004;</td> <td>integer</td> <td>Percentage of CPU allowed for QEMU</td> </tr>
<tr><td>cpus</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>number of vCPUs</td> </tr>
<tr><td>cpus</td> <td>&#10004;</td> <td>['integer', 'null']</td> <td>Number of vCPUs</td> </tr>
<tr><td>hda_disk_image</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda disk image path</td> </tr>
<tr><td>hda_disk_image_md5sum</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>QEMU hda disk image checksum</td> </tr>
<tr><td>hda_disk_interface</td> <td>&#10004;</td> <td>string</td> <td>QEMU hda interface</td> </tr>
@@ -55,15 +55,16 @@ 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_id</td> <td>&#10004;</td> <td>string</td> <td>QEMU VM uuid</td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>string</td> <td></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>
<tr><td>process_priority</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: realtime, very high, high, normal, low, very low</td> </tr>
<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>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>status</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
<tr><td>usage</td> <td>&#10004;</td> <td>string</td> <td>How to use the QEMU VM</td> </tr>
</table>
Sample session
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidstop.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Stop a Qemu VM instance
Parameters
**********
- **vm_node**: UUID for the instance
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidsuspend.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Suspend a Qemu VM instance
Parameters
**********
- **node_id**: UUID for the instance
- **project_id**: UUID for the project
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/compute/qemu/qemubinaries.rst
+1 -1
View File
@@ -19,7 +19,7 @@ Input
<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>
<tr><td>archs</td> <td> </td> <td>array</td> <td>Architectures to filter binaries with</td> </tr>
</table>
Sample session
docs/api/v2/compute/qemu/qemunodes.rst → docs/api/v2/compute/qemu/qemuimages.rst
+3 -3
View File
@@ -1,13 +1,13 @@
/v2/compute/qemu/nodes
/v2/compute/qemu/images
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/qemu/nodes
GET /v2/compute/qemu/images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Retrieve the list of Qemu images
Response status codes
**********************
- **200**: List of Qemu images retrieved
- **200**: List of Qemu images
docs/api/v2/compute/qemu/qemunodespath.rst → docs/api/v2/compute/qemu/qemuimagesfilename.rst
+7 -3
View File
@@ -1,11 +1,15 @@
/v2/compute/qemu/nodes/{path:.+}
/v2/compute/qemu/images/{filename:.+}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/qemu/nodes/**{path:.+}**
POST /v2/compute/qemu/images/**{filename:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Upload Qemu image.
Upload Qemu image
Parameters
**********
- **filename**: Image filename
Response status codes
**********************
docs/api/v2/compute/qemu/qemuimg.rst
+1 -1
View File
@@ -25,7 +25,7 @@ Input
<tr><td>preallocation</td> <td> </td> <td>enum</td> <td>Possible values: off, metadata, falloc, full</td> </tr>
<tr><td>qemu_img</td> <td>&#10004;</td> <td>string</td> <td>Path to the qemu-img binary</td> </tr>
<tr><td>refcount_bits</td> <td> </td> <td>integer</td> <td></td> </tr>
<tr><td>size</td> <td>&#10004;</td> <td>integer</td> <td>Image size in M</td> </tr>
<tr><td>size</td> <td>&#10004;</td> <td>integer</td> <td>Image size in Megabytes</td> </tr>
<tr><td>static</td> <td> </td> <td>enum</td> <td>Possible values: on, off</td> </tr>
<tr><td>subformat</td> <td> </td> <td>enum</td> <td>Possible values: dynamic, fixed, streamOptimized, twoGbMaxExtentSparse, twoGbMaxExtentFlat, monolithicSparse, monolithicFlat</td> </tr>
<tr><td>zeroed_grain</td> <td> </td> <td>enum</td> <td>Possible values: on, off</td> </tr>