NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-03 05:51:15 +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/virtualbox/projectsprojectidvirtualboxnodes.rst
+16 -15
View File
@@ -9,7 +9,7 @@ Create a new VirtualBox VM instance
Parameters
**********
- **project_id**: UUID for the project
- **project_id**: Project UUID
Response status codes
**********************
@@ -25,15 +25,15 @@ Input
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<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>linked_clone</td> <td>&#10004;</td> <td>boolean</td> <td>either the VM is a linked clone or not</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<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>linked_clone</td> <td>&#10004;</td> <td>boolean</td> <td>Whether 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>node_id</td> <td> </td> <td></td> <td>VirtualBox VM instance identifier</td> </tr>
<tr><td>node_id</td> <td> </td> <td></td> <td>Node 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>use_any_adapter</td> <td> </td> <td>boolean</td> <td>Allow GNS3 to use any VirtualBox adapter</td> </tr>
<tr><td>vmname</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM name (in VirtualBox itself)</td> </tr>
</table>
@@ -45,16 +45,17 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<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>adapters</td> <td> </td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<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>&#10004;</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>['string', 'null']</td> <td></td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</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_directory</td> <td>&#10004;</td> <td>['string', 'null']</td> <td></td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</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>
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeid.rst
+27 -25
View File
@@ -9,8 +9,8 @@ Get a VirtualBox 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,16 +26,17 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<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>adapters</td> <td> </td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<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>&#10004;</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>['string', 'null']</td> <td></td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</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_directory</td> <td>&#10004;</td> <td>['string', 'null']</td> <td></td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</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>
@@ -52,8 +53,8 @@ Update a VirtualBox 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
**********************
@@ -70,13 +71,13 @@ Input
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<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>adapters</td> <td> </td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<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>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,16 +89,17 @@ Output
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>acpi_shutdown</td> <td> </td> <td>boolean</td> <td>ACPI shutdown</td> </tr>
<tr><td>adapter_type</td> <td> </td> <td>string</td> <td>VirtualBox adapter type</td> </tr>
<tr><td>adapters</td> <td> </td> <td>integer</td> <td>number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>console TCP port</td> </tr>
<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>adapters</td> <td> </td> <td>integer</td> <td>Number of adapters</td> </tr>
<tr><td>console</td> <td> </td> <td>integer</td> <td>Console TCP port</td> </tr>
<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>&#10004;</td> <td>string</td> <td>VirtualBox VM instance name</td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>VirtualBox VM instance UUID</td> </tr>
<tr><td>node_directory</td> <td>&#10004;</td> <td>['string', 'null']</td> <td></td> </tr>
<tr><td>node_id</td> <td>&#10004;</td> <td>string</td> <td>Node UUID</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_directory</td> <td>&#10004;</td> <td>['string', 'null']</td> <td></td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</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>
@@ -114,8 +116,8 @@ Delete a VirtualBox 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/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+4 -4
View File
@@ -10,9 +10,9 @@ Add a NIO to a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **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 VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter from where the nio should be removed
- **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/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+2 -2
View File
@@ -10,9 +10,9 @@ Start a packet capture on a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **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/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+2 -2
View File
@@ -10,9 +10,9 @@ Stop a packet capture on a VirtualBox VM instance
Parameters
**********
- **adapter_number**: Adapter to stop a packet capture
- **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/virtualbox/projectsprojectidvirtualboxnodesnodeidreload.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Reload a VirtualBox 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/virtualbox/projectsprojectidvirtualboxnodesnodeidresume.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Resume a suspended VirtualBox 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/virtualbox/projectsprojectidvirtualboxnodesnodeidstart.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Start a VirtualBox 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/virtualbox/projectsprojectidvirtualboxnodesnodeidstop.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Stop a VirtualBox 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/virtualbox/projectsprojectidvirtualboxnodesnodeidsuspend.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Suspend a VirtualBox 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
**********************